BALL
1.4.2
|
#include <BALL/DATATYPE/regularData3D.h>
Classes | |
struct | BlockValueType |
The block data type for reading and writing binary data. More... | |
class | IndexType |
The index type used to refer to a specific element in the grid (x-, y-, and z-index) More... | |
Public Types | |
typedef ValueType | value_type |
typedef std::vector< ValueType > ::iterator | iterator |
typedef std::vector< ValueType > ::const_iterator | const_iterator |
typedef std::vector< ValueType > ::reference | reference |
typedef std::vector< ValueType > ::const_reference | const_reference |
typedef std::vector< ValueType > ::pointer | pointer |
typedef std::vector< ValueType > ::difference_type | difference_type |
typedef std::vector< ValueType > ::size_type | size_type |
Type Definitions | |
typedef std::vector< ValueType > | VectorType |
The type containing an STL vector of the appropriate type. More... | |
typedef TVector3< float > | CoordinateType |
The coordinate type. More... | |
typedef std::vector< ValueType > ::iterator | Iterator |
A mutable iterator. More... | |
typedef std::vector< ValueType > ::const_iterator | ConstIterator |
A nonmutable iterator. More... | |
Public Member Functions | |
BALL_INLINE bool | isOrthogonal () const |
State whether grid is orthogonal or not. More... | |
Constructors and Destructors | |
TRegularData3D () | |
TRegularData3D (const TRegularData3D< ValueType > &grid) | |
TRegularData3D (const CoordinateType &origin, const CoordinateType &dimension, const CoordinateType &spacing) | |
TRegularData3D (const CoordinateType &origin, const CoordinateType &x_axis, const CoordinateType &y_axis, const CoordinateType &z_axis, const IndexType &size) | |
TRegularData3D (const IndexType &size, const CoordinateType &origin=CoordinateType(0.0), const CoordinateType &dimension=CoordinateType(1.0)) | |
virtual | ~TRegularData3D () |
virtual void | clear () |
Assignment | |
TRegularData3D & | operator= (const TRegularData3D< ValueType > &data) |
Predicates | |
bool | operator== (const TRegularData3D< ValueType > &grid) const |
BALL_INLINE bool | operator!= (const TRegularData3D< ValueType > &grid) const |
BALL_INLINE bool | empty () const |
Empty predicate. More... | |
bool | isInside (const CoordinateType &r) const |
Test if a given point is inside the grid. More... | |
Iterators | |
BALL_INLINE ConstIterator | begin () const |
BALL_INLINE ConstIterator | end () const |
BALL_INLINE Iterator | begin () |
BALL_INLINE Iterator | end () |
Accessors | |
BALL_INLINE size_type | size () const |
BALL_INLINE size_type | max_size () const |
BALL_INLINE void | swap (TRegularData3D< ValueType > &grid) |
const vector< ValueType > & | getData () const |
Get the full data. More... | |
const ValueType & | getData (const IndexType &index) const |
ValueType & | getData (const IndexType &index) |
const ValueType & | getData (Position index) const |
ValueType & | getData (Position index) |
const ValueType & | operator[] (const IndexType &index) const |
ValueType & | operator[] (const IndexType &index) |
const ValueType & | operator[] (Position index) const |
ValueType & | operator[] (Position index) |
ValueType | operator() (const CoordinateType &x) const |
ValueType | getInterpolatedValue (const CoordinateType &x) const |
const ValueType & | getClosestValue (const CoordinateType &x) const |
ValueType & | getClosestValue (const CoordinateType &x) |
IndexType | getClosestIndex (const CoordinateType &v) const |
IndexType | getLowerIndex (const CoordinateType &v) const |
const IndexType & | getSize () const |
const CoordinateType & | getOrigin () const |
const CoordinateType & | getSpacing () const |
void | setOrigin (const CoordinateType &origin) |
const CoordinateType & | getDimension () const |
void | setDimension (const CoordinateType &dimension) |
void | resize (const IndexType &size) |
void | rescale (const IndexType &new_size) |
CoordinateType | getCoordinates (const IndexType &index) const |
CoordinateType | getCoordinates (Position index) const |
void | getEnclosingIndices (const CoordinateType &r, Position &llf, Position &rlf, Position &luf, Position &ruf, Position &llb, Position &rlb, Position &lub, Position &rub) const |
void | getEnclosingValues (const CoordinateType &r, ValueType &llf, ValueType &rlf, ValueType &luf, ValueType &ruf, ValueType &llb, ValueType &rlb, ValueType &lub, ValueType &rub) const |
ValueType | calculateMean () const |
ValueType | calculateSD () const |
void | binaryWrite (const String &filename) const |
void | binaryWriteRaw (const String &filename) const |
void | binaryRead (const String &filename) |
Protected Member Functions | |
const CoordinateType | mapToCartesian_ (CoordinateType r) const |
map indices to Cartesian coordinates More... | |
const CoordinateType | mapInverse_ (CoordinateType r) const |
map Cartesian coordinates to indices (note: this does not yet convert the double values to Index) More... | |
Protected Attributes | |
VectorType | data_ |
The grid data. More... | |
CoordinateType | origin_ |
Origin of the grid (offset) More... | |
CoordinateType | dimension_ |
Dimension of the grid. More... | |
CoordinateType | spacing_ |
Grid spacing. More... | |
IndexType | size_ |
The dimensions in grid points. More... | |
bool | is_orthogonal_ |
A flag deciding whether the grid is orthogonal or not. More... | |
std::vector< double > | mapping_ |
mapping matrix and its inverse More... | |
std::vector< double > | inverse_mapping_ |
Three-dimensional grid class. This class represents a three-dimensional array. An instance of ValueType will be created for each point of the grid upon instantiation of TRegularData3D and initialized with its default value
Container
and Unary Function
requirements. Iteration is along the x-axis first, then along the y-axis. Definition at line 45 of file regularData3D.h.
typedef std::vector<ValueType>::const_iterator BALL::TRegularData3D< ValueType >::const_iterator |
Definition at line 85 of file regularData3D.h.
typedef std::vector<ValueType>::const_reference BALL::TRegularData3D< ValueType >::const_reference |
Definition at line 87 of file regularData3D.h.
typedef std::vector<ValueType>::const_iterator BALL::TRegularData3D< ValueType >::ConstIterator |
A nonmutable iterator.
Definition at line 78 of file regularData3D.h.
typedef TVector3<float> BALL::TRegularData3D< ValueType >::CoordinateType |
The coordinate type.
Definition at line 74 of file regularData3D.h.
typedef std::vector<ValueType>::difference_type BALL::TRegularData3D< ValueType >::difference_type |
Definition at line 89 of file regularData3D.h.
typedef std::vector<ValueType>::iterator BALL::TRegularData3D< ValueType >::Iterator |
A mutable iterator.
Definition at line 76 of file regularData3D.h.
typedef std::vector<ValueType>::iterator BALL::TRegularData3D< ValueType >::iterator |
Definition at line 84 of file regularData3D.h.
typedef std::vector<ValueType>::pointer BALL::TRegularData3D< ValueType >::pointer |
Definition at line 88 of file regularData3D.h.
typedef std::vector<ValueType>::reference BALL::TRegularData3D< ValueType >::reference |
Definition at line 86 of file regularData3D.h.
typedef std::vector<ValueType>::size_type BALL::TRegularData3D< ValueType >::size_type |
Definition at line 90 of file regularData3D.h.
typedef ValueType BALL::TRegularData3D< ValueType >::value_type |
Definition at line 83 of file regularData3D.h.
typedef std::vector<ValueType> BALL::TRegularData3D< ValueType >::VectorType |
The type containing an STL vector of the appropriate type.
Definition at line 72 of file regularData3D.h.
BALL::TRegularData3D< ValueType >::TRegularData3D | ( | ) |
Default constructor. Creates a TRegularData3D object without allocating a grid.
Definition at line 519 of file regularData3D.h.
BALL::TRegularData3D< ValueType >::TRegularData3D | ( | const TRegularData3D< ValueType > & | grid | ) |
Copy constructor.
Exception::OutOfMemory | if the memory for the copy could not be allocated |
Definition at line 532 of file regularData3D.h.
BALL::TRegularData3D< ValueType >::TRegularData3D | ( | const CoordinateType & | origin, |
const CoordinateType & | dimension, | ||
const CoordinateType & | spacing | ||
) |
Constructor for an orthogonal TRegularData3D.
Exception::OutOfMemory | if the memory for the grid could not be allocated |
BALL::TRegularData3D< ValueType >::TRegularData3D | ( | const CoordinateType & | origin, |
const CoordinateType & | x_axis, | ||
const CoordinateType & | y_axis, | ||
const CoordinateType & | z_axis, | ||
const IndexType & | size | ||
) |
Constructor for a non-orthogonal TRegularData3D.
Exception::OutOfMemory | if the memory for the grid could not be allocated |
BALL::TRegularData3D< ValueType >::TRegularData3D | ( | const IndexType & | size, |
const CoordinateType & | origin = CoordinateType(0.0) , |
||
const CoordinateType & | dimension = CoordinateType(1.0) |
||
) |
Constructor for a standard orthogonal TRegularData3D.
Exception::OutOfMemory | if the memory for the grid could not be allocated |
|
virtual |
Destructor.
Definition at line 681 of file regularData3D.h.
|
inline |
Definition at line 176 of file regularData3D.h.
|
inline |
Definition at line 180 of file regularData3D.h.
void BALL::TRegularData3D< ValueType >::binaryRead | ( | const String & | filename | ) |
Read the grid contents from a file written with binaryWrite
Exception::FileNotFound | thrown if file does not exist or could not be read |
Definition at line 1342 of file regularData3D.h.
void BALL::TRegularData3D< ValueType >::binaryWrite | ( | const String & | filename | ) | const |
Write the grid contents in a (non-portable) binary format.
Exception::FileNotFound | thrown if the file could not be written |
Definition at line 1290 of file regularData3D.h.
void BALL::TRegularData3D< ValueType >::binaryWriteRaw | ( | const String & | filename | ) | const |
Writes out raw binary plus text header file. !!!WARNING!!! This method is defined only for float template parameters. If you try it to call it from any other specialization, it will give out compile error that the function has no body.
Exception::FileNotFound | thrown if the file could not be written |
BALL_INLINE ValueType BALL::TRegularData3D< ValueType >::calculateMean | ( | ) | const |
BALL_INLINE ValueType BALL::TRegularData3D< ValueType >::calculateSD | ( | ) | const |
Calculate the standard deviation of the dataset
Definition at line 1248 of file regularData3D.h.
|
virtual |
Clear method. Delete the grid contents and resize it to zero.
Reimplemented in BALL::TFFT3D< ComplexTraits >.
Definition at line 1263 of file regularData3D.h.
|
inline |
Empty predicate.
Definition at line 163 of file regularData3D.h.
|
inline |
Definition at line 178 of file regularData3D.h.
|
inline |
Definition at line 182 of file regularData3D.h.
BALL_INLINE TRegularData3D< ValueType >::IndexType BALL::TRegularData3D< ValueType >::getClosestIndex | ( | const CoordinateType & | v | ) | const |
Return the position of the grid point closest to the given vector. If there are multiple grid points with equal distance, the grid point with the lowest indices in x, y direction is returned.
Exception::OutOfGrid | if the point is outside the grid |
Definition at line 1119 of file regularData3D.h.
const ValueType& BALL::TRegularData3D< ValueType >::getClosestValue | ( | const CoordinateType & | x | ) | const |
Return a nonmutable reference to the closest non-interpolated value. This method first performs a range check for the argument x
and then returns the value of the closest data point to the left or right of x
.
Exception::OutOfGrid | if x is outside the grid boundaries |
ValueType& BALL::TRegularData3D< ValueType >::getClosestValue | ( | const CoordinateType & | x | ) |
Return a mutable reference to the closest non-interpolated value. This method first performs a range check for the argument x
and then returns the value of the closest data point to the left or right of x
.
Exception::OutOfGrid | if x is outside the grid boundaries |
CoordinateType BALL::TRegularData3D< ValueType >::getCoordinates | ( | const IndexType & | index | ) | const |
Returns the exact coordinates of a grid point.
Exception::OutOfGrid | if the point is outside the grid boundaries |
BALL_INLINE TRegularData3D< ValueType >::CoordinateType BALL::TRegularData3D< ValueType >::getCoordinates | ( | Position | index | ) | const |
Returns the exact coordinates of a grid point.
Exception::OutOfGrid | if the point is outside the grid boundaries |
Definition at line 946 of file regularData3D.h.
BALL_INLINE const vector< ValueType > & BALL::TRegularData3D< ValueType >::getData | ( | ) | const |
Get the full data.
Definition at line 877 of file regularData3D.h.
const ValueType& BALL::TRegularData3D< ValueType >::getData | ( | const IndexType & | index | ) | const |
Return a nonmutable reference to a specific data element. This is the range checking version of operator []
.
Exception::OutOfGrid | if index is outside the grid boundaries |
ValueType& BALL::TRegularData3D< ValueType >::getData | ( | const IndexType & | index | ) |
Return a mutable reference to a specific data element. This is the range checking version of operator []
.
Exception::OutOfGrid | if index is outside the grid boundaries |
BALL_INLINE const ValueType & BALL::TRegularData3D< ValueType >::getData | ( | Position | index | ) | const |
Return a nonmutable reference to a specific data element. This is the range checking version of operator []
.
Exception::OutOfGrid | if index is outside the grid boundaries |
Definition at line 897 of file regularData3D.h.
BALL_INLINE ValueType & BALL::TRegularData3D< ValueType >::getData | ( | Position | index | ) |
Return a mutable reference to a specific data element. This is the range checking version of operator []
.
Exception::OutOfGrid | if index is outside the grid boundaries |
Definition at line 908 of file regularData3D.h.
|
inline |
Return the dimension of the data. The dimension represents the length of the data vector. Hence, the coordinate of the rightmost element, data_[getSize() - 1]
is the origin plus the dimension (getOrigin() + getDimension()
).
Definition at line 328 of file regularData3D.h.
BALL_INLINE void BALL::TRegularData3D< ValueType >::getEnclosingIndices | ( | const CoordinateType & | r, |
Position & | llf, | ||
Position & | rlf, | ||
Position & | luf, | ||
Position & | ruf, | ||
Position & | llb, | ||
Position & | rlb, | ||
Position & | lub, | ||
Position & | rub | ||
) | const |
Return the indices of the grid points of the enclosing box. This method calculates the grid box that contains the given vector and returns the indices of the grid points forming this box. The given point lies either in the box or is the lower left front edge of the box.
vector | a point inside the grid |
llf | left lower front corner of the box |
rlf | right lower front corner of the box |
luf | left upper front corner of the box |
ruf | right upper front corner of the box |
llb | left lower back corner of the box |
rlb | right lower back corner of the box |
lub | left upper back corner of the box |
rub | right upper back corner of the box |
Exception::OutOfGrid | if the point is outside the grid boundaries |
Definition at line 975 of file regularData3D.h.
BALL_INLINE void BALL::TRegularData3D< ValueType >::getEnclosingValues | ( | const CoordinateType & | r, |
ValueType & | llf, | ||
ValueType & | rlf, | ||
ValueType & | luf, | ||
ValueType & | ruf, | ||
ValueType & | llb, | ||
ValueType & | rlb, | ||
ValueType & | lub, | ||
ValueType & | rub | ||
) | const |
Return the data at the grid points of the enclosing box.
Exception::OutOfGrid | if the point is outside the grid boundaries |
Definition at line 1017 of file regularData3D.h.
BALL_INLINE ValueType BALL::TRegularData3D< ValueType >::getInterpolatedValue | ( | const CoordinateType & | x | ) | const |
Return the linearly interpolated value of the surrounding two grid points. This method first performs a range check for the argument x
and then calls operator () (x)
to determine an interpolated value at that position.
Exception::OutOfGrid | if x is outside the grid boundaries |
Definition at line 1044 of file regularData3D.h.
BALL_INLINE TRegularData3D< ValueType >::IndexType BALL::TRegularData3D< ValueType >::getLowerIndex | ( | const CoordinateType & | v | ) | const |
Return the position of the next grid point with coordinates smaller than the given vector. This yields the front lower left corner of the cube enclosing the specified position.
Exception::OutOfGrid | if the point is outside the grid |
Definition at line 1148 of file regularData3D.h.
|
inline |
Return the origin of the data. The origin represents the coordinate of the very first (lower left) element, i.e. data_[0]
.
Definition at line 312 of file regularData3D.h.
|
inline |
Return the size of the grid. This method yields the number of grid points in x- and y-direction. Use size to obtain the total number of points in the grid.
Definition at line 306 of file regularData3D.h.
|
inline |
Return the spacing of the data. The spacing corresponds to the distance between two adjacent data elements.
Definition at line 318 of file regularData3D.h.
BALL_INLINE bool BALL::TRegularData3D< ValueType >::isInside | ( | const CoordinateType & | r | ) | const |
Test if a given point is inside the grid.
Definition at line 840 of file regularData3D.h.
|
inline |
State whether grid is orthogonal or not.
Definition at line 170 of file regularData3D.h.
|
inlineprotected |
map Cartesian coordinates to indices (note: this does not yet convert the double values to Index)
Definition at line 471 of file regularData3D.h.
|
inlineprotected |
map indices to Cartesian coordinates
Definition at line 456 of file regularData3D.h.
|
inline |
Definition at line 191 of file regularData3D.h.
|
inline |
Inequality operator.
Definition at line 160 of file regularData3D.h.
BALL_INLINE ValueType BALL::TRegularData3D< ValueType >::operator() | ( | const CoordinateType & | x | ) | const |
Function operator. This operator allows the use of a TRegularData1D instance as a unary function. As required by the STL Unary Function
concept, the argument x
is required to be within the correct range. A more robust (range-checking) version of this operator is implemented as getInterpolatedValue . getInterpolatedValue() . getOrigin() <= x <= getOrigin() + getDimension()
Definition at line 1056 of file regularData3D.h.
BALL_INLINE TRegularData3D< ValueType > & BALL::TRegularData3D< ValueType >::operator= | ( | const TRegularData3D< ValueType > & | data | ) |
Assignment operator. Copy the data, the origin, and the dimension (spacing is copied implicitly as well).
Exception::OutOfMemory | if the memory for the copy could not be allocated |
Definition at line 688 of file regularData3D.h.
bool BALL::TRegularData3D< ValueType >::operator== | ( | const TRegularData3D< ValueType > & | grid | ) | const |
Equality operator. Two point grids are equal if they have the same number of points in all three dimensions, same origin, spacing and all array members are identical.
Definition at line 1278 of file regularData3D.h.
|
inline |
Nonmutable random access operator.
Definition at line 226 of file regularData3D.h.
|
inline |
Mutable random access operator.
Definition at line 235 of file regularData3D.h.
|
inline |
Nonmutable random access operator.
Definition at line 244 of file regularData3D.h.
|
inline |
Mutable random access operator.
Definition at line 250 of file regularData3D.h.
void BALL::TRegularData3D< ValueType >::rescale | ( | const IndexType & | new_size | ) |
Rescale the data. Keep the current boundaries of the data and reinterpolate the data to reflect the new size. To create a data set of new_size
data points, the data is interpolated linearly at the new data points from the closest points in the old data set.
new_size | the new data set size |
Exception::OutOfMemory | if the memory for the resized grid could not be allocated |
Definition at line 782 of file regularData3D.h.
void BALL::TRegularData3D< ValueType >::resize | ( | const IndexType & | size | ) |
Resize the data. If new_size
is larger than the current size, the data vector
is extended to the new size and filled with default constructed items of type ValueType
. Resizing to a value lesser than the current size truncates the vector.
size | the new size |
Exception::OutOfMemory | if the memory for the resized grid could not be allocated |
Definition at line 719 of file regularData3D.h.
|
inline |
Set the dimension of the data. This will affect neither the origin of the data, nor the number of elements stored (in contrast to resize() ). It will just store the appropriate scaling factor and affect the spacing.
Definition at line 338 of file regularData3D.h.
|
inline |
Set the origin of the data.
Definition at line 321 of file regularData3D.h.
|
inline |
Definition at line 190 of file regularData3D.h.
|
inline |
Definition at line 192 of file regularData3D.h.
|
protected |
The grid data.
Definition at line 488 of file regularData3D.h.
|
protected |
Dimension of the grid.
Definition at line 494 of file regularData3D.h.
|
protected |
Definition at line 510 of file regularData3D.h.
|
protected |
A flag deciding whether the grid is orthogonal or not.
Definition at line 506 of file regularData3D.h.
|
protected |
mapping matrix and its inverse
Definition at line 509 of file regularData3D.h.
|
protected |
Origin of the grid (offset)
Definition at line 491 of file regularData3D.h.
|
protected |
The dimensions in grid points.
Definition at line 500 of file regularData3D.h.
|
protected |
Grid spacing.
Definition at line 497 of file regularData3D.h.