#include <ComponentImager.h>

Inheritance diagram for casa::ComponentImager:

Public Member Functions
	ComponentImager ()=delete

	ComponentImager (const SPIIF image, const casacore::Record *const &regionPtr, const casacore::String &maskInp)

	~ComponentImager ()

void	setComponentList (const ComponentList &list)

void	setSubtract (casacore::Bool b)

casacore::String	getClass () const

void	modify (casacore::Bool verbose)

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)

Static Public Member Functions
static void	project (casacore::ImageInterface< casacore::Float > &image, const ComponentList &list)
	Project the componentlist onto the image. More...

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

Static Private Member Functions
static std::unique_ptr < ComponentList >	_doPoints (casacore::ImageInterface< casacore::Float > &image, const ComponentList &list, int longAxis, int latAxis, const casacore::Unit &fluxUnits, const casacore::MeasRef< casacore::MDirection > &dirRef, const casacore::MVAngle &pixelLatSize, const casacore::MVAngle &pixelLongSize, const casacore::Vector< casacore::MVFrequency > &freqValues, const casacore::MeasRef< casacore::MFrequency > &freqRef, casacore::Int freqAxis, casacore::Int polAxis, casacore::uInt nStokes)

Private Attributes
SPIIF	_image
	we cannot use pointer stored in base class because that's const More...

ComponentList	_list

casacore::Bool	_subtract

Additional Inherited Members
Public Types inherited from casa::ImageTask< casacore::Float >
enum	Verbosity
	Virtual base class for image analysis tasks. 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

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

Intended use:

Internal

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

ImageInterface
ComponentList

Etymology

Synopsis

Project the componentlist onto the image. If any of the coordinate transformations for a particular pixel fail (e.g. coordinate system is not defined for that pixel) if the image has a writable mask, then those pixels will be masked, otherwise they are just zeroed. Any pixels that are already masked mask=F) will not have their values changed (perhaps this behaviour should be changed).

Example

Motivation

Definition at line 119 of file ComponentImager.h.

Constructor & Destructor Documentation

casa::ComponentImager::ComponentImager ( )

delete

casa::ComponentImager::ComponentImager	(	const SPIIF	image,
		const casacore::Record *const &	regionPtr,
		const casacore::String &	maskInp
	)

casa::ComponentImager::~ComponentImager ( )

Member Function Documentation

static std::unique_ptr<ComponentList> casa::ComponentImager::_doPoints	(	casacore::ImageInterface< casacore::Float > &	image,
		const ComponentList &	list,
		int	longAxis,
		int	latAxis,
		const casacore::Unit &	fluxUnits,
		const casacore::MeasRef< casacore::MDirection > &	dirRef,
		const casacore::MVAngle &	pixelLatSize,
		const casacore::MVAngle &	pixelLongSize,
		const casacore::Vector< casacore::MVFrequency > &	freqValues,
		const casacore::MeasRef< casacore::MFrequency > &	freqRef,
		casacore::Int	freqAxis,
		casacore::Int	polAxis,
		casacore::uInt	nStokes
	)

staticprivate

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

inlineprivatevirtual

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

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

Definition at line 164 of file ComponentImager.h.

References casacore::Coordinate::DIRECTION.

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

inlineprivatevirtual

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

Definition at line 160 of file ComponentImager.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

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

inlinevirtual

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

Definition at line 137 of file ComponentImager.h.

void casa::ComponentImager::modify ( casacore::Bool verbose )

static void casa::ComponentImager::project	(	casacore::ImageInterface< casacore::Float > &	image,
		const ComponentList &	list
	)

static

Project the componentlist onto the image.

If any of the coordinate transformations for a particular pixel fail (e.g. coordinate system is not defined for that pixel) if the image has a writable mask, then those pixels will be masked, otherwise they are just zeroed. Any pixels that are already masked mask=F) will not have their values changed (perhaps this behaviour should be changed).

void casa::ComponentImager::setComponentList ( const ComponentList & list )

inline

Definition at line 131 of file ComponentImager.h.

References _list.

void casa::ComponentImager::setSubtract ( casacore::Bool b )

inline

Definition at line 135 of file ComponentImager.h.

References _subtract.

Member Data Documentation

SPIIF casa::ComponentImager::_image

private

we cannot use pointer stored in base class because that's const

Definition at line 154 of file ComponentImager.h.

ComponentList casa::ComponentImager::_list

private

Definition at line 156 of file ComponentImager.h.

Referenced by setComponentList().

casacore::Bool casa::ComponentImager::_subtract

private

Definition at line 158 of file ComponentImager.h.

Referenced by setSubtract().

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

casa/code/imageanalysis/ImageAnalysis/ComponentImager.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Example

Motivation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation