#include <Cube.h>
Inheritance diagram for casa::Cube< T >:
Cube objects are three-dimensional specializations (e.g., more convenient and efficient indexing) of the general Array class. You might also want to look at the Array documentation to see inherited functionality. A tutorial on using the array classes in general is available in the "AIPS++ Programming Manual".
Generally the member functions of Array are also available in Cube versions which take a pair of integers where the array needs an IPosition. Since the Cube is three-dimensional, the IPositions are overkill, although you may use those versions if you want to.
Cube<Int> ci(100,100,100); // Shape is 100x100 ci.resize(50,50,50); // Shape now 50x50
Slices may be taken with the Slice class. To take a slice, one "indexes" with one Slice(start, length, inc) for each axis, where end and inc are optional. Additionally, there is an xyPlane() member function which return a Matrix which corresponds to some plane:
Cube<Float> cube(10,20,30);
for(uInt i=0; i < 30; i++) {
cube.xyPlane(i) = i; // Set every 10x20 plane to its "height"
}
Element-by-element arithmetic and logical operations are available (in aips/ArrayMath.h and aips/ArrayLogical.h).
As with the Arrays, if the preprocessor symbol AIPS_DEBUG is defined at compile time invariants will be checked on entry to most member functions. Additionally, if AIPS_ARRAY_INDEX_CHECK is defined index operations will be bounds-checked. Neither of these should be defined for production code.
Definition at line 81 of file Cube.h.
Public Member Functions | |
| Cube () | |
| A Cube of length zero in each dimension; zero origin. | |
| Cube (uInt l1, uInt l2, uInt l3) | |
| A l1xl2xl3 sized cube. | |
| Cube (uInt l1, uInt l2, uInt l3, const T &initialValue) | |
| A l1xl2xl3 sized cube. | |
| Cube (const IPosition &len) | |
| A Cube where the shape ("len") is defined with IPositions. | |
| Cube (const IPosition &len, const T &initialValue) | |
| A Cube where the shape ("len") is defined with IPositions. | |
| Cube (const Cube< T > &) | |
| The copy constructor uses reference semantics. | |
| Cube (const Array< T > &) | |
| Construct a cube by reference from "other". | |
| Cube (const IPosition &shape, T *storage, StorageInitPolicy policy=COPY) | |
| Create an Cube of a given shape from a pointer. | |
| Cube (const IPosition &shape, const T *storage) | |
| Create an Cube of a given shape from a pointer. | |
| virtual | ~Cube () |
| Define a destructor, otherwise the (SUN) compiler makes a static one. | |
| virtual void | assign (const Array< T > &other) |
| Assign the other array (which must be dimension 3) to this cube. | |
| virtual void | reference (const Array< T > &other) |
| Make this cube a reference to other. | |
| Array< T > & | operator= (const T &val) |
| Copy val into every element of this cube; i.e. | |
| Cube< T > & | operator= (const MaskedArray< T > &marray) |
| Copy to this those values in marray whose corresponding elements in marray's mask are True. | |
| Cube< T > | operator() (const Slice &sliceX, const Slice &sliceY, const Slice &sliceZ) |
| Take a slice of this cube. | |
| uInt | nrow () const |
| The number of rows in the Cube, i.e. | |
| uInt | ncolumn () const |
| The number of columns in the Cube, i.e. | |
| uInt | nplane () const |
| The number of planes in the Cube, i.e. | |
| virtual Bool | ok () const |
| Checks that the cube is consistent (invariants check out). | |
| void | resize (uInt nx, uInt ny, uInt nz, Bool copyValues=False) |
| Resize to the given shape. | |
| virtual void | resize () |
| Make this array a different shape. | |
| virtual void | resize (const IPosition &newShape, Bool copyValues=False) |
| Cube< T > & | operator= (const Cube< T > &other) |
| Copy the values from other to this cube. | |
| virtual Array< T > & | operator= (const Array< T > &other) |
| Copy the values in other to this. | |
| T & | operator() (const IPosition &i) |
| Single-pixel addressing. | |
| const T & | operator() (const IPosition &i) const |
| T & | operator() (uInt i1, uInt i2, uInt i3) |
| const T & | operator() (uInt i1, uInt i2, uInt i3) const |
| Array< T > | operator() (const IPosition &blc, const IPosition &trc, const IPosition &incr) |
| Slice using IPositions. | |
| Array< T > | operator() (const IPosition &blc, const IPosition &trc) |
| Get a reference to an array which extends from "start" to end. | |
| Array< T > | operator() (const Slicer &slicer) |
| Get a reference to an array using a Slicer. | |
| MaskedArray< T > | operator() (const LogicalArray &mask) const |
| Return a MaskedArray. | |
| MaskedArray< T > | operator() (const LogicalArray &mask) |
| Return a MaskedArray. | |
| MaskedArray< T > | operator() (const MaskedLogicalArray &mask) const |
| Return a MaskedArray. | |
| MaskedArray< T > | operator() (const MaskedLogicalArray &mask) |
| Return a MaskedArray. | |
| Matrix< T > | xyPlane (uInt zplane) |
| Extract a plane as a cube. | |
| const Matrix< T > | xyPlane (uInt zplane) const |
| void | shape (Int &s1, Int &s2, Int &s3) const |
| The length of each axis of the cube. | |
| const IPosition & | shape () const |
| The length of each axis. | |
| virtual void | takeStorage (const IPosition &shape, T *storage, StorageInitPolicy policy=COPY) |
Replace the data values with those in the pointer storage. | |
| virtual void | takeStorage (const IPosition &shape, const T *storage) |
| Since the pointer is const, a copy is always taken. | |
Protected Member Functions | |
| virtual void | doNonDegenerate (Array< T > &other, const IPosition &ignoreAxes) |
| Remove the degenerate axes from other and store result in this cube. | |
Private Member Functions | |
| void | makeIndexingConstants () |
| Helper fn to calculate the indexing constants. | |
Private Attributes | |
| Int | xinc_p |
| Cached constants to improve indexing. | |
| Int | yinc_p |
| Int | zinc_p |
| casa::Cube< T >::Cube | ( | ) |
A Cube of length zero in each dimension; zero origin.
| casa::Cube< T >::Cube | ( | uInt | l1, | |
| uInt | l2, | |||
| uInt | l3 | |||
| ) |
A l1xl2xl3 sized cube.
| casa::Cube< T >::Cube | ( | uInt | l1, | |
| uInt | l2, | |||
| uInt | l3, | |||
| const T & | initialValue | |||
| ) |
A l1xl2xl3 sized cube.
Fill it with the initial value.
| casa::Cube< T >::Cube | ( | const IPosition & | len | ) |
A Cube where the shape ("len") is defined with IPositions.
| casa::Cube< T >::Cube | ( | const IPosition & | len, | |
| const T & | initialValue | |||
| ) |
A Cube where the shape ("len") is defined with IPositions.
Fill it with the initial value.
| casa::Cube< T >::Cube | ( | const Cube< T > & | ) |
The copy constructor uses reference semantics.
| casa::Cube< T >::Cube | ( | const Array< T > & | ) |
Construct a cube by reference from "other".
"other must have ndim() of 3 or less. The warning which applies to the copy constructor is also valid here.
| casa::Cube< T >::Cube | ( | const IPosition & | shape, | |
| T * | storage, | |||
| StorageInitPolicy | policy = COPY | |||
| ) |
Create an Cube of a given shape from a pointer.
| casa::Cube< T >::Cube | ( | const IPosition & | shape, | |
| const T * | storage | |||
| ) |
Create an Cube of a given shape from a pointer.
Because the pointer is const, a copy is always made.
| virtual casa::Cube< T >::~Cube | ( | ) | [virtual] |
Define a destructor, otherwise the (SUN) compiler makes a static one.
| virtual void casa::Cube< T >::assign | ( | const Array< T > & | other | ) | [virtual] |
Assign the other array (which must be dimension 3) to this cube.
If the shapes mismatch, this array is resized.
Reimplemented from casa::Array< T >.
| virtual void casa::Cube< T >::reference | ( | const Array< T > & | other | ) | [virtual] |
Make this cube a reference to other.
Other must be of dimensionality 3 or less.
Reimplemented from casa::Array< T >.
| void casa::Cube< T >::resize | ( | uInt | nx, | |
| uInt | ny, | |||
| uInt | nz, | |||
| Bool | copyValues = False | |||
| ) |
Resize to the given shape.
Resize without argument is equal to resize(0,0,0).
| virtual void casa::Cube< T >::resize | ( | ) | [virtual] |
Make this array a different shape.
If copyValues==True the old values are copied over to the new array. Copying is done on a per axis basis, thus a subsection with the minimum of the old and new shape is copied.
Resize without argument is equal to resize(IPosition()).
It is important to note that if multiple Array objects reference the same data storage, this Array object still references the same data storage as the other Array objects if the shape does not change. Otherwise this Array object references newly allocated storage, while the other Array objects still reference the existing data storage.
If you want to be sure that the data storage of this Array object is not referenced by other Array objects, the function unique should be called first.
Reimplemented from casa::Array< T >.
| virtual void casa::Cube< T >::resize | ( | const IPosition & | newShape, | |
| Bool | copyValues = False | |||
| ) | [virtual] |
Reimplemented from casa::Array< T >.
| Cube<T>& casa::Cube< T >::operator= | ( | const Cube< T > & | other | ) |
Copy the values from other to this cube.
If this cube has zero elements then it will resize to be the same shape as other; otherwise other must conform to this. Note that the assign function can be used to assign a non-conforming cube.
| virtual Array<T>& casa::Cube< T >::operator= | ( | const Array< T > & | other | ) | [virtual] |
Copy the values in other to this.
If the array on the left hand side has no elements, then it is resized to be the same size as as the array on the right hand side. Otherwise, the arrays must conform (same shapes).
IPosition shape(2,10,10); // some shape Array<Double> ad(shape); //.\.. Array<Double> ad2; // N.B. ad2.nelements() == 0 ad2 = ad; // ad2 resizes, then elements // are copied. shape = 20; Array<Double> ad3(shape); ad3 = ad; // Error: arrays do not conform
Reimplemented from casa::Array< T >.
| Array<T>& casa::Cube< T >::operator= | ( | const T & | val | ) | [inline] |
Copy val into every element of this cube; i.e.
behaves as if val were a constant conformant cube.
Reimplemented from casa::Array< T >.
| Cube<T>& casa::Cube< T >::operator= | ( | const MaskedArray< T > & | marray | ) | [inline] |
Copy to this those values in marray whose corresponding elements in marray's mask are True.
Reimplemented from casa::Array< T >.
| T& casa::Cube< T >::operator() | ( | const IPosition & | i | ) | [inline] |
Single-pixel addressing.
If AIPS_ARRAY_INDEX_CHECK is defined, bounds checking is performed.
Reimplemented from casa::Array< T >.
| const T& casa::Cube< T >::operator() | ( | const IPosition & | i | ) | const [inline] |
| T& casa::Cube< T >::operator() | ( | uInt | i1, | |
| uInt | i2, | |||
| uInt | i3 | |||
| ) | [inline] |
| const T& casa::Cube< T >::operator() | ( | uInt | i1, | |
| uInt | i2, | |||
| uInt | i3 | |||
| ) | const [inline] |
| Cube<T> casa::Cube< T >::operator() | ( | const Slice & | sliceX, | |
| const Slice & | sliceY, | |||
| const Slice & | sliceZ | |||
| ) |
Take a slice of this cube.
Slices are always indexed starting at zero. This uses reference semantics, i.e. changing a value in the slice changes the original.
Cube<Double> vd(100,100,100);
//.\..
vd(Slice(0,10),Slice(10,10,Slice(0,10))) = -1.0; // sub-cube set to -1.0
| Array<T> casa::Cube< T >::operator() | ( | const IPosition & | blc, | |
| const IPosition & | trc, | |||
| const IPosition & | incr | |||
| ) | [inline] |
Slice using IPositions.
Required to be defined, otherwise the base class versions are hidden.
Reimplemented from casa::Array< T >.
| Array<T> casa::Cube< T >::operator() | ( | const IPosition & | blc, | |
| const IPosition & | trc | |||
| ) | [inline] |
Get a reference to an array which extends from "start" to end.
"
Reimplemented from casa::Array< T >.
| Array<T> casa::Cube< T >::operator() | ( | const Slicer & | slicer | ) | [inline] |
| MaskedArray<T> casa::Cube< T >::operator() | ( | const LogicalArray & | mask | ) | const [inline] |
| MaskedArray<T> casa::Cube< T >::operator() | ( | const LogicalArray & | mask | ) | [inline] |
| MaskedArray<T> casa::Cube< T >::operator() | ( | const MaskedLogicalArray & | mask | ) | const [inline] |
| MaskedArray<T> casa::Cube< T >::operator() | ( | const MaskedLogicalArray & | mask | ) | [inline] |
| Matrix<T> casa::Cube< T >::xyPlane | ( | uInt | zplane | ) |
Extract a plane as a cube.
We could have xzPlane, etc also if that would be of use to anyone. Of course you could also use a Matrix iterator on the cube.
| const Matrix<T> casa::Cube< T >::xyPlane | ( | uInt | zplane | ) | const |
| void casa::Cube< T >::shape | ( | Int & | s1, | |
| Int & | s2, | |||
| Int & | s3 | |||
| ) | const [inline] |
| const IPosition& casa::Cube< T >::shape | ( | ) | const [inline] |
| uInt casa::Cube< T >::nrow | ( | ) | const [inline] |
| uInt casa::Cube< T >::ncolumn | ( | ) | const [inline] |
| uInt casa::Cube< T >::nplane | ( | ) | const [inline] |
| virtual void casa::Cube< T >::takeStorage | ( | const IPosition & | shape, | |
| T * | storage, | |||
| StorageInitPolicy | policy = COPY | |||
| ) | [virtual] |
Replace the data values with those in the pointer storage.
The results are undefined is storage does not point at nelements() or more data elements. After takeStorage() is called, unique() is True.
Reimplemented from casa::Array< T >.
| virtual void casa::Cube< T >::takeStorage | ( | const IPosition & | shape, | |
| const T * | storage | |||
| ) | [virtual] |
| virtual Bool casa::Cube< T >::ok | ( | ) | const [virtual] |
| virtual void casa::Cube< T >::doNonDegenerate | ( | Array< T > & | other, | |
| const IPosition & | ignoreAxes | |||
| ) | [protected, virtual] |
Remove the degenerate axes from other and store result in this cube.
An exception is thrown if removing degenerate axes does not result in a cube.
Reimplemented from casa::Array< T >.
| void casa::Cube< T >::makeIndexingConstants | ( | ) | [private] |
Helper fn to calculate the indexing constants.
Int casa::Cube< T >::xinc_p [private] |
Cached constants to improve indexing.
Definition at line 292 of file Cube.h.
Referenced by casa::Cube< std::complex< Float > >::operator()().
Int casa::Cube< T >::yinc_p [private] |
Definition at line 292 of file Cube.h.
Referenced by casa::Cube< std::complex< Float > >::operator()().
Int casa::Cube< T >::zinc_p [private] |
Definition at line 292 of file Cube.h.
Referenced by casa::Cube< std::complex< Float > >::operator()().
1.5.1