#include <ImageDecimator.h>

Inheritance diagram for casa::ImageDecimator< T >:

Public Member Functions
	ImageDecimator (const SPCIIT image, const casacore::Record *const region, const casacore::String &maskInp, const casacore::String &outname, casacore::Bool overwrite)
	Top level interface for removing image planes. More...

	~ImageDecimator ()
	destructor More...

SPIIT	decimate () const

casacore::String	getClass () const

void	setFactor (casacore::uInt n)
	every nth plane will be kept More...

void	setAxis (casacore::uInt n)
	Set the pixel axis number along which the decimation will occur. More...

void	setFunction (ImageDecimatorData::Function f)
	set the decimation function More...

Public Member Functions inherited from casa::ImageTask< T >
virtual	~ImageTask ()

void	setStretch (const casacore::Bool stretch)

void	setLogfile (const casacore::String &lf)
	tacitly does nothing if `lf` is the empty string. More...

void	setLogfileAppend (const casacore::Bool a)

void	setRegion (const casacore::Record &region)

void	setMask (const casacore::String &mask)

void	setVerbosity (Verbosity verbosity)

void	addHistory (const std::vector< std::pair< casacore::String, casacore::String > > &msgs) const
	These messages will appear in the product image history upon the call to _prepareOutputImage(). More...

void	addHistory (const casacore::LogOrigin &origin, const casacore::String &msg) const

void	addHistory (const casacore::LogOrigin &origin, const std::vector< casacore::String > &msgs) const

void	addHistory (const casacore::LogOrigin &origin, const casacore::String &taskname, const std::vector< casacore::String > &paramNames, const std::vector< casac::variant > &paramValues) const
	This adds standard history messages regarding the task that was run and input parameters used. More...

void	suppressHistoryWriting (casacore::Bool b)
	suppress writing the history on _prepareOutputImage() call. More...

std::vector< std::pair < casacore::String, casacore::String > >	getHistory ()
	get the history associated with the task. More...

void	setDropDegen (casacore::Bool d)

Protected Member Functions
CasacRegionManager::StokesControl	_getStokesControl () const

std::vector < casacore::Coordinate::Type >	_getNecessaryCoordinates () const
	Represents the minimum set of coordinates necessary for the task to function. More...

casacore::Bool	_supportsMultipleBeams () const
	does this task support images with multiple beams? false means it never does. More...

casacore::Bool	_supportsMultipleRegions () const

Protected Member Functions inherited from casa::ImageTask< T >
	ImageTask (const SPCIIT image, const casacore::String &region, const casacore::Record *const &regionPtr, const casacore::String &box, const casacore::String &chanInp, const casacore::String &stokes, const casacore::String &maskInp, const casacore::String &outname, casacore::Bool overwrite)
	if `outname` is empty, no image will be written if `overwrite` is True, if image already exists it will be removed if `overwrite` is False, if image already exists exception will be thrown More...

	ImageTask (const SPCIIT image, const casacore::Record *const &regionPtr, const casacore::String &mask, const casacore::String &outname, casacore::Bool overwrite)

virtual std::vector < OutputDestinationChecker::OutputStruct >	_getOutputStruct ()

virtual void	_construct (casacore::Bool verbose=true)
	does the lion's share of constructing the object, ie checks validity of inputs, etc. More...

const SPCIIT	_getImage () const

const casacore::String &	_getMask () const

const casacore::Record *	_getRegion () const

void	_setStokes (const casacore::String &stokes)

const casacore::String &	_getStokes () const

const casacore::String &	_getChans () const

const casacore::String &	_getOutname () const

casacore::Bool	_isPVImage () const
	Is the attached image a position-velocity (PV) image? More...

void	_removeExistingOutfileIfNecessary () const

void	_removeExistingFileIfNecessary (const casacore::String &filename, const casacore::Bool overwrite, casacore::Bool warnOnly=false) const
	if warnOnly is true, log a warning message if file exists and overwrite is true, else throw an exception. More...

casacore::String	_summaryHeader () const

const std::shared_ptr < casacore::LogIO >	_getLog () const

virtual casacore::Bool	_hasLogfileSupport () const
	by default, derived classes are configured to have no log file support. More...

casacore::Bool	_getStretch () const

Bool	_getSuppressHistory () const

const std::shared_ptr< LogFile >	_getLogFile () const

casacore::Bool	_writeLogfile (const casacore::String &output, const casacore::Bool open=true, const casacore::Bool close=true)

casacore::Bool	_openLogfile ()

void	_closeLogfile () const

SPIIT	_prepareOutputImage (const casacore::ImageInterface< T > &image, const casacore::Array< T > const values, const casacore::ArrayLattice< casacore::Bool > const mask=nullptr, const casacore::IPosition const outShape=nullptr, const casacore::CoordinateSystem const coordsys=nullptr, const casacore::String *const outname=nullptr, casacore::Bool overwrite=false, casacore::Bool dropDegen=false) const
	If outname != NULL, use the value supplied. More...

SPIIT	_prepareOutputImage (const casacore::ImageInterface< T > &image, casacore::Bool dropDegen=false) const

SPIIT	_prepareOutputImage (const casacore::ImageInterface< T > &image, const casacore::String &outname, casacore::Bool overwrite, casacore::Bool warnOnly) const
	if warnOnly is true, only log a warning message if the file exists and overwrite is true, else throw an excepction More...

SPIIT	_prepareOutputImage (const casacore::ImageInterface< T > &image, const casacore::Lattice< T > &data) const
	data are copied to the output image from the `data` lattice. More...

Verbosity	_getVerbosity () const

casacore::Bool	_getOverwrite () const

virtual casacore::Bool	_mustHaveSquareDirectionPixels () const

casacore::Bool	_getDropDegen () const

template<class U >
void	_doHistory (std::shared_ptr< casacore::ImageInterface< U >> &image) const

void	_reportOldNewImageShapes (const ImageInterface< T > &out) const

void	_reportOldNewImageShapes (const IPosition &outShape) const

Private Member Functions
	ImageDecimator ()
	disallow default constructor More...

Private Attributes
casacore::uInt	_axis

casacore::uInt	_factor

ImageDecimatorData::Function	_function

Additional Inherited Members
Public Types inherited from casa::ImageTask< T >
enum	Verbosity { QUIET, WHISPER, LOW, NORMAL, HIGH, NOISY, DEAFENING }
	Virtual base class for image analysis tasks. More...

Static Protected Member Functions inherited from casa::ImageTask< T >
static void	_copyMask (casacore::Lattice< casacore::Bool > &mask, const casacore::ImageInterface< T > &image)

static void	_copyData (casacore::Lattice< T > &data, const casacore::Lattice< T > &image)

Detailed Description

template<class T>
class casa::ImageDecimator< T >

Definition at line 12 of file ImageDecimator.h.

Constructor & Destructor Documentation

template<class T >

casa::ImageDecimator< T >::ImageDecimator	(	const SPCIIT	image,
		const casacore::Record *const	region,
		const casacore::String &	maskInp,
		const casacore::String &	outname,
		casacore::Bool	overwrite
	)

Top level interface for removing image planes.

Etymology

Decimates planes of image

Synopsis

Top level interface for removing image planes.

template<class T >

casa::ImageDecimator< T >::~ImageDecimator ( )

inline

destructor

Definition at line 41 of file ImageDecimator.h.

template<class T >

casa::ImageDecimator< T >::ImageDecimator ( )

private

disallow default constructor

Member Function Documentation

template<class T >

std::vector<casacore::Coordinate::Type> casa::ImageDecimator< T >::_getNecessaryCoordinates ( ) const

inlineprotectedvirtual

Represents the minimum set of coordinates necessary for the task to function.

Implements casa::ImageTask< T >.

Definition at line 61 of file ImageDecimator.h.

template<class T >

CasacRegionManager::StokesControl casa::ImageDecimator< T >::_getStokesControl ( ) const

inlineprotectedvirtual

Implements casa::ImageTask< T >.

Definition at line 57 of file ImageDecimator.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

template<class T >

casacore::Bool casa::ImageDecimator< T >::_supportsMultipleBeams ( ) const

inlineprotectedvirtual

does this task support images with multiple beams? false means it never does.

true means it does, but not necessarily in all cases (in which case, the derived class is responsible for checking for and throwing exceptions in those cases).

Reimplemented from casa::ImageTask< T >.

Definition at line 65 of file ImageDecimator.h.

template<class T >

casacore::Bool casa::ImageDecimator< T >::_supportsMultipleRegions ( ) const

inlineprotectedvirtual

Reimplemented from casa::ImageTask< T >.

Definition at line 67 of file ImageDecimator.h.

template<class T >

SPIIT casa::ImageDecimator< T >::decimate ( ) const

template<class T >

casacore::String casa::ImageDecimator< T >::getClass ( ) const

inlinevirtual

Implements casa::ImageTask< T >.

Definition at line 45 of file ImageDecimator.h.

template<class T >

void casa::ImageDecimator< T >::setAxis ( casacore::uInt n )

Set the pixel axis number along which the decimation will occur.

template<class T >

void casa::ImageDecimator< T >::setFactor ( casacore::uInt n )

every nth plane will be kept

template<class T >

void casa::ImageDecimator< T >::setFunction ( ImageDecimatorData::Function f )

set the decimation function

Member Data Documentation

template<class T >

casacore::uInt casa::ImageDecimator< T >::_axis

private

Definition at line 70 of file ImageDecimator.h.

template<class T >

casacore::uInt casa::ImageDecimator< T >::_factor

private

Definition at line 70 of file ImageDecimator.h.

template<class T >

ImageDecimatorData::Function casa::ImageDecimator< T >::_function

private

Definition at line 71 of file ImageDecimator.h.

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

casa/code/imageanalysis/ImageAnalysis/ImageDecimator.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class T> class casa::ImageDecimator< T >

Constructor & Destructor Documentation

Etymology

Synopsis

Member Function Documentation

Member Data Documentation

template<class T>
class casa::ImageDecimator< T >