#include <ImageRegridderBase.h>

Inheritance diagram for casa::ImageRegridderBase< T >:

Public Member Functions
	ImageRegridderBase ()=delete

virtual	~ImageRegridderBase ()
	destructor More...

void	setSpecAsVelocity (casacore::Bool v)
	regrid the spectral axis in velocity space rather than frequency space? More...

void	setMethod (const casacore::String &method)
	Set interpolation method. More...

void	setMethod (casacore::Interpolate2D::Method method)

void	setDoRefChange (casacore::Bool d)

void	setReplicate (casacore::Bool r)

void	setDecimate (casacore::Int d)
	throws exception if 3*decimate > length of an axis that will be regridded More...

void	setForceRegrid (casacore::Bool f)

void	setShape (const casacore::IPosition s)

virtual SPIIT	regrid () const =0

template<class U >
void	setConfiguration (const ImageRegridderBase< U > &that)

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

virtual casacore::String	getClass () const =0

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
	ImageRegridderBase (const SPCIIT image, const casacore::Record *const regionRec, const casacore::String &maskInp, const casacore::String &outname, casacore::Bool overwrite, const casacore::CoordinateSystem &csys, const casacore::IPosition &axes, const casacore::IPosition &shape)

casacore::Interpolate2D::Method	_getMethod () const

casacore::Bool	_getDoRefChange () const

casacore::Bool	_getReplicate () const

casacore::Int	_getDecimate () const

casacore::Bool	_getForceRegrid () const

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	_getSpecAsVelocity () const

casacore::IPosition	_getShape () const

const casacore::CoordinateSystem &	_getTemplateCoords () const

casacore::IPosition	_getAxes () const

casacore::IPosition	_getKludgedShape () const

std::vector< casacore::String >	_getOutputStokes () const

casacore::uInt	_getNReplicatedChans () const

casacore::Bool	_regriddingDirectionAxes () 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

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
void	_finishConstruction ()

Friends
template<typename U >
class	ImageRegridderBase
	casacore::Data store of ImageRegridder and ComplexImageRegridder TODO ComplexImageRegridder has been removed so this class can probably be merged into ImageRegridder More...

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

Definition at line 35 of file ImageRegridderBase.h.

Constructor & Destructor Documentation

template<class T>

casa::ImageRegridderBase< T >::ImageRegridderBase ( )

delete

template<class T>

virtual casa::ImageRegridderBase< T >::~ImageRegridderBase ( )

virtual

destructor

template<class T>

casa::ImageRegridderBase< T >::ImageRegridderBase	(	const SPCIIT	image,
		const casacore::Record *const	regionRec,
		const casacore::String &	maskInp,
		const casacore::String &	outname,
		casacore::Bool	overwrite,
		const casacore::CoordinateSystem &	csys,
		const casacore::IPosition &	axes,
		const casacore::IPosition &	shape
	)

protected

Member Function Documentation

template<class T>

void casa::ImageRegridderBase< T >::_finishConstruction ( )

private

template<class T>

casacore::IPosition casa::ImageRegridderBase< T >::_getAxes ( ) const

inlineprotected

Definition at line 124 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_axes.

template<class T>

casacore::Int casa::ImageRegridderBase< T >::_getDecimate ( ) const

inlineprotected

Definition at line 104 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_decimate.

template<class T>

casacore::Bool casa::ImageRegridderBase< T >::_getDoRefChange ( ) const

inlineprotected

Definition at line 100 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_doRefChange.

template<class T>

casacore::Bool casa::ImageRegridderBase< T >::_getForceRegrid ( ) const

inlineprotected

Definition at line 106 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_forceRegrid.

template<class T>

casacore::IPosition casa::ImageRegridderBase< T >::_getKludgedShape ( ) const

inlineprotected

Definition at line 126 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_kludgedShape.

template<class T>

casacore::Interpolate2D::Method casa::ImageRegridderBase< T >::_getMethod ( ) const

inlineprotected

Definition at line 98 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_method.

template<class T>

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

inlineprotectedvirtual

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

Implements casa::ImageTask< T >.

Definition at line 112 of file ImageRegridderBase.h.

template<class T>

casacore::uInt casa::ImageRegridderBase< T >::_getNReplicatedChans ( ) const

inlineprotected

Definition at line 130 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_nReplicatedChans.

template<class T>

std::vector<casacore::String> casa::ImageRegridderBase< T >::_getOutputStokes ( ) const

inlineprotected

Definition at line 128 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_outputStokes.

template<class T>

casacore::Bool casa::ImageRegridderBase< T >::_getReplicate ( ) const

inlineprotected

Definition at line 102 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_replicate.

template<class T>

casacore::IPosition casa::ImageRegridderBase< T >::_getShape ( ) const

inlineprotected

Definition at line 118 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_shape.

template<class T>

casacore::Bool casa::ImageRegridderBase< T >::_getSpecAsVelocity ( ) const

inlineprotected

Definition at line 116 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_specAsVelocity.

template<class T>

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

inlineprotectedvirtual

Implements casa::ImageTask< T >.

Definition at line 108 of file ImageRegridderBase.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

template<class T>

const casacore::CoordinateSystem& casa::ImageRegridderBase< T >::_getTemplateCoords ( ) const

inlineprotected

Definition at line 120 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_csysTo.

template<class T>

casacore::Bool casa::ImageRegridderBase< T >::_regriddingDirectionAxes ( ) const

protected

template<class T>

virtual SPIIT casa::ImageRegridderBase< T >::regrid ( ) const

pure virtual

Implemented in casa::ImageRegridder< T >.

template<class T>

template<class U >

void casa::ImageRegridderBase< T >::setConfiguration ( const ImageRegridderBase< U > & that )

template<class T>

void casa::ImageRegridderBase< T >::setDecimate ( casacore::Int d )

throws exception if 3*decimate > length of an axis that will be regridded

template<class T>

void casa::ImageRegridderBase< T >::setDoRefChange ( casacore::Bool d )

inline

Definition at line 74 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_doRefChange.

template<class T>

void casa::ImageRegridderBase< T >::setForceRegrid ( casacore::Bool f )

inline

Definition at line 81 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_forceRegrid.

template<class T>

void casa::ImageRegridderBase< T >::setMethod ( const casacore::String & method )

inline

Set interpolation method.

Definition at line 68 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_method, and casacore::Interpolate2D::stringToMethod().

template<class T>

void casa::ImageRegridderBase< T >::setMethod ( casacore::Interpolate2D::Method method )

inline

Definition at line 72 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_method.

template<class T>

void casa::ImageRegridderBase< T >::setReplicate ( casacore::Bool r )

inline

Definition at line 76 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_replicate.

template<class T>

void casa::ImageRegridderBase< T >::setShape ( const casacore::IPosition s )

inline

Definition at line 83 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_shape.

template<class T>

void casa::ImageRegridderBase< T >::setSpecAsVelocity ( casacore::Bool v )

inline

regrid the spectral axis in velocity space rather than frequency space?

Definition at line 65 of file ImageRegridderBase.h.

References casa::ImageRegridderBase< T >::_specAsVelocity.

Friends And Related Function Documentation

template<class T>

template<typename U >

friend class ImageRegridderBase

friend

casacore::Data store of ImageRegridder and ComplexImageRegridder TODO ComplexImageRegridder has been removed so this class can probably be merged into ImageRegridder

Etymology

casacore::Data for image regridder.

Synopsis

Definition at line 55 of file ImageRegridderBase.h.

Member Data Documentation

template<class T>

casacore::IPosition casa::ImageRegridderBase< T >::_axes

private

Definition at line 136 of file ImageRegridderBase.h.

Referenced by casa::ImageRegridderBase< T >::_getAxes().

template<class T>

const casacore::CoordinateSystem casa::ImageRegridderBase< T >::_csysTo

private

Definition at line 135 of file ImageRegridderBase.h.

Referenced by casa::ImageRegridderBase< T >::_getTemplateCoords().

template<class T>

casacore::Int casa::ImageRegridderBase< T >::_decimate

private

Definition at line 138 of file ImageRegridderBase.h.

Referenced by casa::ImageRegridderBase< T >::_getDecimate().

template<class T>

casacore::Bool casa::ImageRegridderBase< T >::_doRefChange

private

Definition at line 137 of file ImageRegridderBase.h.

Referenced by casa::ImageRegridderBase< T >::_getDoRefChange(), and casa::ImageRegridderBase< T >::setDoRefChange().

template<class T>

casacore::Bool casa::ImageRegridderBase< T >::_forceRegrid

private

Definition at line 137 of file ImageRegridderBase.h.

Referenced by casa::ImageRegridderBase< T >::_getForceRegrid(), and casa::ImageRegridderBase< T >::setForceRegrid().

template<class T>

casacore::IPosition casa::ImageRegridderBase< T >::_kludgedShape

private

Definition at line 136 of file ImageRegridderBase.h.

Referenced by casa::ImageRegridderBase< T >::_getKludgedShape().

template<class T>

casacore::Interpolate2D::Method casa::ImageRegridderBase< T >::_method

private

Definition at line 139 of file ImageRegridderBase.h.

Referenced by casa::ImageRegridderBase< T >::_getMethod(), and casa::ImageRegridderBase< T >::setMethod().

template<class T>

casacore::uInt casa::ImageRegridderBase< T >::_nReplicatedChans

private

Definition at line 141 of file ImageRegridderBase.h.

Referenced by casa::ImageRegridderBase< T >::_getNReplicatedChans().

template<class T>

std::vector<casacore::String> casa::ImageRegridderBase< T >::_outputStokes

private

Definition at line 140 of file ImageRegridderBase.h.

Referenced by casa::ImageRegridderBase< T >::_getOutputStokes().

template<class T>

casacore::Bool casa::ImageRegridderBase< T >::_replicate

private

Definition at line 137 of file ImageRegridderBase.h.

Referenced by casa::ImageRegridderBase< T >::_getReplicate(), and casa::ImageRegridderBase< T >::setReplicate().

template<class T>

casacore::IPosition casa::ImageRegridderBase< T >::_shape

private

Definition at line 136 of file ImageRegridderBase.h.

Referenced by casa::ImageRegridderBase< T >::_getShape(), and casa::ImageRegridderBase< T >::setShape().

template<class T>

casacore::Bool casa::ImageRegridderBase< T >::_specAsVelocity

private

Definition at line 137 of file ImageRegridderBase.h.

Referenced by casa::ImageRegridderBase< T >::_getSpecAsVelocity(), and casa::ImageRegridderBase< T >::setSpecAsVelocity().

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

casa/code/imageanalysis/ImageAnalysis/ImageRegridderBase.h

Private Attributes
const casacore::CoordinateSystem	_csysTo

casacore::IPosition	_axes

casacore::IPosition	_shape

casacore::IPosition	_kludgedShape

casacore::Bool	_specAsVelocity

casacore::Bool	_doRefChange

casacore::Bool	_replicate

casacore::Bool	_forceRegrid

casacore::Int	_decimate

casacore::Interpolate2D::Method	_method

std::vector< casacore::String >	_outputStokes

casacore::uInt	_nReplicatedChans

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

template<class T> class casa::ImageRegridderBase< T >

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Etymology

Synopsis

Member Data Documentation

template<class T>
class casa::ImageRegridderBase< T >