An extension of an ImageInterface object. More...

#include <ExtendImage.h>

Inheritance diagram for casa::ExtendImage< T >:

Public Member Functions
	ExtendImage ()
	The default constructor.
	ExtendImage (const ImageInterface< T > &image, const IPosition &newShape, const CoordinateSystem &newCsys)
	Create a ExtendImage from a Image.
	ExtendImage (const ExtendImage< T > &other)
	Copy constructor (reference semantics).
virtual	~ExtendImage ()
ExtendImage< T > &	operator= (const ExtendImage< T > &other)
	Assignment (reference semantics).
virtual ImageInterface< T > *	cloneII () const
	Make a copy of the object (reference semantics).
virtual String	imageType () const
	Get the image type (returns name of derived class).
virtual Bool	isMasked () const
	Is the ExtendImage masked? It is if its parent image is masked.
virtual Bool	hasPixelMask () const
	Does the image object have a pixelmask? It does if its parent has a pixelmask.
virtual const Lattice< Bool > &	pixelMask () const
	Get access to the pixelmask in use (thus to the pixelmask of the parent).
virtual Lattice< Bool > &	pixelMask ()
virtual const LatticeRegion *	getRegionPtr () const
	Get the region used (always returns 0).
virtual Bool	isPersistent () const
	A ExtendImage is not persistent.
virtual Bool	isPaged () const
	Is the ExtendImage paged to disk?
virtual Bool	isWritable () const
	An ExtendImage is not writable.
virtual IPosition	shape () const
	Returns the shape of the ExtendImage.
virtual uInt	advisedMaxPixels () const
	This function returns the recommended maximum number of pixels to include in the cursor of an iterator.
virtual void	resize (const TiledShape &newShape)
	Function which changes the shape of the ExtendImage.
virtual String	name (Bool stripPath=False) const
	Return the name of the parent ImageInterface object.
virtual Bool	ok () const
	Check class invariants.
virtual Bool	doGetSlice (Array< T > &buffer, const Slicer &section)
	Do the actual getting of an array of values.
virtual void	doPutSlice (const Array< T > &sourceBuffer, const IPosition &where, const IPosition &stride)
	Putting data is not possible.
virtual Bool	doGetMaskSlice (Array< Bool > &buffer, const Slicer &section)
	Get a section of the mask.
virtual LatticeIterInterface< T > *	makeIter (const LatticeNavigator &navigator, Bool useRef) const
	This function is used by the LatticeIterator class to generate an iterator of the correct type for this Lattice.
virtual IPosition	doNiceCursorShape (uInt maxPixels) const
	Get the best cursor shape.
virtual Bool	lock (FileLocker::LockType, uInt nattempts)
	Handle the (un)locking and syncing, etc.
virtual void	unlock ()
virtual Bool	hasLock (FileLocker::LockType) const
virtual void	resync ()
	Resynchronize the Lattice object with the lattice file.
virtual void	flush ()
	Flush the data (but do not unlock).
virtual void	tempClose ()
	Temporarily close the lattice.
virtual void	reopen ()
	Explicitly reopen the temporarily closed lattice.
Private Attributes
ImageInterface< T > *	itsImagePtr

ExtendLattice< T > *	itsExtLatPtr

Detailed Description

template<class T>
class casa::ExtendImage< T >

An extension of an ImageInterface object.

Intended use:

Public interface

Review Status

Test programs:: tExtendImage

Prerequisite

Synopsis

Class ExtendImage can be used to (virtually) extend an image along axes with length 1 and/or to add new axes. In this way such an image can be made conformant with another image. E.g. it can be used to extend the continuum channel to subtract it from each channel in an image cube.

Example

Motivation

Used by LEL to handle images with different dimensionalities.

Definition at line 76 of file ExtendImage.h.

Constructor & Destructor Documentation

template<class T>

casa::ExtendImage< T >::ExtendImage ( )

The default constructor.

template<class T>

casa::ExtendImage< T >::ExtendImage	(	const ImageInterface< T > &	image,
		const IPosition &	newShape,
		const CoordinateSystem &	newCsys
	)

Create a ExtendImage from a Image.

The coordinate system of the given image should be a subset of the new coordinate system. The same is true for the shape.

template<class T>

casa::ExtendImage< T >::ExtendImage ( const ExtendImage< T > & other )

Copy constructor (reference semantics).

template<class T>

virtual casa::ExtendImage< T >::~ExtendImage ( ) [virtual]

Member Function Documentation

template<class T>

virtual uInt casa::ExtendImage< T >::advisedMaxPixels ( ) const [virtual]

This function returns the recommended maximum number of pixels to include in the cursor of an iterator.

Reimplemented from casa::Lattice< T >.

template<class T>

virtual ImageInterface<T>* casa::ExtendImage< T >::cloneII ( ) const [virtual]

Make a copy of the object (reference semantics).

Implements casa::ImageInterface< T >.

template<class T>

virtual Bool casa::ExtendImage< T >::doGetMaskSlice	(	Array< Bool > &	buffer,
		const Slicer &	section
	)		`[virtual]`

Get a section of the mask.

Reimplemented from casa::MaskedLattice< T >.

template<class T>

virtual Bool casa::ExtendImage< T >::doGetSlice	(	Array< T > &	buffer,
		const Slicer &	section
	)		`[virtual]`

Do the actual getting of an array of values.

Implements casa::Lattice< T >.

template<class T>

virtual IPosition casa::ExtendImage< T >::doNiceCursorShape ( uInt maxPixels ) const [virtual]

Get the best cursor shape.

Reimplemented from casa::LatticeBase.

template<class T>

virtual void casa::ExtendImage< T >::doPutSlice	(	const Array< T > &	sourceBuffer,
		const IPosition &	where,
		const IPosition &	stride
	)		`[virtual]`

Putting data is not possible.

Implements casa::Lattice< T >.

template<class T>

virtual void casa::ExtendImage< T >::flush ( ) [virtual]

Flush the data (but do not unlock).

By default the function does not do anything at all.

Reimplemented from casa::LatticeBase.

template<class T>

virtual const LatticeRegion* casa::ExtendImage< T >::getRegionPtr ( ) const [virtual]

Get the region used (always returns 0).

Implements casa::MaskedLattice< T >.

template<class T>

virtual Bool casa::ExtendImage< T >::hasLock ( FileLocker::LockType ) const [virtual]

Reimplemented from casa::LatticeBase.

template<class T>

virtual Bool casa::ExtendImage< T >::hasPixelMask ( ) const [virtual]

Does the image object have a pixelmask? It does if its parent has a pixelmask.

Reimplemented from casa::MaskedLattice< T >.

template<class T>

virtual String casa::ExtendImage< T >::imageType ( ) const [virtual]

Get the image type (returns name of derived class).

Implements casa::ImageInterface< T >.

template<class T>

virtual Bool casa::ExtendImage< T >::isMasked ( ) const [virtual]

Is the ExtendImage masked? It is if its parent image is masked.

Reimplemented from casa::MaskedLattice< T >.

template<class T>

virtual Bool casa::ExtendImage< T >::isPaged ( ) const [virtual]

Is the ExtendImage paged to disk?

Reimplemented from casa::LatticeBase.

template<class T>

virtual Bool casa::ExtendImage< T >::isPersistent ( ) const [virtual]

A ExtendImage is not persistent.

Reimplemented from casa::LatticeBase.

template<class T>

virtual Bool casa::ExtendImage< T >::isWritable ( ) const [virtual]

An ExtendImage is not writable.

Reimplemented from casa::LatticeBase.

template<class T>

virtual Bool casa::ExtendImage< T >::lock	(	FileLocker::LockType	,
		uInt	nattempts
	)		`[virtual]`

Handle the (un)locking and syncing, etc.

Reimplemented from casa::LatticeBase.

template<class T>

virtual LatticeIterInterface<T>* casa::ExtendImage< T >::makeIter	(	const LatticeNavigator &	navigator,
		Bool	useRef
	)		const `[virtual]`

This function is used by the LatticeIterator class to generate an iterator of the correct type for this Lattice.

Not recommended for general use.

Reimplemented from casa::Lattice< T >.

template<class T>

virtual String casa::ExtendImage< T >::name ( Bool stripPath = False ) const [virtual]

Return the name of the parent ImageInterface object.

Implements casa::ImageInterface< T >.

template<class T>

virtual Bool casa::ExtendImage< T >::ok ( ) const [virtual]

Check class invariants.

Implements casa::ImageInterface< T >.

template<class T>

ExtendImage<T>& casa::ExtendImage< T >::operator= ( const ExtendImage< T > & other )

Assignment (reference semantics).

template<class T>

virtual const Lattice<Bool>& casa::ExtendImage< T >::pixelMask ( ) const [virtual]

Get access to the pixelmask in use (thus to the pixelmask of the parent).

An exception is thrown if the parent does not have a pixelmask.

Reimplemented from casa::MaskedLattice< T >.

template<class T>

virtual Lattice<Bool>& casa::ExtendImage< T >::pixelMask ( ) [virtual]

Reimplemented from casa::MaskedLattice< T >.

template<class T>

virtual void casa::ExtendImage< T >::reopen ( ) [virtual]

Explicitly reopen the temporarily closed lattice.

By default the function does not do anything at all.

Reimplemented from casa::LatticeBase.

template<class T>

virtual void casa::ExtendImage< T >::resize ( const TiledShape & newShape ) [virtual]

Function which changes the shape of the ExtendImage.

Throws an exception as resizing an ExtendImage is not possible.

Implements casa::ImageInterface< T >.

template<class T>

virtual void casa::ExtendImage< T >::resync ( ) [virtual]

Resynchronize the Lattice object with the lattice file.

This function is only useful if no read-locking is used, ie. if the table lock option is UserNoReadLocking or AutoNoReadLocking. In that cases the table system does not acquire a read-lock, thus does not synchronize itself automatically.
By default the function does not do anything at all.

Reimplemented from casa::LatticeBase.

template<class T>

virtual IPosition casa::ExtendImage< T >::shape ( ) const [virtual]

Returns the shape of the ExtendImage.

Implements casa::LatticeBase.

template<class T>

virtual void casa::ExtendImage< T >::tempClose ( ) [virtual]

Temporarily close the lattice.

It will be reopened automatically on the next access.
By default the function does not do anything at all.

Reimplemented from casa::LatticeBase.

template<class T>

virtual void casa::ExtendImage< T >::unlock ( ) [virtual]

Reimplemented from casa::LatticeBase.

Member Data Documentation

template<class T>

ExtendLattice<T>* casa::ExtendImage< T >::itsExtLatPtr [private]

Definition at line 184 of file ExtendImage.h.

template<class T>

ImageInterface<T>* casa::ExtendImage< T >::itsImagePtr [private]

Definition at line 183 of file ExtendImage.h.

The documentation for this class was generated from the following file:

casacore/images/Images/ExtendImage.h

Public Member Functions

Private Attributes

Detailed Description

template<class T> class casa::ExtendImage< T >

Intended use:

Review Status

Prerequisite

Synopsis

Example

Motivation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class casa::ExtendImage< T >