#include <ImagePadder.h>

Inheritance diagram for casa::ImagePadder:

Public Member Functions
	ImagePadder (const SPCIIF image, const casacore::Record *const regionRec=0, const casacore::String &box="", const casacore::String &chanInp="", const casacore::String &stokes="", const casacore::String &maskInp="", const casacore::String &outname="", const casacore::Bool overwrite="")
	Top level interface for padding an image in direction space. More...

	~ImagePadder ()
	destructor More...

SPIIF	pad (const casacore::Bool wantReturn) const
	perform the padding. More...

void	setPaddingPixels (const casacore::uInt nPixels, const casacore::Double value=0, const casacore::Bool good=false)
	set the number of pixels to use for padding and their values and if they should be masked on each edge of the direction plane. More...

casacore::String	getClass () const

Public Member Functions inherited from casa::ImageTask< casacore::Float >
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< casacore::Float >
	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< casacore::Float > &image, const casacore::Array< casacore::Float > 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< casacore::Float > &image, casacore::Bool dropDegen=false) const

SPIIT	_prepareOutputImage (const casacore::ImageInterface< casacore::Float > &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< casacore::Float > &image, const casacore::Lattice< casacore::Float > &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

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

void	_reportOldNewImageShapes (const ImageInterface< casacore::Float > &out) const

void	_reportOldNewImageShapes (const IPosition &outShape) const

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

Private Attributes
casacore::uInt	_nPixels

casacore::Double	_value

casacore::Bool	_good

Static Private Attributes
static const casacore::String	_class

Additional Inherited Members
Public Types inherited from casa::ImageTask< casacore::Float >
enum	Verbosity
	Virtual base class for image analysis tasks. More...

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

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

Detailed Description

Definition at line 43 of file ImagePadder.h.

Constructor & Destructor Documentation

casa::ImagePadder::ImagePadder	(	const SPCIIF	image,
		const casacore::Record *const	regionRec = `0`,
		const casacore::String &	box = `""`,
		const casacore::String &	chanInp = `""`,
		const casacore::String &	stokes = `""`,
		const casacore::String &	maskInp = `""`,
		const casacore::String &	outname = `""`,
		const casacore::Bool	overwrite = `""`
	)

Top level interface for padding an image in direction space.

Etymology

Collapses image.

Synopsis

High level interface for padding an image.

Example

ImagePadder padder();

padder.pad();

casa::ImagePadder::~ImagePadder ( )

destructor

casa::ImagePadder::ImagePadder ( )

private

disallow default constructor

Member Function Documentation

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

inlineprotectedvirtual

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

Implements casa::ImageTask< casacore::Float >.

Definition at line 103 of file ImagePadder.h.

References casacore::Coordinate::DIRECTION.

CasacRegionManager::StokesControl casa::ImagePadder::_getStokesControl ( ) const

inlineprotectedvirtual

Implements casa::ImageTask< casacore::Float >.

Definition at line 99 of file ImagePadder.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

casacore::String casa::ImagePadder::getClass ( ) const

virtual

Implements casa::ImageTask< casacore::Float >.

SPIIF casa::ImagePadder::pad ( const casacore::Bool wantReturn ) const

perform the padding.

If wantReturn is true, return a pointer to the padded image. The returned pointer is created via new(); it is the caller's responsibility to delete the returned pointer. If wantReturn is false, a NULL pointer is returned and pointer deletion is performed internally.

void casa::ImagePadder::setPaddingPixels	(	const casacore::uInt	nPixels,
		const casacore::Double	value = `0`,
		const casacore::Bool	good = `false`
	)

set the number of pixels to use for padding and their values and if they should be masked on each edge of the direction plane.

good=true means the padding pixels will not be masked (set to good, mask values = true).

Member Data Documentation

const casacore::String casa::ImagePadder::_class

staticprivate

Definition at line 113 of file ImagePadder.h.

casacore::Bool casa::ImagePadder::_good

private

Definition at line 112 of file ImagePadder.h.

casacore::uInt casa::ImagePadder::_nPixels

private

Definition at line 110 of file ImagePadder.h.

casacore::Double casa::ImagePadder::_value

private

Definition at line 111 of file ImagePadder.h.

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

casa/code/imageanalysis/ImageAnalysis/ImagePadder.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Etymology

Synopsis

Example

Member Function Documentation

Member Data Documentation