Rebin an image. More...

#include <RebinImage.h>

Public Member Functions
	RebinImage ()
	Default constructor (object useless) More...

	RebinImage (const ImageInterface< T > &, const IPosition &factors)
	Constructor. More...

	RebinImage (const RebinImage< T > &other)
	Copy constructor (reference semantics). More...

virtual	~RebinImage ()

RebinImage< T > &	operator= (const RebinImage< T > &other)
	Assignment (reference semantics). More...

virtual ImageInterface< T > *	cloneII () const
	Make a copy of the object (reference semantics). More...

virtual String	imageType () const
	Get the image type (returns name of derived class). More...

virtual Bool	isMasked () const
	Is the RebinImage masked? It is if its parent image is masked. More...

virtual Bool	hasPixelMask () const
	Does the image object have a pixelmask? It does if its parent has a pixelmask. More...

virtual const Lattice< Bool > &	pixelMask () const
	Get access to the pixelmask in use (thus to the pixelmask of the parent). More...

virtual Lattice< Bool > &	pixelMask ()

virtual const LatticeRegion *	getRegionPtr () const
	Get the region used (always returns 0). More...

virtual Bool	isPersistent () const
	A RebinImage is not persistent. More...

virtual Bool	isPaged () const
	Is the RebinImage paged to disk? More...

virtual Bool	isWritable () const
	An RebinImage is not writable. More...

virtual IPosition	shape () const
	Returns the shape of the RebinImage. More...

virtual uInt	advisedMaxPixels () const
	This function returns the recommended maximum number of pixels to include in the cursor of an iterator. More...

virtual void	resize (const TiledShape &newShape)
	Function which changes the shape of the RebinImage. More...

virtual String	name (Bool stripPath=False) const
	Return the name of the parent ImageInterface object. More...

virtual Bool	ok () const
	Check class invariants. More...

virtual ImageAttrHandler &	attrHandler (Bool createHandler=False)
	Get access to the attribute handler (of the parent image). More...

virtual Bool	doGetSlice (Array< T > &buffer, const Slicer &section)
	Do the actual getting of an array of values. More...

virtual void	doPutSlice (const Array< T > &sourceBuffer, const IPosition &where, const IPosition &stride)
	Putting data is not possible as the lattice is not writable. More...

virtual Bool	doGetMaskSlice (Array< Bool > &buffer, const Slicer &section)
	Get a section of the mask. More...

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. More...

virtual IPosition	doNiceCursorShape (uInt maxPixels) const
	Get the best cursor shape. More...

virtual Bool	lock (FileLocker::LockType, uInt nattempts)
	Handle the (un)locking and syncing, etc. More...

virtual void	unlock ()

virtual Bool	hasLock (FileLocker::LockType) const

virtual void	resync ()

virtual void	flush ()

virtual void	tempClose ()

virtual void	reopen ()

Public Member Functions inherited from casacore::ImageInterface< T >
	ImageInterface ()

	ImageInterface (const RegionHandler &regionHandler)
	Construct for a specific region handler object. More...

	ImageInterface (const ImageInterface &other)
	Copy constructor (copy semantics). More...

virtual	~ImageInterface ()

virtual MaskedLattice< T > *	cloneML () const
	Make a copy of the derived object (reference semantics). More...

virtual Bool	setUnits (const Unit &newUnits)
	Function which get and set the units associated with the image pixels (i.e. More...

virtual const Unit &	units () const

virtual Bool	setCoordinateInfo (const CoordinateSystem &coords)
	Functions to set or replace the coordinate information in the Image Returns False on failure, e.g. More...

const CoordinateSystem &	coordinates () const

virtual LELCoordinates	lelCoordinates () const
	Function to get a LELCoordinate object containing the coordinates. More...

LoggerHolder &	logger ()
	Get access to the LoggerHolder. More...

const LoggerHolder &	logger () const

LogIO &	logSink ()
	Allow messages to be logged to this ImageInterface. More...

const LogIO &	logSink () const

void	appendLog (const LoggerHolder &other)
	Add the messages from the other image logger to this one. More...

const TableRecord &	miscInfo () const
	Often we have miscellaneous information we want to attach to an image. More...

virtual Bool	setMiscInfo (const RecordInterface &newInfo)

const ImageInfo &	imageInfo () const
	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. More...

ImageInfo &	rwImageInfo ()
	Get non-const access to the ImageInfo. More...

virtual Bool	setImageInfo (const ImageInfo &info)

ImageAttrHandler &	roAttrHandler () const

Bool	canDefineRegion () const
	Can the image handle region definition? More...

virtual ImageRegion	makeMask (const String &name, Bool defineAsRegion=True, Bool setAsDefaultMask=True, Bool initialize=False, Bool value=True)
	Make a mask which is suitable for the type of image. More...

virtual void	defineRegion (const String &name, const ImageRegion &region, RegionHandler::GroupType, Bool overwrite=False)
	Define a region/mask belonging to the image. More...

virtual Bool	hasRegion (const String &regionName, RegionHandler::GroupType=RegionHandler::Any) const
	Does the image have a region with the given name? More...

virtual ImageRegion *	getImageRegionPtr (const String &name, RegionHandler::GroupType=RegionHandler::Any, Bool throwIfUnknown=True) const
	Get a region/mask belonging to the image from the given group (which can be Any). More...

virtual void	renameRegion (const String &newName, const String &oldName, RegionHandler::GroupType=RegionHandler::Any, Bool overwrite=False)
	Rename a region. More...

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). More...

virtual Vector< String >	regionNames (RegionHandler::GroupType=RegionHandler::Any) const
	Get the names of all regions/masks. More...

virtual void	useMask (MaskSpecifier=MaskSpecifier())
	Use the mask as specified. More...

virtual void	setDefaultMask (const String &regionName)
	Set the default pixelmask to the mask with the given name (which has to exist in the "masks" group). More...

virtual String	getDefaultMask () const
	Get the name of the default pixelmask. More...

ImageRegion	getRegion (const String &regionName, RegionHandler::GroupType=RegionHandler::Any) const
	Get a region belonging to the image. More...

String	makeUniqueRegionName (const String &rootName, uInt startNumber=1) const
	Make a unique region name from the given root name, thus make it such that the name is not already in use for a region or mask. More...

Bool	toRecord (String &error, RecordInterface &outRec)
	Save and restore an ImageInterface object to or from a state Record. More...

Bool	fromRecord (String &error, const RecordInterface &inRec)

Private Attributes
ImageInterface< T > *	itsImagePtr

RebinLattice< T > *	itsRebinPtr

Additional Inherited Members
Protected Member Functions inherited from casacore::ImageInterface< T >
ImageInterface &	operator= (const ImageInterface &other)
	Assignment (copy semantics) is only useful for derived classes. More...

Bool	restoreImageInfo (const RecordInterface &rec)
	Restore the image info from the record. More...

void	setLogMember (const LoggerHolder &logger)
	Set the image logger variable. More...

void	setImageInfoMember (const ImageInfo &imageInfo)
	Set the image info variable. More...

void	setCoordsMember (const CoordinateSystem &coords)
	Set the coordinate system variable. More...

void	setUnitMember (const Unit &unit)
	Set the unit variable. More...

void	setMiscInfoMember (const RecordInterface &rec)
	Set the miscinfo variable. More...

RegionHandler *	getRegionHandler ()
	Get access to the region handler. More...

Detailed Description

template<class T>
class casacore::RebinImage< T >

Rebin an image.

Intended use:

Public interface

Review Status

Test programs:: tRebinImage

Prerequisite

Synopsis

Class RebinImage can be used to rebin (data averaged over bin) an image by integer amounts per axis.

Example

IPosition factors(2,2,2);
PagedImage<Float> imageIn(String("myImage")):
RebinLattice<Float> rb(imageIn, factors);
IPosition shapeOut = rb.shape();
TiledShape tShapeOut(shapeOut);
TempImage<Float> imageOut(tShapeOut, rb.coordinates());
LatticeUtilities::copyDataAndMask(os, imageOut, rb);
ImageUtilities::copyMiscellaneous (imageOut, imageIn);

Motivation

Users like to rebin images...

Definition at line 82 of file RebinImage.h.

Constructor & Destructor Documentation

◆ RebinImage() [1/3]

template<class T >

casacore::RebinImage< T >::RebinImage ( )

Default constructor (object useless)

◆ RebinImage() [2/3]

template<class T >

casacore::RebinImage< T >::RebinImage	(	const ImageInterface< T > &	,
		const IPosition &	factors
	)

Constructor.

The bin factors don't have to be integral. Anything left over at the end is treated as a full bin.

◆ RebinImage() [3/3]

template<class T >

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

Copy constructor (reference semantics).

◆ ~RebinImage()

template<class T >

virtual casacore::RebinImage< T >::~RebinImage ( )

virtual

Member Function Documentation

◆ advisedMaxPixels()

template<class T >

virtual uInt casacore::RebinImage< T >::advisedMaxPixels ( ) const

virtual

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

◆ attrHandler()

template<class T >

virtual ImageAttrHandler& casacore::RebinImage< 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 >.

◆ cloneII()

template<class T >

virtual ImageInterface<T>* casacore::RebinImage< T >::cloneII ( ) const

virtual

Make a copy of the object (reference semantics).

Implements casacore::ImageInterface< T >.

◆ doGetMaskSlice()

template<class T >

virtual Bool casacore::RebinImage< T >::doGetMaskSlice	(	Array< Bool > &	buffer,
		const Slicer &	section
	)

virtual

Get a section of the mask.

Non-unit strides are not yet supported.

◆ doGetSlice()

template<class T >

virtual Bool casacore::RebinImage< T >::doGetSlice	(	Array< T > &	buffer,
		const Slicer &	section
	)

virtual

Do the actual getting of an array of values.

Non-unit strides are not yet supported.

◆ doNiceCursorShape()

template<class T >

virtual IPosition casacore::RebinImage< T >::doNiceCursorShape ( uInt maxPixels ) const

virtual

Get the best cursor shape.

◆ doPutSlice()

template<class T >

virtual void casacore::RebinImage< T >::doPutSlice	(	const Array< T > &	sourceBuffer,
		const IPosition &	where,
		const IPosition &	stride
	)

virtual

Putting data is not possible as the lattice is not writable.

◆ flush()

template<class T >

virtual void casacore::RebinImage< T >::flush ( )

virtual

◆ getRegionPtr()

template<class T >

virtual const LatticeRegion* casacore::RebinImage< T >::getRegionPtr ( ) const

virtual

Get the region used (always returns 0).

◆ hasLock()

template<class T >

virtual Bool casacore::RebinImage< T >::hasLock ( FileLocker::LockType ) const

virtual

◆ hasPixelMask()

template<class T >

virtual Bool casacore::RebinImage< T >::hasPixelMask ( ) const

virtual

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

◆ imageType()

template<class T >

virtual String casacore::RebinImage< T >::imageType ( ) const

virtual

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

Implements casacore::ImageInterface< T >.

◆ isMasked()

template<class T >

virtual Bool casacore::RebinImage< T >::isMasked ( ) const

virtual

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

◆ isPaged()

template<class T >

virtual Bool casacore::RebinImage< T >::isPaged ( ) const

virtual

Is the RebinImage paged to disk?

◆ isPersistent()

template<class T >

virtual Bool casacore::RebinImage< T >::isPersistent ( ) const

virtual

A RebinImage is not persistent.

◆ isWritable()

template<class T >

virtual Bool casacore::RebinImage< T >::isWritable ( ) const

virtual

An RebinImage is not writable.

◆ lock()

template<class T >

virtual Bool casacore::RebinImage< T >::lock	(	FileLocker::LockType	,
		uInt	nattempts
	)

virtual

Handle the (un)locking and syncing, etc.

◆ makeIter()

template<class T >

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

◆ name()

template<class T >

virtual String casacore::RebinImage< T >::name ( Bool stripPath = False ) const

virtual

Return the name of the parent ImageInterface object.

Implements casacore::ImageInterface< T >.

◆ ok()

template<class T >

virtual Bool casacore::RebinImage< T >::ok ( ) const

virtual

Check class invariants.

Implements casacore::ImageInterface< T >.

◆ operator=()

template<class T >

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

Assignment (reference semantics).

◆ pixelMask() [1/2]

template<class T >

virtual Lattice<Bool>& casacore::RebinImage< T >::pixelMask ( )

virtual

◆ pixelMask() [2/2]

template<class T >

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

◆ reopen()

template<class T >

virtual void casacore::RebinImage< T >::reopen ( )

virtual

◆ resize()

template<class T >

virtual void casacore::RebinImage< T >::resize ( const TiledShape & newShape )

virtual

Function which changes the shape of the RebinImage.

Throws an exception as resizing an RebinImage is not possible.

Implements casacore::ImageInterface< T >.

◆ resync()

template<class T >

virtual void casacore::RebinImage< T >::resync ( )

virtual

◆ shape()

template<class T >

virtual IPosition casacore::RebinImage< T >::shape ( ) const

virtual

Returns the shape of the RebinImage.

◆ tempClose()

template<class T >

virtual void casacore::RebinImage< T >::tempClose ( )

virtual

◆ unlock()

template<class T >

virtual void casacore::RebinImage< T >::unlock ( )

virtual

Member Data Documentation

◆ itsImagePtr

template<class T >

ImageInterface<T>* casacore::RebinImage< T >::itsImagePtr

private

Definition at line 195 of file RebinImage.h.

◆ itsRebinPtr

template<class T >

RebinLattice<T>* casacore::RebinImage< T >::itsRebinPtr

private

Definition at line 196 of file RebinImage.h.

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

images/Images/RebinImage.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class T> class casacore::RebinImage< T >

Intended use:

Review Status

Prerequisite

Synopsis

Example

Motivation

Constructor & Destructor Documentation

◆ RebinImage() [1/3]

◆ RebinImage() [2/3]

◆ RebinImage() [3/3]

◆ ~RebinImage()

Member Function Documentation

◆ advisedMaxPixels()

◆ attrHandler()

◆ cloneII()

◆ doGetMaskSlice()

◆ doGetSlice()

◆ doNiceCursorShape()

◆ doPutSlice()

◆ flush()

◆ getRegionPtr()

◆ hasLock()

◆ hasPixelMask()

◆ imageType()

◆ isMasked()

◆ isPaged()

◆ isPersistent()

◆ isWritable()

◆ lock()

◆ makeIter()

◆ name()

◆ ok()

◆ operator=()

◆ pixelMask() [1/2]

◆ pixelMask() [2/2]

◆ reopen()

◆ resize()

◆ resync()

◆ shape()

◆ tempClose()

◆ unlock()

Member Data Documentation

◆ itsImagePtr

◆ itsRebinPtr

template<class T>
class casacore::RebinImage< T >