#include <ImageCropper.h>

Inheritance diagram for casa::ImageCropper< T >:

Public Member Functions
	ImageCropper (const std::shared_ptr< const casacore::ImageInterface< T > > image, const casacore::Record *const &regionRec, 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 cropping masked edges of an image. More...

	~ImageCropper ()
	destructor More...

std::shared_ptr < casacore::ImageInterface< T > >	crop (const casacore::Bool wantReturn) const
	Perform the cropping. More...

void	setAxes (const std::set< casacore::uInt > &axes)
	Set the axes along which to do the cropping. 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

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

Private Attributes
std::set< casacore::uInt >	_axes

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

Definition at line 36 of file ImageCropper.h.

Constructor & Destructor Documentation

template<class T >

casa::ImageCropper< T >::ImageCropper	(	const std::shared_ptr< const casacore::ImageInterface< T > >	image,
		const casacore::Record *const &	regionRec,
		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 cropping masked edges of an image.

Etymology

Crop an image

Synopsis

High level interface for cropping images.

Example

ImageCropper cropper();

cropper.crop();

At most one of regionRec or box/chanInp/stokes should be supplied. If specifying regionRec that should be a non-null pointer and box, chanInp and stokes should all be empty strings. If specifying either or both of chanInp and/or stokes, the one(s) being specified should be non-empty strings corresponding to correct syntax for that particular parameter, and regionRec should be null. If you specify regionRec=0 and box="", stokes="", and chanInp="", that implies you want to use all of the input image.

template<class T >

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

destructor

template<class T >

casa::ImageCropper< T >::ImageCropper ( )

private

disallow default constructor

Member Function Documentation

template<class T >

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

inlineprotectedvirtual

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

Implements casa::ImageTask< T >.

Definition at line 97 of file ImageCropper.h.

template<class T >

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

inlineprotectedvirtual

Implements casa::ImageTask< T >.

Definition at line 93 of file ImageCropper.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

template<class T >

std::shared_ptr<casacore::ImageInterface<T> > casa::ImageCropper< T >::crop ( const casacore::Bool wantReturn ) const

Perform the cropping.

If wantReturn is true, a shared_ptr which wraps the cropped image is returned. If false, an empty shared_ptr is returned.

template<class T >

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

virtual

Implements casa::ImageTask< T >.

template<class T >

void casa::ImageCropper< T >::setAxes ( const std::set< casacore::uInt > & axes )

Set the axes along which to do the cropping.

An empty set means crop all axes.

Member Data Documentation

template<class T >

std::set<casacore::uInt> casa::ImageCropper< T >::_axes

private

Definition at line 102 of file ImageCropper.h.

template<class T >

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

staticprivate

Definition at line 103 of file ImageCropper.h.

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

casa/code/imageanalysis/ImageAnalysis/ImageCropper.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

template<class T> class casa::ImageCropper< T >

Constructor & Destructor Documentation

Etymology

Synopsis

Example

Member Function Documentation

Member Data Documentation

template<class T>
class casa::ImageCropper< T >