The IsotropicMedianFilter class implements the n-dimensional isotropic median filter.
More...
#include "ArrayToolbox/IsotropicMedianFilter.hh"
|
| IsotropicMedianFilter (double radiusUm=1.0) |
| Constructor. More...
|
|
virtual | ~IsotropicMedianFilter () |
| Destructor. More...
|
|
virtual void | apply (blitz::Array< DataT, Dim > const &data, blitz::TinyVector< double, Dim > const &elementSizeUm, blitz::Array< ResultT, 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...
|
|
double | filterRadiusUm () const |
| Get the filter radius in micrometers. 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 | setFilterRadiusUm (double radiusUm) |
| Set the filter radius in micrometers. More...
|
|
template<typename DataT, int Dim>
class atb::IsotropicMedianFilter< DataT, Dim >
The IsotropicMedianFilter class implements the n-dimensional isotropic median filter.
Definition at line 50 of file IsotropicMedianFilter.hh.
◆ ResultT
template<typename DataT , int Dim>
◆ IsotropicMedianFilter()
template<typename DataT , int Dim>
Constructor.
In contrast to other filters the median filter always uses crop boundary treatment. Therefore any changes in the setting of the boundary treatment are bogus and do not change the behaviour of the filter.
- Parameters
-
radiusUm | The filter radius in micrometers |
◆ ~IsotropicMedianFilter()
template<typename DataT , int Dim>
◆ filterRadiusUm()
template<typename DataT , int Dim>
Get the filter radius in micrometers.
- Returns
- The filter radius in micrometers.
◆ setFilterRadiusUm()
template<typename DataT , int Dim>
Set the filter radius in micrometers.
- Parameters
-
radiusUm | The filter radius in micrometers. |
◆ apply() [1/3]
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 |
result | 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/3]
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 |
extentsPx | The filter extents in pixels |
- 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() [3/3]
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: