casacore::Cube< T > Class Template Reference

A 3-D Specialization of the Array class. More...

#include <Cube.h>

Inheritance diagram for casacore::Cube< T >:

Public Member Functions
	Cube ()
	A Cube of length zero in each dimension; zero origin.
	Cube (size_t l1, size_t l2, size_t l3)
	A l1xl2xl3 sized cube.
	Cube (size_t l1, size_t l2, size_t l3, ArrayInitPolicy initPolicy)
	A l1xl2xl3 sized cube.
	Cube (size_t l1, size_t l2, size_t 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, ArrayInitPolicy initPolicy)
	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, T *storage, StorageInitPolicy policy, AbstractAllocator< T > const &allocator)
	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.
void	resize (size_t nx, size_t ny, size_t nz, Bool copyValues=False)
void	resize (size_t nx, size_t ny, size_t nz, Bool copyValues, ArrayInitPolicy policy)
virtual void	resize ()
	Make this array a different shape.
virtual void	resize (const IPosition &newShape, Bool copyValues, ArrayInitPolicy policy)
	Resize the array and optionally copy the values.
Cube< T > &	operator= (const Cube< T > &other)
	Copy the values from other to this cube.
virtual Array< T > &	operator= (const Array< T > &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.
T &	operator() (const IPosition &i)
	Single-pixel addressing.
const T &	operator() (const IPosition &i) const
T &	operator() (size_t i1, size_t i2, size_t i3)
const T &	operator() (size_t i1, size_t i2, size_t i3) const
T &	at (size_t i1, size_t i2, size_t i3)
const T &	at (size_t i1, size_t i2, size_t i3) const
Cube< T >	operator() (const Slice &sliceX, const Slice &sliceY, const Slice &sliceZ)
	Take a slice of this cube.
const Cube< T >	operator() (const Slice &sliceX, const Slice &sliceY, const Slice &sliceZ) const
Array< T >	operator() (const IPosition &blc, const IPosition &trc, const IPosition &incr)
	Slice using IPositions.
const Array< T >	operator() (const IPosition &blc, const IPosition &trc, const IPosition &incr) const
Array< T >	operator() (const IPosition &blc, const IPosition &trc)
	Get a reference to an array section extending from start to end (inclusive).
const Array< T >	operator() (const IPosition &blc, const IPosition &trc) const
Array< T >	operator() (const Slicer &slicer)
	Get a reference to an array section using a Slicer.
const Array< T >	operator() (const Slicer &slicer) const
const MaskedArray< T >	operator() (const LogicalArray &mask) const
	The array is masked by the input LogicalArray.
MaskedArray< T >	operator() (const LogicalArray &mask)
	Return a MaskedArray.
const MaskedArray< T >	operator() (const MaskedLogicalArray &mask) const
	The array is masked by the input MaskedLogicalArray.
MaskedArray< T >	operator() (const MaskedLogicalArray &mask)
	Return a MaskedArray.
Matrix< T >	xyPlane (size_t zplane)
	Extract a plane as a matrix referencing the original data.
const Matrix< T >	xyPlane (size_t zplane) const
Matrix< T >	xzPlane (size_t yplane)
const Matrix< T >	xzPlane (size_t yplane) const
Matrix< T >	yzPlane (size_t xplane)
const Matrix< T >	yzPlane (size_t xplane) const
const IPosition &	shape () const
	The length of each axis of the cube.
void	shape (Int &s1, Int &s2, Int &s3) const
size_t	nrow () const
	The number of rows in the Cube, i.e.
size_t	ncolumn () const
	The number of columns in the Cube, i.e.
size_t	nplane () const
	The number of planes in the Cube, i.e.
virtual Bool	ok () const
	Checks that the cube is consistent (invariants check out).
Protected Member Functions
virtual void	preTakeStorage (const IPosition &shape)
	pre/post processing hook of takeStorage() for subclasses.
virtual void	postTakeStorage ()
virtual void	doNonDegenerate (const 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
size_t	xinc_p
	Cached constants to improve indexing.
size_t	yinc_p
size_t	zinc_p

Detailed Description

template<class T>
class casacore::Cube< T >

A 3-D Specialization of the Array class.

Review Status

Reviewed By:: UNKNOWN
Date Reviewed:: before2004/08/25

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.

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 80 of file Cube.h.

Constructor & Destructor Documentation

template<class T>

casacore::Cube< T >::Cube ( )

A Cube of length zero in each dimension; zero origin.

template<class T>

casacore::Cube< T >::Cube	(	size_t	l1,
		size_t	l2,
		size_t	l3
	)

A l1xl2xl3 sized cube.

template<class T>

casacore::Cube< T >::Cube	(	size_t	l1,
		size_t	l2,
		size_t	l3,
		ArrayInitPolicy	initPolicy
	)

A l1xl2xl3 sized cube.

template<class T>

casacore::Cube< T >::Cube	(	size_t	l1,
		size_t	l2,
		size_t	l3,
		const T &	initialValue
	)

A l1xl2xl3 sized cube.

Fill it with the initial value.

template<class T>

casacore::Cube< T >::Cube ( const IPosition & len )

A Cube where the shape ("len") is defined with IPositions.

template<class T>

casacore::Cube< T >::Cube	(	const IPosition &	len,
		ArrayInitPolicy	initPolicy
	)

A Cube where the shape ("len") is defined with IPositions.

template<class T>

casacore::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.

template<class T>

casacore::Cube< T >::Cube ( const Cube< T > & )

The copy constructor uses reference semantics.

template<class T>

casacore::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.

template<class T>

casacore::Cube< T >::Cube	(	const IPosition &	shape,
		T *	storage,
		StorageInitPolicy	policy = `COPY`
	)

Create an Cube of a given shape from a pointer.

template<class T>

casacore::Cube< T >::Cube	(	const IPosition &	shape,
		T *	storage,
		StorageInitPolicy	policy,
		AbstractAllocator< T > const &	allocator
	)

Create an Cube of a given shape from a pointer.

template<class T>

casacore::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.

template<class T>

virtual casacore::Cube< T >::~Cube ( ) [virtual]

Define a destructor, otherwise the (SUN) compiler makes a static one.

Member Function Documentation

template<class T>

virtual void casacore::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.

template<class T>

const T& casacore::Cube< T >::at	(	size_t	i1,
		size_t	i2,
		size_t	i3
	)			const `[inline]`

Definition at line 202 of file Cube.h.

template<class T>

T& casacore::Cube< T >::at	(	size_t	i1,
		size_t	i2,
		size_t	i3
	)			`[inline]`

Definition at line 193 of file Cube.h.

template<class T>

virtual void casacore::Cube< T >::doNonDegenerate	(	const 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.

template<class T>

void casacore::Cube< T >::makeIndexingConstants ( ) [private]

Helper fn to calculate the indexing constants.

template<class T>

size_t casacore::Cube< T >::ncolumn ( ) const [inline]

The number of columns in the Cube, i.e.

the length of the 2nd axis.

Definition at line 302 of file Cube.h.

template<class T>

size_t casacore::Cube< T >::nplane ( ) const [inline]

The number of planes in the Cube, i.e.

the length of the 3rd axis.

Definition at line 306 of file Cube.h.

template<class T>

size_t casacore::Cube< T >::nrow ( ) const [inline]

The number of rows in the Cube, i.e.

the length of the first axis.

Definition at line 298 of file Cube.h.

template<class T>

virtual Bool casacore::Cube< T >::ok ( ) const [virtual]

Checks that the cube is consistent (invariants check out).

const Array<T> casacore::Cube< T >::operator()	(	const IPosition &	blc,
		const IPosition &	trc
	)			const `[inline]`

Array<T> casacore::Cube< T >::operator()	(	const IPosition &	start,
		const IPosition &	end
	)			`[inline]`

const Cube<T> casacore::Cube< T >::operator()	(	const Slice &	sliceX,
		const Slice &	sliceY,
		const Slice &	sliceZ
	)			const

Cube<T> casacore::Cube< T >::operator()	(	const Slice &	sliceX,
		const Slice &	sliceY,
		const Slice &	sliceZ
	)

const T& casacore::Cube< T >::operator()	(	size_t	i1,
		size_t	i2,
		size_t	i3
	)			const `[inline]`

T& casacore::Cube< T >::operator()	(	size_t	i1,
		size_t	i2,
		size_t	i3
	)			`[inline]`

virtual void casacore::Cube< T >::resize	(	const IPosition &	newShape,
		Bool	copyValues,
		ArrayInitPolicy	policy
	)			`[virtual]`

void casacore::Cube< T >::resize	(	size_t	nx,
		size_t	ny,
		size_t	nz,
		Bool	copyValues,
		ArrayInitPolicy	policy
	)

void casacore::Cube< T >::shape	(	Int &	s1,
		Int &	s2,
		Int &	s3
	)			const `[inline]`

casacore::Cube< T > Class Template Reference

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<class T> class casacore::Cube< T >

Review Status

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class casacore::Cube< T >