#include <ImageMaskedPixelReplacer.h>

Inheritance diagram for casa::ImageMaskedPixelReplacer< T >:

Public Member Functions
	ImageMaskedPixelReplacer ()=delete
	Top level interface for replacing masked pixel values of an image. More...

	ImageMaskedPixelReplacer (const SPIIT image, const casacore::Record *const &region=nullptr, const casacore::String &maskInp="")
	The total pixel mask is calculated by a logical OR of the existing default image pixel mask when the mask specified by `mask`. More...

	~ImageMaskedPixelReplacer ()

void	replace (const casacore::String &expr, casacore::Bool updateMask, casacore::Bool verbose)
	Perform the substitution. More...

casacore::String	getClass () const

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

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

virtual casacore::Bool	_supportsMultipleRegions () const

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

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

Static Private Member Functions
static void	_makeRegionBlock (casacore::PtrBlock< const casacore::ImageRegion * > &imageRegions, const casacore::Record &regions)

Private Attributes
const SPIIT	_image
	This class holds a writable image object to write pixel value changes to. More...

Static Private Attributes
static const casacore::String	_class

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::ImageMaskedPixelReplacer< T >

Definition at line 9 of file ImageMaskedPixelReplacer.h.

Constructor & Destructor Documentation

template<class T >

casa::ImageMaskedPixelReplacer< T >::ImageMaskedPixelReplacer ( )

delete

Top level interface for replacing masked pixel values of an image.

Etymology

Replace masked pixel values of an image

Synopsis

Top level interface for replacing masked pixel values of an image

template<class T >

casa::ImageMaskedPixelReplacer< T >::ImageMaskedPixelReplacer	(	const SPIIT	image,
		const casacore::Record *const &	region = `nullptr`,
		const casacore::String &	maskInp = `""`
	)

The total pixel mask is calculated by a logical OR of the existing default image pixel mask when the mask specified by mask.

Pixel replacement is done in place; ie on the image passed to the constructor. No copy of that image is made.

template<class T >

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

inline

Definition at line 42 of file ImageMaskedPixelReplacer.h.

Member Function Documentation

template<class T >

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

inlineprotectedvirtual

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

Implements casa::ImageTask< T >.

Definition at line 55 of file ImageMaskedPixelReplacer.h.

template<class T >

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

inlineprotectedvirtual

Implements casa::ImageTask< T >.

Definition at line 51 of file ImageMaskedPixelReplacer.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

template<class T >

static void casa::ImageMaskedPixelReplacer< T >::_makeRegionBlock	(	casacore::PtrBlock< const casacore::ImageRegion * > &	imageRegions,
		const casacore::Record &	regions
	)

staticprivate

template<class T >

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

virtual

Implements casa::ImageTask< T >.

template<class T >

void casa::ImageMaskedPixelReplacer< T >::replace	(	const casacore::String &	expr,
		casacore::Bool	updateMask,
		casacore::Bool	verbose
	)

Perform the substitution.

expr is the LEL expression to use for the new pixel values. If updateMask is true, the false mask values will be changed to true.

Member Data Documentation

template<class T >

const casacore::String casa::ImageMaskedPixelReplacer< T >::_class

staticprivate

Definition at line 60 of file ImageMaskedPixelReplacer.h.

template<class T >

const SPIIT casa::ImageMaskedPixelReplacer< T >::_image

private

This class holds a writable image object to write pixel value changes to.

Definition at line 64 of file ImageMaskedPixelReplacer.h.

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

casa/code/imageanalysis/ImageAnalysis/ImageMaskedPixelReplacer.h

Public Member Functions

Protected Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

template<class T> class casa::ImageMaskedPixelReplacer< T >

Constructor & Destructor Documentation

Etymology

Synopsis

Member Function Documentation

Member Data Documentation

template<class T>
class casa::ImageMaskedPixelReplacer< T >