iRoCS Toolbox
1.1.0
|
The FastPhaseOnlyCorrelationFilter class provides phase-only cross-correlation for n-D Arrays employing the Fast Fourier Transform. More...
#include <FastPhaseOnlyCorrelationFilter.hh>
Public Member Functions | |
FastPhaseOnlyCorrelationFilter (blitz::Array< DataT, Dim > const &kernel, BoundaryTreatmentType bt=ValueBT, DataT const &boundaryValue=traits< DataT >::zero) | |
Constructor. More... | |
~FastPhaseOnlyCorrelationFilter () | |
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... | |
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... | |
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 FastPhaseOnlyCorrelationFilter class provides phase-only cross-correlation for n-D Arrays employing the Fast Fourier Transform.
Specifically it uses the BlitzFFTW library. This is the fastest possibility to compute the phase-only 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 61 of file FastPhaseOnlyCorrelationFilter.hh.
atb::FastPhaseOnlyCorrelationFilter< DataT, Dim >::FastPhaseOnlyCorrelationFilter | ( | blitz::Array< DataT, Dim > const & | kernel, |
BoundaryTreatmentType | bt = ValueBT , |
||
DataT const & | boundaryValue = traits< DataT >::zero |
||
) |
Constructor.
kernel | The filter kernel. An immutable refererence of the kernel will be stored, and will be transformed to Fourier domain on demand. Once transformed changes to the kernel Array will not be respected. Then you have to create a new FastPhaseOnlyCorrelationFilter. |
bt | The boundary treatment this filter uses. CropBT is not allowed for the FastPhaseOnlyCorrelationFilter and will result in a RuntimeError when the filter is applied! |
boundaryValue | If bt is ValueBT, this value will be used for out-of-Array access |
atb::FastPhaseOnlyCorrelationFilter< DataT, Dim >::~FastPhaseOnlyCorrelationFilter | ( | ) |
Destructor.
|
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.