casacore::PagedImage< T > Class Template Reference

Read, store, and manipulate astronomical images. More...

#include <PagedImage.h>

Inheritance diagram for casacore::PagedImage< T >:

Public Member Functions
	PagedImage (const TiledShape &mapShape, const CoordinateSystem &coordinateInfo, Table &table, uInt rowNumber=0)
	Construct a new Image from shape and coordinate information.
	PagedImage (const TiledShape &mapShape, const CoordinateSystem &coordinateInfo, const String &nameOfNewFile, uInt rowNumber=0)
	Construct a new Image from shape and coordinate information.
	PagedImage (const TiledShape &mapShape, const CoordinateSystem &coordinateInfo, const String &nameOfNewFile, TableLock::LockOption, uInt rowNumber=0)
	Construct a new Image from shape and coordinate information.
	PagedImage (const TiledShape &mapShape, const CoordinateSystem &coordinateInfo, const String &nameOfNewFile, const TableLock &lockOptions, uInt rowNumber=0)
	PagedImage (Table &table, MaskSpecifier=MaskSpecifier(), uInt rowNumber=0)
	Reconstruct an image from a pre-existing file.
	PagedImage (const String &filename, MaskSpecifier=MaskSpecifier(), uInt rowNumber=0)
	Reconstruct an image from a pre-existing file.
	PagedImage (const String &filename, TableLock::LockOption, MaskSpecifier=MaskSpecifier(), uInt rowNumber=0)
	Reconstruct an image from a pre-existing file with Locking.
	PagedImage (const String &filename, const TableLock &lockOptions, MaskSpecifier=MaskSpecifier(), uInt rowNumber=0)
	PagedImage (const PagedImage< T > &other)
	Copy constructor (reference semantics).
	~PagedImage ()
PagedImage< T > &	operator= (const PagedImage< T > &other)
	Assignment operator (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 this derived class).
virtual Bool	isPersistent () const
	A PagedImage is always persistent.
virtual Bool	isPaged () const
	A PagedImage is always paged to disk.
virtual Bool	isWritable () const
	Is the PagedImage writable?
virtual Bool	hasPixelMask () const
	Does the image object use a pixelmask?
virtual const Lattice< Bool > &	pixelMask () const
	Get access to the pixelmask used.
virtual Lattice< Bool > &	pixelMask ()
virtual const LatticeRegion *	getRegionPtr () const
	Get a pointer the default pixelmask object used with this image.
virtual void	setDefaultMask (const String &maskName)
	Set the default pixelmask to the mask with the given name (which has to exist in the "masks" group).
virtual void	useMask (MaskSpecifier=MaskSpecifier())
	Use the mask as specified.
void	rename (const String &newName)
	Function to change the name of the Table file on disk.
virtual String	name (Bool stripPath=False) const
	Return the current Table name.
uInt	rowNumber () const
	Return the current TableColumn row number.
virtual IPosition	shape () const
	Return the shape of the image.
virtual void	resize (const TiledShape &newShape)
	Change the shape of the image (N.B.
virtual Bool	doGetSlice (Array< T > &buffer, const Slicer &theSlice)
	Function which extracts an array from the map.
virtual void	doPutSlice (const Array< T > &sourceBuffer, const IPosition &where, const IPosition &stride)
	Function to replace the values in the map with soureBuffer.
virtual void	apply (T(*function)(T))
	Replace every element, x, of the lattice with the result of f(x).
virtual void	apply (T(*function)(const T &))
virtual void	apply (const Functional< T, T > &function)
PagedImage< T > &	operator+= (const Lattice< T > &other)
	Add a lattice to this image.
virtual Bool	setUnits (const Unit &newUnits)
	Function which sets the units associated with the image pixels (i.e.
Table &	table ()
	Return the table holding the data.
virtual Bool	setCoordinateInfo (const CoordinateSystem &coords)
	Flushes the new coordinate system to disk if the table is writable.
virtual Bool	ok () const
	Check for symmetry in data members.
virtual T	getAt (const IPosition &where) const
	These are the true implementations of the paran operator.
virtual void	putAt (const T &value, const IPosition &where)
	Put the value of a single element.
virtual Bool	setMiscInfo (const RecordInterface &newInfo)
	Replace the miscinfo in the PagedImage.
virtual Bool	setImageInfo (const ImageInfo &info)
	The ImageInfo object contains some miscellaneous information about the image, which unlike that stored in MiscInfo, has a standard list of things, such as the restoring beam.
virtual ImageAttrHandler &	attrHandler (Bool createHandler=False)
	Get access to the attribute handler.
virtual void	removeRegion (const String &name, RegionHandler::GroupType=RegionHandler::Any, Bool throwIfUnknown=True)
	Remove a region/mask belonging to the image from the given group (which can be Any).
virtual LatticeIterInterface< T > *	makeIter (const LatticeNavigator &navigator, Bool useRef) const
	This is the implementation of the letter for the envelope Iterator class; Note: Not for public use ;.
virtual uInt	advisedMaxPixels () const
	Returns the maximum recommended number of pixels for a cursor.
virtual IPosition	doNiceCursorShape (uInt maxPixels) const
	Help the user pick a cursor for most efficient access.
virtual uInt	maximumCacheSize () const
	Maximum size - not necessarily all used.
virtual void	setMaximumCacheSize (uInt howManyPixels)
	Set the maximum (allowed) cache size as indicated.
virtual void	setCacheSizeFromPath (const IPosition &sliceShape, const IPosition &windowStart, const IPosition &windowLength, const IPosition &axisPath)
	Set the cache size as to "fit" the indicated path.
virtual void	setCacheSizeInTiles (uInt howManyTiles)
	Set the actual cache size for this Array to be be big enough for the indicated number of tiles.
virtual void	clearCache ()
	Clears and frees up the caches, but the maximum allowed cache size is unchanged from when setCacheSize was called.
virtual void	showCacheStatistics (ostream &os) const
	Report on cache success.
virtual Bool	lock (FileLocker::LockType, uInt nattempts)
	Handle the (un)locking.
virtual void	unlock ()
virtual Bool	hasLock (FileLocker::LockType) const
virtual void	resync ()
	Resynchronize the PagedImage object with the table contents.
virtual void	flush ()
	Flush the data.
virtual void	tempClose ()
	Close the Image and associated files temporarily.
virtual void	reopen ()
	If needed, reopen a temporarily closed Image.
Static Public Member Functions
static String	className ()
	Return the name of this derived class.
Private Member Functions
void	attach_logtable ()
	This must be called in every constructor and place where the image is attached to a new image.
void	open_logtable ()
void	restoreUnits (const TableRecord &rec)
void	restoreMiscInfo (const TableRecord &rec)
void	restoreImageInfo (const TableRecord &rec)
void	restoreAll (const TableRecord &rec)
void	check_conformance (const Lattice< T > &other)
void	reopenRW ()
void	setTableType ()
void	applyMaskSpecifier (const MaskSpecifier &)
void	applyMask (const String &maskName)
void	makePagedImage (const TiledShape &mapShape, const CoordinateSystem &coordinateInfo, const String &nameOfNewFile, const TableLock &lockOptions, uInt rowNumber)
void	makePagedImage (const String &filename, const TableLock &lockOptions, const MaskSpecifier &, uInt rowNumber)
const Table &	table () const
Static Private Member Functions
static Table &	getTable (void *imagePtr, Bool writable)
	Function to return the internal Table object to the RegionHandler.
Private Attributes
PagedArray< T >	map_p
LatticeRegion *	regionPtr_p
ImageAttrHandlerCasa	itsAttrHandler

Detailed Description

template<class T>
class casacore::PagedImage< T >

Read, store, and manipulate astronomical images.

Intended use:

Public interface

Review Status

Test programs:: tPagedmage
Demo programs:: dPagedImage

Prerequisite

Etymology

The PagedImage name comes from its role as the Image class with paging from persistent memory. Users are thus invited to treat the PagedImage instances like Casacore Lattices

Synopsis

All Casacore Images are Lattices. They may be treated like any other Lattice; getSlice(...), putSlice(...), LatticeIterator for iterating, etc. ArrayImages contain a map, a mask for that map, and coordinate information. This provides a Lattice interface for images and their respective coordinates. Additional functionality is defined by the ImageInterface class.

You can use the global function imagePixelType to determine what the pixel type of an image is before you open the image if your code can work with Images of many possible types, or for error checking.

Example

This example shows how to create a mask for an image, fill it, and make it known to the image.

 // Open the image (as readonly for the moment).
 PagedImage<Float> myimage ("image.name");
 // Create a mask for the image.
 // The mask will be stored in a subtable of the image.
 LCPagedMask mask (RegionHandler::makeMask (myimage, "mask.name"));
 // Fill the mask with whatever values (e.g. all True).
 mask.set (True);
 // Make the mask known to the image (with name mask1).
 myimage.defineRegion ("mask1", mask, RegionHandler::Masks);
 // Make the mask the default mask for this image.
 myimage.setDefaultMask ("mask1");

It is possible to create as many masks as one likes. They can all be defined as masks for the image (with different names, of course). However, only one of them can be the default mask (the mask used by default when the image is opened). When another mask has to be used, one can do two things:

Use setDefaultMask to make the other mask the default mask. This is advisable when the change should be more or less permanent.
Open the PagedImage without using a default mask. Thereafter a SubImage object can be created from the PagedImage and the mask. This is advisable when it the mask has to be used only one time.

Motivation

The size of astronomical data can be very large. The ability to fit an entire image into random access memory cannot be guaranteed. Paging from disk pieces of the image appeared to be the way to deal with this problem.

Note: When you make a new PagedImage, and you are transferring information from some other PagedImage, be aware that you must copy, manually, things like miscInfo, imageInfo, units, logSink (history) to the new file;

To Do

The CoordinateSystem::store() function returns a TableRecord. That TableRecord should be stored in the same row as our image. This will allow ImageStack members to have their own coordinate frames.

Definition at line 135 of file PagedImage.h.

Constructor & Destructor Documentation

template<class T>

casacore::PagedImage< T >::PagedImage	(	const TiledShape &	mapShape,
		const CoordinateSystem &	coordinateInfo,
		Table &	table,
		uInt	rowNumber = `0`
	)

Construct a new Image from shape and coordinate information.

Data will be stored in the argument table.

template<class T>

casacore::PagedImage< T >::PagedImage	(	const TiledShape &	mapShape,
		const CoordinateSystem &	coordinateInfo,
		const String &	nameOfNewFile,
		uInt	rowNumber = `0`
	)

Construct a new Image from shape and coordinate information.

Table will be stored in the named file.

template<class T>

casacore::PagedImage< T >::PagedImage	(	const TiledShape &	mapShape,
		const CoordinateSystem &	coordinateInfo,
		const String &	nameOfNewFile,
		TableLock::LockOption	,
		uInt	rowNumber = `0`
	)

Construct a new Image from shape and coordinate information.

Table will be stored in the named file. The lock options may be specified

template<class T>

casacore::PagedImage< T >::PagedImage	(	const TiledShape &	mapShape,
		const CoordinateSystem &	coordinateInfo,
		const String &	nameOfNewFile,
		const TableLock &	lockOptions,
		uInt	rowNumber = `0`
	)

template<class T>

casacore::PagedImage< T >::PagedImage	(	Table &	table,
		MaskSpecifier	= `MaskSpecifier()`,
		uInt	rowNumber = `0`
	)			`[explicit]`

Reconstruct an image from a pre-existing file.

By default the default pixelmask (if available) is used.

template<class T>

casacore::PagedImage< T >::PagedImage	(	const String &	filename,
		MaskSpecifier	= `MaskSpecifier()`,
		uInt	rowNumber = `0`
	)			`[explicit]`

Reconstruct an image from a pre-existing file.

By default the default pixelmask (if available) is used.

template<class T>

casacore::PagedImage< T >::PagedImage	(	const String &	filename,
		TableLock::LockOption	,
		MaskSpecifier	= `MaskSpecifier()`,
		uInt	rowNumber = `0`
	)

Reconstruct an image from a pre-existing file with Locking.

By default the default pixelmask (if available) is used.

template<class T>

casacore::PagedImage< T >::PagedImage	(	const String &	filename,
		const TableLock &	lockOptions,
		MaskSpecifier	= `MaskSpecifier()`,
		uInt	rowNumber = `0`
	)

template<class T>

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

Copy constructor (reference semantics).

template<class T>

casacore::PagedImage< T >::~PagedImage ( )

Member Function Documentation

template<class T>

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

Returns the maximum recommended number of pixels for a cursor.

This is the number of pixels in a tile.

Reimplemented from casacore::Lattice< T >.

template<class T>

virtual void casacore::PagedImage< T >::apply ( const Functional< T, T > & function ) [virtual]

Reimplemented from casacore::Lattice< T >.

template<class T>

virtual void casacore::PagedImage< T >::apply ( T(*)(const T &) function ) [virtual]

Reimplemented from casacore::Lattice< T >.

template<class T>

virtual void casacore::PagedImage< T >::apply ( T(*)(T) function ) [virtual]

Replace every element, x, of the lattice with the result of f(x).

you must pass in the address of the function -- so the function must be declared and defined in the scope of your program. Both versions of apply require a function that accepts a single argument of type T (the Lattice template actual type) and returns a result of the same type. The first apply expects a function with an argument passed by value; the second expects the argument to be passed by const reference. The first form ought to run faster for the built-in types, which may be an issue for large Lattices stored in memory, where disk access is not an issue.

Reimplemented from casacore::Lattice< T >.

template<class T>

void casacore::PagedImage< T >::applyMask ( const String & maskName ) [private]

template<class T>

void casacore::PagedImage< T >::applyMaskSpecifier ( const MaskSpecifier & ) [private]

template<class T>

void casacore::PagedImage< T >::attach_logtable ( ) [private]

This must be called in every constructor and place where the image is attached to a new image.

template<class T>

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

Get access to the attribute handler.

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>

void casacore::PagedImage< T >::check_conformance ( const Lattice< T > & other ) [private]

template<class T>

static String casacore::PagedImage< T >::className ( ) [inline, static]

Return the name of this derived class.

Definition at line 199 of file PagedImage.h.

template<class T>

virtual void casacore::PagedImage< T >::clearCache ( ) [virtual]

Clears and frees up the caches, but the maximum allowed cache size is unchanged from when setCacheSize was called.

Reimplemented from casacore::LatticeBase.

template<class T>

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

Make a copy of the object (reference semantics).

Implements casacore::ImageInterface< T >.

template<class T>

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

Function which extracts an array from the map.

Implements casacore::Lattice< T >.

template<class T>

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

Help the user pick a cursor for most efficient access.

Reimplemented from casacore::LatticeBase.

template<class T>

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

Function to replace the values in the map with soureBuffer.

Implements casacore::Lattice< T >.

template<class T>

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

Flush the data.

Reimplemented from casacore::LatticeBase.

template<class T>

virtual T casacore::PagedImage< T >::getAt ( const IPosition & where ) const [virtual]

These are the true implementations of the paran operator.

Note: Not for public use

Reimplemented from casacore::Lattice< T >.

template<class T>

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

Get a pointer the default pixelmask object used with this image.

It returns 0 if no default pixelmask is used.

Implements casacore::MaskedLattice< T >.

template<class T>

static Table& casacore::PagedImage< T >::getTable	(	void *	imagePtr,
		Bool	writable
	)			`[static, private]`

Function to return the internal Table object to the RegionHandler.

template<class T>

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

Reimplemented from casacore::LatticeBase.

template<class T>

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

Does the image object use a pixelmask?

Reimplemented from casacore::MaskedLattice< T >.

template<class T>

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

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

Implements casacore::ImageInterface< T >.

template<class T>

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

A PagedImage is always paged to disk.

Reimplemented from casacore::LatticeBase.

template<class T>

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

A PagedImage is always persistent.

Reimplemented from casacore::LatticeBase.

template<class T>

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

Is the PagedImage writable?

Reimplemented from casacore::LatticeBase.

template<class T>

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

Handle the (un)locking.

Unlocking also unlocks the logtable and a possible mask table. Locking only locks the image itself.

Reimplemented from casacore::LatticeBase.

template<class T>

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

This is the implementation of the letter for the envelope Iterator class;
Note: Not for public use
;.

Reimplemented from casacore::Lattice< T >.

template<class T>

void casacore::PagedImage< T >::makePagedImage	(	const String &	filename,
		const TableLock &	lockOptions,
		const MaskSpecifier &	,
		uInt	rowNumber
	)			`[private]`

template<class T>

void casacore::PagedImage< T >::makePagedImage	(	const TiledShape &	mapShape,
		const CoordinateSystem &	coordinateInfo,
		const String &	nameOfNewFile,
		const TableLock &	lockOptions,
		uInt	rowNumber
	)			`[private]`

template<class T>

virtual uInt casacore::PagedImage< T >::maximumCacheSize ( ) const [virtual]

Maximum size - not necessarily all used.

In pixels.

Reimplemented from casacore::LatticeBase.

template<class T>

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

Return the current Table name.

By default this includes the full path. the path preceding the file name can be stripped off on request.

Implements casacore::ImageInterface< T >.

template<class T>

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

Check for symmetry in data members.

Implements casacore::ImageInterface< T >.

template<class T>

void casacore::PagedImage< T >::open_logtable ( ) [private]

template<class T>

PagedImage<T>& casacore::PagedImage< T >::operator+= ( const Lattice< T > & other )

Add a lattice to this image.

template<class T>

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

Assignment operator (reference semantics).

Reimplemented from casacore::ImageInterface< T >.

template<class T>

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

Reimplemented from casacore::MaskedLattice< T >.

template<class T>

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

Get access to the pixelmask used.

An exception is thrown if the image does not use a pixelmask.

Reimplemented from casacore::MaskedLattice< T >.

template<class T>

virtual void casacore::PagedImage< T >::putAt	(	const T &	value,
		const IPosition &	where
	)			`[virtual]`

Put the value of a single element.

The default implementation uses putSlice.

Reimplemented from casacore::Lattice< T >.

template<class T>

virtual void casacore::PagedImage< T >::removeRegion	(	const String &	name,
		RegionHandler::GroupType	= `RegionHandler::Any`,
		Bool	throwIfUnknown = `True`
	)			`[virtual]`

Remove a region/mask belonging to the image from the given group (which can be Any).

If a mask removed is the default mask, the image gets unmasked.
Optionally an exception is thrown if the region does not exist.

Reimplemented from casacore::ImageInterface< T >.

template<class T>

void casacore::PagedImage< T >::rename ( const String & newName )

Function to change the name of the Table file on disk.

PagedImage is given a file name at construction time. You may change that name here.

template<class T>

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

If needed, reopen a temporarily closed Image.

Reimplemented from casacore::LatticeBase.

template<class T>

void casacore::PagedImage< T >::reopenRW ( ) [private]

template<class T>

virtual void casacore::PagedImage< T >::resize ( const TiledShape & newShape ) [virtual]

Change the shape of the image (N.B.

the data is thrown away).

Implements casacore::ImageInterface< T >.

template<class T>

void casacore::PagedImage< T >::restoreAll ( const TableRecord & rec ) [private]

template<class T>

void casacore::PagedImage< T >::restoreImageInfo ( const TableRecord & rec ) [private]

template<class T>

void casacore::PagedImage< T >::restoreMiscInfo ( const TableRecord & rec ) [private]

template<class T>

void casacore::PagedImage< T >::restoreUnits ( const TableRecord & rec ) [private]

template<class T>

virtual void casacore::PagedImage< T >::resync ( ) [virtual]

Resynchronize the PagedImage object with the table contents.

The logtable and possible mask table are also synchronized if they do not have a readlock.
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.

Reimplemented from casacore::LatticeBase.

template<class T>

uInt casacore::PagedImage< T >::rowNumber ( ) const

Return the current TableColumn row number.

template<class T>

virtual void casacore::PagedImage< T >::setCacheSizeFromPath	(	const IPosition &	sliceShape,
		const IPosition &	windowStart,
		const IPosition &	windowLength,
		const IPosition &	axisPath
	)			`[virtual]`

Set the cache size as to "fit" the indicated path.

Reimplemented from casacore::LatticeBase.

template<class T>

virtual void casacore::PagedImage< T >::setCacheSizeInTiles ( uInt howManyTiles ) [virtual]

Set the actual cache size for this Array to be be big enough for the indicated number of tiles.

This cache is not shared with PagedArrays in other rows and is always clipped to be less than the maximum value set using the setMaximumCacheSize member function. tiles. Tiles are cached using a first in first out algorithm.

Reimplemented from casacore::LatticeBase.

template<class T>

virtual Bool casacore::PagedImage< T >::setCoordinateInfo ( const CoordinateSystem & coords ) [virtual]

Flushes the new coordinate system to disk if the table is writable.

Reimplemented from casacore::ImageInterface< T >.

template<class T>

virtual void casacore::PagedImage< T >::setDefaultMask ( const String & maskName ) [virtual]

Set the default pixelmask to the mask with the given name (which has to exist in the "masks" group).

If the image table is writable, the setting is persistent by writing the name as a keyword. If the given regionName is the empty string, the default pixelmask is unset.

Reimplemented from casacore::ImageInterface< T >.

template<class T>

virtual Bool casacore::PagedImage< T >::setImageInfo ( const ImageInfo & info ) [virtual]

The ImageInfo object contains some miscellaneous information about the image, which unlike that stored in MiscInfo, has a standard list of things, such as the restoring beam.

Note that setImageInfo REPLACES the information with the new information. It can fail if, e.g., the underlying table is not writable.

Reimplemented from casacore::ImageInterface< T >.

template<class T>

virtual void casacore::PagedImage< T >::setMaximumCacheSize ( uInt howManyPixels ) [virtual]