casacore::ExtendImage< T > Class Template Reference

An extension of an ImageInterface object. More...

#include <ExtendImage.h>

Inheritance diagram for casacore::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 ImageAttrHandler &	attrHandler (Bool createHandler=False)
	Get access to the attribute handler (of the parent image).
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
PtrHolder< ImageInterface< T > >	itsImagePtr
PtrHolder< ExtendLattice< T > >	itsExtLatPtr

Detailed Description

template<class T>
class casacore::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 77 of file ExtendImage.h.

Constructor & Destructor Documentation

template<class T>

casacore::ExtendImage< T >::ExtendImage ( )

The default constructor.

template<class T>

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

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

Copy constructor (reference semantics).

template<class T>

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

Member Function Documentation

template<class T>

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

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

Reimplemented from casacore::Lattice< T >.

template<class T>

virtual ImageAttrHandler& casacore::ExtendImage< T >::attrHandler ( Bool createHandler = False ) [virtual]

Get access to the attribute handler (of the parent image).

If a handler keyword does not exist yet, it is created if createHandler is set. Otherwise the handler is empty and no groups can be created for it.

Reimplemented from casacore::ImageInterface< T >.

template<class T>

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

Make a copy of the object (reference semantics).

Implements casacore::ImageInterface< T >.

template<class T>

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

Get a section of the mask.

Reimplemented from casacore::MaskedLattice< T >.

template<class T>

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

Do the actual getting of an array of values.

Implements casacore::Lattice< T >.

template<class T>

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

Get the best cursor shape.

Reimplemented from casacore::LatticeBase.

template<class T>

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

Putting data is not possible.

Implements casacore::Lattice< T >.

template<class T>

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

Flush the data (but do not unlock).

By default the function does not do anything at all.

Reimplemented from casacore::LatticeBase.

template<class T>

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

Get the region used (always returns 0).

Implements casacore::MaskedLattice< T >.

template<class T>

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

Reimplemented from casacore::LatticeBase.

template<class T>

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

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

Reimplemented from casacore::MaskedLattice< T >.

template<class T>

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

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

Implements casacore::ImageInterface< T >.

template<class T>

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

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

Reimplemented from casacore::MaskedLattice< T >.

template<class T>

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

Is the ExtendImage paged to disk?

Reimplemented from casacore::LatticeBase.

template<class T>

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

A ExtendImage is not persistent.

Reimplemented from casacore::LatticeBase.

template<class T>

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

An ExtendImage is not writable.

Reimplemented from casacore::LatticeBase.

template<class T>

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

Handle the (un)locking and syncing, etc.

Reimplemented from casacore::LatticeBase.

template<class T>

virtual LatticeIterInterface<T>* casacore::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 casacore::Lattice< T >.

template<class T>

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

Return the name of the parent ImageInterface object.

Implements casacore::ImageInterface< T >.

template<class T>

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

Check class invariants.

Implements casacore::ImageInterface< T >.

template<class T>

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

Assignment (reference semantics).

Reimplemented from casacore::ImageInterface< T >.

template<class T>

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

Reimplemented from casacore::MaskedLattice< T >.

template<class T>

virtual const Lattice<Bool>& casacore::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 casacore::MaskedLattice< T >.

template<class T>

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

Explicitly reopen the temporarily closed lattice.

By default the function does not do anything at all.

Reimplemented from casacore::LatticeBase.

template<class T>

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

template<class T>

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

template<class T>

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

Returns the shape of the ExtendImage.

Implements casacore::LatticeBase.

template<class T>

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

template<class T>

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