iRoCS Toolbox
1.1.0
|
The FastNormalizedCorrelationFilter class provides normalized cross-correlation for n-D Arrays employing the Fast Fourier Transform. More...
#include <FastNormalizedCorrelationFilter.hh>
Public Member Functions | |
FastNormalizedCorrelationFilter (BoundaryTreatmentType bt=ValueBT, DataT const &boundaryValue=traits< DataT >::zero) | |
Default Constructor. More... | |
FastNormalizedCorrelationFilter (blitz::Array< DataT, Dim > const &kernel, BoundaryTreatmentType bt=ValueBT, DataT const &boundaryValue=traits< DataT >::zero) | |
Constructor also taking the correlation kernel. More... | |
~FastNormalizedCorrelationFilter () | |
Destructor. More... | |
void | apply (blitz::Array< DataT, Dim > const &data, blitz::TinyVector< double, Dim > const &elementSizeUm, blitz::Array< DataT, Dim > &result, iRoCS::ProgressReporter *pr=NULL) const |
Apply the filter to the given Array. More... | |
virtual void | apply (Array< DataT, Dim > const &data, Array< DataT, Dim > &result, iRoCS::ProgressReporter *pr=NULL) const |
Apply the filter to the given Array. More... | |
BoundaryTreatment< DataT, Dim > const & | boundaryTreatment () const |
Get a read-only reference to the boundary treatment object associated with this filter. More... | |
blitz::Array< DataT, Dim > const & | kernel () const |
Get the normalized correlation kernel. More... | |
void | setBoundaryTreatment (BoundaryTreatmentType bt, DataT const &boundaryValue=traits< DataT >::zero) |
Change the boundary treatment type to the type specified. More... | |
void | setBoundaryTreatment (BoundaryTreatment< DataT, Dim > const &bt) |
Change the boundary treatment type to the type specified. More... | |
void | setKernel (blitz::Array< DataT, Dim > const &kernel) |
Set the correlation kernel. More... | |
Static Public Member Functions | |
static void | apply (blitz::Array< DataT, Dim > const &data, blitz::TinyVector< double, Dim > const &elementSizeUm, blitz::Array< DataT, Dim > &result, blitz::Array< DataT, Dim > const &kernel, BoundaryTreatmentType btType=ValueBT, DataT const &boundaryValue=traits< DataT >::zero, iRoCS::ProgressReporter *pr=NULL) |
Correlate the data Array with the given kernel using the psecified boundary treatment. More... | |
static void | apply (Array< DataT, Dim > const &data, Array< DataT, Dim > &result, blitz::Array< DataT, Dim > const &kernel, BoundaryTreatmentType btType=ValueBT, DataT const &boundaryValue=traits< DataT >::zero, iRoCS::ProgressReporter *pr=NULL) |
Correlate the data Array with the given kernel using the psecified boundary treatment. More... | |
Protected Attributes | |
BoundaryTreatment< DataT, Dim > * | p_bt |
The boundary treatment object to use for out-of-Array access. More... | |
The FastNormalizedCorrelationFilter class provides normalized cross-correlation for n-D Arrays employing the Fast Fourier Transform.
Specifically it uses the BlitzFFTW library. For non-separable kernels this is the fastest possibility to compute the normalized cross-correlation of two data Arrays. It uses lots of memory, though, because it has to hold padded versions of the data Array, the kernel and the corresponding fourier transforms, therefore a memory overhead of factor 4 is the minimum, factor 6 to 8 is common.
Definition at line 63 of file FastNormalizedCorrelationFilter.hh.
atb::FastNormalizedCorrelationFilter< DataT, Dim >::FastNormalizedCorrelationFilter | ( | BoundaryTreatmentType | bt = ValueBT , |
DataT const & | boundaryValue = traits< DataT >::zero |
||
) |
Default Constructor.
bt | The boundary treatment this filter uses. |
boundaryValue | If bt is ValueBT, this value will be used for out-of-Array access |
atb::FastNormalizedCorrelationFilter< DataT, Dim >::FastNormalizedCorrelationFilter | ( | blitz::Array< DataT, Dim > const & | kernel, |
BoundaryTreatmentType | bt = ValueBT , |
||
DataT const & | boundaryValue = traits< DataT >::zero |
||
) |
Constructor also taking the correlation kernel.
kernel | The filter kernel. A normalized copy of the kernel will be stored, so when you change the kernel you have to set it again. |
bt | The boundary treatment this filter uses. |
boundaryValue | If bt is ValueBT, this value will be used for out-of-Array access |
atb::FastNormalizedCorrelationFilter< DataT, Dim >::~FastNormalizedCorrelationFilter | ( | ) |
Destructor.
void atb::FastNormalizedCorrelationFilter< DataT, Dim >::setKernel | ( | blitz::Array< DataT, Dim > const & | kernel | ) |
Set the correlation kernel.
kernel | The correlation kernel to apply |
blitz::Array<DataT,Dim> const& atb::FastNormalizedCorrelationFilter< DataT, Dim >::kernel | ( | ) | const |
Get the normalized correlation kernel.
|
virtual |
Apply the filter to the given Array.
data | The blitz++ Array to apply the filter to |
elementSizeUm | The element size of the Array |
result | The filtering result |
pr | If given progress will be reported to this ProgressReporter |
RuntimeError | If an error occurs during the filter operation an exception of this kind is thrown |
Implements atb::Filter< DataT, Dim, DataT >.
|
static |
Correlate the data Array with the given kernel using the psecified boundary treatment.
data | The blitz++ Array to apply the filter to |
elementSizeUm | The element size of the Array |
result | The filtering result |
kernel | The filter kernel |
btType | The boundary treatment to apply |
boundaryValue | The out-of-Array value that should be used if btType == ValueBT |
pr | If given progress will be reported to this ProgressReporter |
RuntimeError | If an error occurs during the filter operation an exception of this kind is thrown |
|
static |
Correlate the data Array with the given kernel using the psecified boundary treatment.
data | The Array to apply the filter to |
result | The filtering result |
kernel | The filter kernel |
btType | The boundary treatment to apply |
boundaryValue | The out-of-Array value that should be used if btType == ValueBT |
pr | If given progress will be reported to this ProgressReporter |
RuntimeError | If an error occurs during the filter operation an exception of this kind is thrown |
|
inherited |
Get a read-only reference to the boundary treatment object associated with this filter.
|
inherited |
Change the boundary treatment type to the type specified.
bt | The boundary treatment this filter uses |
boundaryValue | If bt is ValueBT, this value will be used for out-of-Array access |
|
inherited |
Change the boundary treatment type to the type specified.
bt | The boundary treatment this filter uses |
|
virtualinherited |
Apply the filter to the given Array.
data | The Array to apply the filter to |
result | The filtering result |
pr | If given progress will be reported to this ProgressReporter |
RuntimeError | If an error occurs during the filter operation an exception of this kind is thrown |
|
protectedinherited |
The boundary treatment object to use for out-of-Array access.
This is set during Filter object creation and can be changed by calling the setBoundaryTreatment() method. It gets destroyed, when the filter is deleted. If you delete the BoundaryTreatment object in a subclass, you must set this pointer to the NULL pointer.