The LaplacianFilter class implements the Filter interface and provides laplacian computation using forward-backward differences.
More...
#include "libArrayToolbox/LaplacianFilter.hh"
|
| LaplacianFilter (BoundaryTreatmentType bt=ValueBT, DataT const &boundaryValue=traits< DataT >::zero) |
| Default Constructor. More...
|
|
| LaplacianFilter (Accuracy accuracy, BoundaryTreatmentType bt=ValueBT, DataT const &boundaryValue=traits< DataT >::zero) |
| Constructor. More...
|
|
virtual | ~LaplacianFilter () |
| Destructor. More...
|
|
Accuracy | accuracy () const |
| Get the order of accuracy of this filter. More...
|
|
virtual void | apply (blitz::Array< DataT, Dim > const &data, blitz::TinyVector< double, Dim > const &elementSizeUm, blitz::Array< ResultT, Dim > &filtered, 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 | setAccuracy (Accuracy accuracy) |
| Set the order of accuracy of 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 void | apply (blitz::Array< DataT, Dim > const &data, blitz::TinyVector< double, Dim > const &elementSizeUm, blitz::Array< ResultT, Dim > &filtered, Accuracy accuracy, BoundaryTreatmentType btType=ValueBT, DataT const &boundaryValue=traits< DataT >::zero, iRoCS::ProgressReporter *pr=NULL) |
| Apply the filter to the given Array. More...
|
|
static void | apply (Array< DataT, Dim > const &data, Array< ResultT, Dim > &filtered, Accuracy accuracy, BoundaryTreatmentType btType=ValueBT, DataT const &boundaryValue=traits< DataT >::zero, iRoCS::ProgressReporter *pr=NULL) |
| Apply the filter to the given Array. More...
|
|
template<typename DataT, int Dim>
class atb::LaplacianFilter< DataT, Dim >
The LaplacianFilter class implements the Filter interface and provides laplacian computation using forward-backward differences.
Definition at line 51 of file LaplacianFilter.hh.
◆ ResultT
template<typename DataT , int Dim>
◆ Accuracy
template<typename DataT , int Dim>
◆ LaplacianFilter() [1/2]
template<typename DataT , int Dim>
Default Constructor.
Creates a Laplacian filter with second order accurate discrete gradient approimation using forward and backward differences.
- Parameters
-
bt | The boundary treatment this filter uses |
boundaryValue | If bt is ValueBT, this value will be used for out-of-Array access |
◆ LaplacianFilter() [2/2]
template<typename DataT , int Dim>
Constructor.
- Parameters
-
accuracy | The accuracy of the filter |
bt | The boundary treatment this filter uses |
boundaryValue | If bt is ValueBT, this value will be used for out-of-Array access |
◆ ~LaplacianFilter()
template<typename DataT , int Dim>
◆ accuracy()
template<typename DataT , int Dim>
Get the order of accuracy of this filter.
Currently only snd and 4th order are implemented.
- Returns
- The accuracy of the discrete derivative approximation
◆ setAccuracy()
template<typename DataT , int Dim>
Set the order of accuracy of this filter.
Currently only snd and 4th order are implemented.
- Parameters
-
accuracy | The new accuracy of the discrete derivative approximation |
◆ apply() [1/4]
template<typename DataT , int Dim>
Apply the filter to the given Array.
- Parameters
-
data | The blitz++ Array to apply the filter to |
elementSizeUm | The element size of the Array |
filtered | The filtering result |
- Exceptions
-
RuntimeError | If an error occurs during the filter operation an exception of this kind is thrown |
Implements atb::Filter< DataT, Dim, DataT >.
◆ apply() [2/4]
template<typename DataT , int Dim>
static void atb::LaplacianFilter< DataT, Dim >::apply |
( |
blitz::Array< DataT, Dim > const & |
data, |
|
|
blitz::TinyVector< double, Dim > const & |
elementSizeUm, |
|
|
blitz::Array< ResultT, Dim > & |
filtered, |
|
|
Accuracy |
accuracy, |
|
|
BoundaryTreatmentType |
btType = ValueBT , |
|
|
DataT const & |
boundaryValue = traits< DataT >::zero , |
|
|
iRoCS::ProgressReporter * |
pr = NULL |
|
) |
| |
|
static |
Apply the filter to the given Array.
- Parameters
-
data | The blitz++ Array to apply the filter to |
elementSizeUm | The element size of the Array |
filtered | The filtering result |
accuracy | The filter accuracy order |
btType | The boundary treatment to apply |
boundaryValue | The out-of-Array value that should be used if btType == ValueBT |
- Exceptions
-
RuntimeError | If an error occurs during the filter operation an exception of this kind is thrown |
◆ apply() [3/4]
template<typename DataT , int Dim>
Apply the filter to the given Array.
- Parameters
-
data | The blitz++ Array to apply the filter to |
filtered | The filtering result |
accuracy | The filter accuracy order |
btType | The boundary treatment to apply |
boundaryValue | If btType is Value, this value is assumed outside the Arrays |
btType | The boundary treatment to apply |
boundaryValue | The out-of-Array value that should be used if btType == ValueBT |
- Exceptions
-
RuntimeError | If an error occurs during the filter operation an exception of this kind is thrown |
◆ boundaryTreatment()
Get a read-only reference to the boundary treatment object associated with this filter.
- Returns
- A reference to the associated BoundaryTreatment object
◆ setBoundaryTreatment() [1/2]
Change the boundary treatment type to the type specified.
- Parameters
-
bt | The boundary treatment this filter uses |
boundaryValue | If bt is ValueBT, this value will be used for out-of-Array access |
◆ setBoundaryTreatment() [2/2]
Change the boundary treatment type to the type specified.
- Parameters
-
bt | The boundary treatment this filter uses |
◆ apply() [4/4]
Apply the filter to the given Array.
- Parameters
-
data | The Array to apply the filter to |
result | The filtering result |
pr | If given progress will be reported to this ProgressReporter |
- Exceptions
-
RuntimeError | If an error occurs during the filter operation an exception of this kind is thrown |
◆ p_bt
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.
Definition at line 159 of file Filter.hh.
The documentation for this class was generated from the following file: