iRoCS Toolbox
1.1.0
|
The MirrorBoundaryTreatment class implements mirroring border treatment when accessing Arrays. More...
#include "libArrayToolbox/BoundaryTreatment.hh"
Public Member Functions | |
MirrorBoundaryTreatment () | |
Constructor. More... | |
MirrorBoundaryTreatment (MirrorBoundaryTreatment< DataT, Dim > const &bt) | |
Copy Constructor. More... | |
~MirrorBoundaryTreatment () | |
Destructor. More... | |
BoundaryTreatment< DataT, Dim > * | clone () const |
Get a deep copy of this BoundaryTreatment object. More... | |
DataT | get (blitz::Array< DataT, Dim > const &data, blitz::TinyVector< ptrdiff_t, Dim > pos) const |
Get the Array value at the given position. More... | |
DataT | get (DataT const *data, ptrdiff_t pos, ptrdiff_t length) const |
Get the C-array value at the given position. More... | |
blitz::TinyVector< ptrdiff_t, Dim > | getIndex (blitz::TinyVector< ptrdiff_t, Dim > pos, blitz::TinyVector< ptrdiff_t, Dim > const &shape) const |
Get the in-Array-Index to the given position. More... | |
ptrdiff_t | getIndex (ptrdiff_t pos, ptrdiff_t length) const |
Get the in-array-index to the given position. More... | |
MirrorBoundaryTreatment< DataT, Dim > & | operator= (MirrorBoundaryTreatment< DataT, Dim > const &bt) |
Copy assignment operator. More... | |
bool | providesIndices () const |
The returned boolean indicates, whether the boundary treatment is able to transform the incoming coordinates into valid Array coordinates and therefore it indicates, whether the function getIndex() returns valid in-Array-positions. More... | |
BoundaryTreatmentType | type () const |
Get the corresponding enumeration value for the boundary treatment type. More... | |
The MirrorBoundaryTreatment class implements mirroring border treatment when accessing Arrays.
Definition at line 710 of file BoundaryTreatment.hh.
atb::MirrorBoundaryTreatment< DataT, Dim >::MirrorBoundaryTreatment | ( | ) |
Constructor.
atb::MirrorBoundaryTreatment< DataT, Dim >::MirrorBoundaryTreatment | ( | MirrorBoundaryTreatment< DataT, Dim > const & | bt | ) |
Copy Constructor.
bt | The BoundaryTreatment object to copy |
atb::MirrorBoundaryTreatment< DataT, Dim >::~MirrorBoundaryTreatment | ( | ) |
Destructor.
MirrorBoundaryTreatment<DataT,Dim>& atb::MirrorBoundaryTreatment< DataT, Dim >::operator= | ( | MirrorBoundaryTreatment< DataT, Dim > const & | bt | ) |
Copy assignment operator.
bt | The BoundaryTreatment object to copy |
|
virtual |
Get a deep copy of this BoundaryTreatment object.
Implements atb::BoundaryTreatment< DataT, Dim >.
|
virtual |
Get the corresponding enumeration value for the boundary treatment type.
MirrorBT
Implements atb::BoundaryTreatment< DataT, Dim >.
|
virtual |
The returned boolean indicates, whether the boundary treatment is able to transform the incoming coordinates into valid Array coordinates and therefore it indicates, whether the function getIndex() returns valid in-Array-positions.
true
Implements atb::BoundaryTreatment< DataT, Dim >.
|
virtual |
Get the Array value at the given position.
Out-of-bounds positions will be mirrored at the Array boundaries to obtain in-Array coordinates.
data | The Array to read a value from |
pos | The position to read |
Implements atb::BoundaryTreatment< DataT, Dim >.
|
virtual |
Get the in-Array-Index to the given position.
Out-of-bounds positions will be mirrored at the Array boundaries to obtain in-Array coordinates.
pos | The position to transform to in-Array-coordinates |
shape | The Array shape |
Implements atb::BoundaryTreatment< DataT, Dim >.
|
virtual |
Get the C-array value at the given position.
For out-of-array positions the corresponding treatment will be applied
data | The C-array to read a value from |
pos | The position to read |
length | The array length |
Implements atb::BoundaryTreatment< DataT, Dim >.
|
virtual |
Get the in-array-index to the given position.
This function throws a RuntimeError if the BoundaryTreatment cannot return valid out-of-array indices. This can be checked using the providesIndices flag
pos | The position to transform to in-Array-coordinates |
length | The array length |
RuntimeError | This exception is thrown if the BoundaryTreatment cannot generate in-Array positions from given out-of-Array positions, and an out-of-Array position is passed. |
Implements atb::BoundaryTreatment< DataT, Dim >.