The Interpolator class is the base class of all classes implementing interpolation strategies for sub-pixel Array access.
More...
#include "libArrayToolbox/Interpolator.hh"
|
| Interpolator (BoundaryTreatmentType bt=ValueBT, DataT const &boundaryValue=traits< DataT >::zero) |
| Constructor. More...
|
|
| Interpolator (Interpolator< DataT, Dim > const &ip) |
| Copy Constructor. More...
|
|
virtual | ~Interpolator () |
| Destructor. More...
|
|
BoundaryTreatment< DataT, Dim > const & | boundaryTreatment () const |
| Get a read-only reference to the Interpolator's boundary treatment object. More...
|
|
BoundaryTreatment< DataT, Dim > & | boundaryTreatment () |
| Get a random-access reference to the Interpolator's boundary treatment object. More...
|
|
virtual Interpolator< DataT, Dim > * | clone () const =0 |
| Get a deep copy of this Interpolator object. More...
|
|
virtual DataT | get (blitz::Array< DataT, Dim > const &data, blitz::TinyVector< double, Dim > const &pos) const =0 |
| Get the Array value at the given sub-pixel position. More...
|
|
Interpolator< DataT, Dim > & | operator= (Interpolator< DataT, Dim > const &ip) |
| Copy assignment operator. More...
|
|
void | setBoundaryTreatment (BoundaryTreatmentType bt, DataT const &boundaryValue=traits< DataT >::zero) |
| Set the Interpolator's boundary treatment type. More...
|
|
virtual InterpolationType | type () const =0 |
| Get the corresponding enumeration value for the interpolation type. More...
|
|
template<typename DataT, int Dim>
class atb::Interpolator< DataT, Dim >
The Interpolator class is the base class of all classes implementing interpolation strategies for sub-pixel Array access.
- See also
- BoundaryTreatment, ValueBoundaryTreatment, CyclicBoundaryTreatment, RepeatBoundaryTreatment, MirrorBoundaryTreatment, CropBoundaryTreatment
Definition at line 92 of file Interpolator.hh.
◆ Interpolator() [1/2]
template<typename DataT, int Dim>
Constructor.
- Parameters
-
bt | The boundary treatment to apply when out-of-Array positions are requested. |
boundaryValue | The default out-of-Array value (for ValueBT) |
◆ Interpolator() [2/2]
template<typename DataT, int Dim>
Copy Constructor.
- Parameters
-
◆ ~Interpolator()
template<typename DataT, int Dim>
◆ operator=()
template<typename DataT, int Dim>
Copy assignment operator.
- Parameters
-
- Returns
- A reference to this Interpolator object for operator chaining
◆ clone()
template<typename DataT, int Dim>
Get a deep copy of this Interpolator object.
return A deep copy of this Interpolator object
Implemented in atb::MedianInterpolator< DataT, Dim >, atb::MaximumInterpolator< DataT, Dim >, atb::MinimumInterpolator< DataT, Dim >, atb::CubicInterpolator< DataT, Dim >, atb::LinearInterpolator< DataT, Dim >, and atb::NearestInterpolator< DataT, Dim >.
Referenced by atb::Array< unsigned char, 3 >::setInterpolator().
◆ type()
template<typename DataT, int Dim>
Get the corresponding enumeration value for the interpolation type.
- Returns
- The enumeration value corresponding to the interpolation type
Implemented in atb::MedianInterpolator< DataT, Dim >, atb::MaximumInterpolator< DataT, Dim >, atb::MinimumInterpolator< DataT, Dim >, atb::CubicInterpolator< DataT, Dim >, atb::LinearInterpolator< DataT, Dim >, and atb::NearestInterpolator< DataT, Dim >.
◆ boundaryTreatment() [1/2]
template<typename DataT, int Dim>
◆ boundaryTreatment() [2/2]
template<typename DataT, int Dim>
◆ setBoundaryTreatment()
template<typename DataT, int Dim>
Set the Interpolator's boundary treatment type.
- Parameters
-
bt | The new boundary treatment type |
boundaryValue | The default out-of-Array value (for ValueBT) |
◆ get()
template<typename DataT, int Dim>
virtual DataT atb::Interpolator< DataT, Dim >::get |
( |
blitz::Array< DataT, Dim > const & |
data, |
|
|
blitz::TinyVector< double, Dim > const & |
pos |
|
) |
| const |
|
pure virtual |
Get the Array value at the given sub-pixel position.
For out-of-Array coordinates the corresponding boundary treatment will be applied
- Parameters
-
data | The Array to read a value from |
pos | The position to read |
- Returns
- The Array value at the specified sub-pixel position
Implemented in atb::MedianInterpolator< DataT, Dim >, atb::MaximumInterpolator< DataT, Dim >, atb::MinimumInterpolator< DataT, Dim >, atb::CubicInterpolator< DataT, Dim >, atb::LinearInterpolator< DataT, Dim >, and atb::NearestInterpolator< DataT, Dim >.
◆ p_bt
template<typename DataT, int Dim>
The documentation for this class was generated from the following file: