#include <BALL/DATATYPE/regularData1D.h>
Classes | |
| struct | BlockValueType |
| The block data type for reading and writing binary data. 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 Position | IndexType |
| The IndexType. | |
| typedef std::vector< ValueType > | VectorType |
| The type containing an STL vector of the corresponding ValueType. | |
| typedef double | CoordinateType |
| The coordinate type. | |
| typedef std::vector< ValueType > ::iterator | Iterator |
| A mutable iterator. | |
| typedef std::vector< ValueType > ::const_iterator | ConstIterator |
| A constant iterator. | |
Public Member Functions | |
Constructors and Destructors. | |
| TRegularData1D () | |
| Default constructor. | |
| TRegularData1D (const TRegularData1D &data) | |
| TRegularData1D (const CoordinateType &origin, const CoordinateType &dimension, const CoordinateType &spacing) | |
| TRegularData1D (const IndexType &size) | |
| TRegularData1D (const VectorType &data, const CoordinateType &origin=0.0, const CoordinateType &dimension=1.0) | |
| virtual | ~TRegularData1D () |
| Destructor. | |
| virtual void | clear () |
| Clear the contents. | |
Assignment | |
| TRegularData1D & | operator= (const TRegularData1D< ValueType > &data) |
| TRegularData1D & | operator= (const VectorType &data) |
Predicates | |
| bool | operator== (const TRegularData1D &data) const |
| Equality operator. | |
| BALL_INLINE bool | operator!= (const TRegularData1D &data) const |
| Inequality operator. | |
| BALL_INLINE bool | empty () const |
| Empty predicate. | |
| bool | isInside (const CoordinateType &x) const |
| Test whether a point is inside the grid. | |
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 (TRegularData1D< ValueType > &data) |
| const ValueType & | getData (const IndexType &index) const |
| ValueType & | getData (const IndexType &index) |
| const ValueType & | operator[] (const IndexType &index) const |
| ValueType & | operator[] (const IndexType &index) |
| ValueType | operator() (const CoordinateType &x) const |
| ValueType | getInterpolatedValue (const CoordinateType &x) const |
| void | getEnclosingIndices (const CoordinateType &x, Position &lower, Position &upper) const |
| void | getEnclosingValues (const CoordinateType &x, ValueType &lower, ValueType &upper) const |
| CoordinateType | getCoordinates (const IndexType &index) const |
| IndexType | getClosestIndex (const CoordinateType &x) const |
| IndexType | getLowerIndex (const CoordinateType &x) const |
| const ValueType & | getClosestValue (const CoordinateType &x) const |
| ValueType & | getClosestValue (const CoordinateType &x) |
| BALL_INLINE IndexType | getSize () const |
| Return the number of points in the data set. | |
| BALL_INLINE const CoordinateType & | getOrigin () const |
| BALL_INLINE const CoordinateType & | getSpacing () const |
| BALL_INLINE void | setOrigin (const CoordinateType &origin) |
| BALL_INLINE const CoordinateType & | getDimension () const |
| BALL_INLINE void | setDimension (const CoordinateType &dimension) |
| void | resize (const IndexType &size) |
| void | rescale (const IndexType &new_size) |
| ValueType | calculateMean () const |
| ValueType | calculateSD () const |
| void | binaryWrite (const String &filename) const |
| void | binaryRead (const String &filename) |
Protected Attributes | |
| CoordinateType | origin_ |
| The origin of the data set. | |
| CoordinateType | dimension_ |
| The dimension (length). | |
| CoordinateType | spacing_ |
| The spacing. | |
| VectorType | data_ |
| The data. | |
A class to store regularaly spaced data. This class can is intended to hold regularly spaced, one-dimensional data sets. It might be useful to hold data sets like spectra, or precomputed function values.
Container and Unary Function requirements. Definition at line 40 of file regularData1D.h.
| typedef std::vector<ValueType>::const_iterator BALL::TRegularData1D< ValueType >::const_iterator |
Definition at line 66 of file regularData1D.h.
| typedef std::vector<ValueType>::const_reference BALL::TRegularData1D< ValueType >::const_reference |
Definition at line 68 of file regularData1D.h.
| typedef std::vector<ValueType>::const_iterator BALL::TRegularData1D< ValueType >::ConstIterator |
A constant iterator.
Definition at line 59 of file regularData1D.h.
| typedef double BALL::TRegularData1D< ValueType >::CoordinateType |
The coordinate type.
Definition at line 55 of file regularData1D.h.
| typedef std::vector<ValueType>::difference_type BALL::TRegularData1D< ValueType >::difference_type |
Definition at line 70 of file regularData1D.h.
| typedef Position BALL::TRegularData1D< ValueType >::IndexType |
The IndexType.
Definition at line 51 of file regularData1D.h.
| typedef std::vector<ValueType>::iterator BALL::TRegularData1D< ValueType >::iterator |
Definition at line 65 of file regularData1D.h.
| typedef std::vector<ValueType>::iterator BALL::TRegularData1D< ValueType >::Iterator |
A mutable iterator.
Definition at line 57 of file regularData1D.h.
| typedef std::vector<ValueType>::pointer BALL::TRegularData1D< ValueType >::pointer |
Definition at line 69 of file regularData1D.h.
| typedef std::vector<ValueType>::reference BALL::TRegularData1D< ValueType >::reference |
Definition at line 67 of file regularData1D.h.
| typedef std::vector<ValueType>::size_type BALL::TRegularData1D< ValueType >::size_type |
Definition at line 71 of file regularData1D.h.
| typedef ValueType BALL::TRegularData1D< ValueType >::value_type |
Definition at line 64 of file regularData1D.h.
| typedef std::vector<ValueType> BALL::TRegularData1D< ValueType >::VectorType |
The type containing an STL vector of the corresponding ValueType.
Definition at line 53 of file regularData1D.h.
| BALL::TRegularData1D< ValueType >::TRegularData1D | ( | ) | [inline] |
Default constructor.
Definition at line 360 of file regularData1D.h.
| BALL::TRegularData1D< ValueType >::TRegularData1D | ( | const TRegularData1D< ValueType > & | data | ) | [inline] |
Copy constructor
| Exception::OutOfMemory | if the memory for the copy could not be allocated. |
Definition at line 374 of file regularData1D.h.
| BALL::TRegularData1D< ValueType >::TRegularData1D | ( | const CoordinateType & | origin, | |
| const CoordinateType & | dimension, | |||
| const CoordinateType & | spacing | |||
| ) |
Detailed constructor.
| Exception::OutOfMemory | if the memory for the grid could not be allocated. |
| BALL::TRegularData1D< ValueType >::TRegularData1D | ( | const IndexType & | size | ) |
This constructor sets origin to 0.0 and dimension to 1.0
| Exception::OutOfMemory | if the memory for the grid could not be allocated. |
| BALL::TRegularData1D< ValueType >::TRegularData1D | ( | const VectorType & | data, | |
| const CoordinateType & | origin = 0.0, |
|||
| const CoordinateType & | dimension = 1.0 | |||
| ) |
This constructor sets origin to 0.0 and dimension to 1.0
| Exception::OutOfMemory | if the memory for the grid could not be allocated. |
| BALL::TRegularData1D< ValueType >::~TRegularData1D | ( | ) | [inline, virtual] |
Destructor.
Definition at line 369 of file regularData1D.h.
| BALL_INLINE Iterator BALL::TRegularData1D< ValueType >::begin | ( | ) | [inline] |
Definition at line 150 of file regularData1D.h.
| BALL_INLINE ConstIterator BALL::TRegularData1D< ValueType >::begin | ( | ) | const [inline] |
Definition at line 146 of file regularData1D.h.
| void BALL::TRegularData1D< ValueType >::binaryRead | ( | const String & | filename | ) | [inline] |
Read the grid contents from a file written with binaryWrite
| FileNotFound | thrown if file doesnt exists or could not be read |
Definition at line 875 of file regularData1D.h.
| void BALL::TRegularData1D< ValueType >::binaryWrite | ( | const String & | filename | ) | const [inline] |
Write the grid contents in a (non-portable) binary format.
| FileNotFound | thrown if the file could not be written |
Definition at line 827 of file regularData1D.h.
| BALL_INLINE ValueType BALL::TRegularData1D< ValueType >::calculateMean | ( | ) | const [inline] |
| BALL_INLINE ValueType BALL::TRegularData1D< ValueType >::calculateSD | ( | ) | const [inline] |
Calculate the standard deviation of the dataset
Definition at line 663 of file regularData1D.h.
| void BALL::TRegularData1D< ValueType >::clear | ( | ) | [inline, virtual] |
Clear the contents.
Reimplemented in BALL::TFFT1D< ComplexTraits >.
Definition at line 459 of file regularData1D.h.
| BALL_INLINE bool BALL::TRegularData1D< ValueType >::empty | ( | ) | const [inline] |
Empty predicate.
Definition at line 136 of file regularData1D.h.
| BALL_INLINE Iterator BALL::TRegularData1D< ValueType >::end | ( | ) | [inline] |
Definition at line 152 of file regularData1D.h.
| BALL_INLINE ConstIterator BALL::TRegularData1D< ValueType >::end | ( | ) | const [inline] |
Definition at line 148 of file regularData1D.h.
| BALL_INLINE TRegularData1D< ValueType >::IndexType BALL::TRegularData1D< ValueType >::getClosestIndex | ( | const CoordinateType & | x | ) | const [inline] |
Return the index of the closest grid point. This method first performs a range check for the argument x and then returns the index of the closest grid point to the left or right of x.
| Exception::OutOfGrid | if the point is outside the grid boundaries |
Definition at line 597 of file regularData1D.h.
| BALL_INLINE ValueType & BALL::TRegularData1D< ValueType >::getClosestValue | ( | const CoordinateType & | x | ) | [inline] |
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 the point is outside the grid boundaries |
Definition at line 635 of file regularData1D.h.
| BALL_INLINE const ValueType & BALL::TRegularData1D< ValueType >::getClosestValue | ( | const CoordinateType & | x | ) | const [inline] |
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 the point is outside the grid boundaries |
Definition at line 621 of file regularData1D.h.
| CoordinateType BALL::TRegularData1D< ValueType >::getCoordinates | ( | const IndexType & | index | ) | const |
Return the exact coordinates of a grid point.
| Exception::OutOfGrid | if the point is outside the grid boundaries |
| BALL_INLINE ValueType & BALL::TRegularData1D< ValueType >::getData | ( | const IndexType & | index | ) | [inline] |
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 532 of file regularData1D.h.
| BALL_INLINE const ValueType & BALL::TRegularData1D< ValueType >::getData | ( | const IndexType & | index | ) | const [inline] |
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 521 of file regularData1D.h.
| BALL_INLINE const CoordinateType& BALL::TRegularData1D< ValueType >::getDimension | ( | ) | const [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 282 of file regularData1D.h.
| void BALL::TRegularData1D< ValueType >::getEnclosingIndices | ( | const CoordinateType & | x, | |
| Position & | lower, | |||
| Position & | upper | |||
| ) | const |
Return the indices of the grid points to the left and to the right of a point.
| x | a point inside the grid | |
| lower | index of the grid point to the left | |
| upper | index of the grid point to the right |
| Exception::OutOfGrid | if the point is outside the grid boundaries |
| void BALL::TRegularData1D< ValueType >::getEnclosingValues | ( | const CoordinateType & | x, | |
| ValueType & | lower, | |||
| ValueType & | upper | |||
| ) | const |
Return the data at the grid points to the left and to the right of a point.
| Exception::OutOfGrid | if the point is outside the grid boundaries |
| BALL_INLINE ValueType BALL::TRegularData1D< ValueType >::getInterpolatedValue | ( | const CoordinateType & | x | ) | const [inline] |
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 573 of file regularData1D.h.
| BALL_INLINE TRegularData1D< ValueType >::IndexType BALL::TRegularData1D< ValueType >::getLowerIndex | ( | const CoordinateType & | x | ) | const [inline] |
Return the index of the grid point with the next lowest coordinate. This method first performs a range check for the argument x and then returns the index of the closest grid point to the left (i.e. with a lesser coordinate) of x.
| Exception::OutOfGrid | if the point is outside the grid boundaries |
Definition at line 609 of file regularData1D.h.
| BALL_INLINE const CoordinateType& BALL::TRegularData1D< ValueType >::getOrigin | ( | ) | const [inline] |
Return the origin of the data. The origin represents the coordinate of the very first (leftmost) element, i.e. data_[0].
Definition at line 265 of file regularData1D.h.
| BALL_INLINE IndexType BALL::TRegularData1D< ValueType >::getSize | ( | ) | const [inline] |
Return the number of points in the data set.
Definition at line 259 of file regularData1D.h.
| BALL_INLINE const CoordinateType& BALL::TRegularData1D< ValueType >::getSpacing | ( | ) | const [inline] |
Return the spacing of the data. The spacing corresponds to the distance between two adjacent data elements.
Definition at line 271 of file regularData1D.h.
| bool BALL::TRegularData1D< ValueType >::isInside | ( | const CoordinateType & | x | ) | const |
Test whether a point is inside the grid.
| BALL_INLINE size_type BALL::TRegularData1D< ValueType >::max_size | ( | ) | const [inline] |
Definition at line 161 of file regularData1D.h.
| BALL_INLINE bool BALL::TRegularData1D< ValueType >::operator!= | ( | const TRegularData1D< ValueType > & | data | ) | const [inline] |
Inequality operator.
Definition at line 133 of file regularData1D.h.
| BALL_INLINE ValueType BALL::TRegularData1D< ValueType >::operator() | ( | const CoordinateType & | x | ) | const [inline] |
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 .
Definition at line 679 of file regularData1D.h.
| TRegularData1D< ValueType > & BALL::TRegularData1D< ValueType >::operator= | ( | const VectorType & | data | ) | [inline] |
Assignment from a vector of ValueType. Copy the contents of the data without changing the boundaries.
| Exception::OutOfMemory | if the memory for the copy could not be allocated. |
Definition at line 488 of file regularData1D.h.
| TRegularData1D< ValueType > & BALL::TRegularData1D< ValueType >::operator= | ( | const TRegularData1D< ValueType > & | data | ) | [inline] |
Assignment operator. Copy the data and the boundaries.
| Exception::OutOfMemory | if the memory for the copy could not be allocated. |
Definition at line 468 of file regularData1D.h.
| bool BALL::TRegularData1D< ValueType >::operator== | ( | const TRegularData1D< ValueType > & | data | ) | const [inline] |
Equality operator.
Definition at line 505 of file regularData1D.h.
| ValueType& BALL::TRegularData1D< ValueType >::operator[] | ( | const IndexType & | index | ) | [inline] |
Mutable random access operator.
Definition at line 186 of file regularData1D.h.
| const ValueType& BALL::TRegularData1D< ValueType >::operator[] | ( | const IndexType & | index | ) | const [inline] |
Constant random access operator.
Definition at line 180 of file regularData1D.h.
| void BALL::TRegularData1D< 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 |
| void BALL::TRegularData1D< 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.
| new_size | the new size |
| Exception::OutOfMemory | if the memory for the resized grid could not be allocated |
| BALL_INLINE void BALL::TRegularData1D< ValueType >::setDimension | ( | const CoordinateType & | dimension | ) | [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 289 of file regularData1D.h.
| BALL_INLINE void BALL::TRegularData1D< ValueType >::setOrigin | ( | const CoordinateType & | origin | ) | [inline] |
Set the origin of the data.
Definition at line 275 of file regularData1D.h.
| BALL_INLINE size_type BALL::TRegularData1D< ValueType >::size | ( | ) | const [inline] |
Definition at line 160 of file regularData1D.h.
| BALL_INLINE void BALL::TRegularData1D< ValueType >::swap | ( | TRegularData1D< ValueType > & | data | ) | [inline] |
Definition at line 162 of file regularData1D.h.
VectorType BALL::TRegularData1D< ValueType >::data_ [protected] |
The data.
Definition at line 349 of file regularData1D.h.
CoordinateType BALL::TRegularData1D< ValueType >::dimension_ [protected] |
The dimension (length).
Definition at line 343 of file regularData1D.h.
CoordinateType BALL::TRegularData1D< ValueType >::origin_ [protected] |
The origin of the data set.
Reimplemented in BALL::TFFT1D< ComplexTraits >.
Definition at line 340 of file regularData1D.h.
CoordinateType BALL::TRegularData1D< ValueType >::spacing_ [protected] |
The spacing.
Definition at line 346 of file regularData1D.h.
1.6.3