casa::ComponentImager Class Reference

#include <ComponentImager.h>

Inheritance diagram for casa::ComponentImager:

Public Member Functions
	ComponentImager ()
	ComponentImager (const SPIIF image, const Record *const &regionPtr, const String &maskInp)
	~ComponentImager ()
void	setComponentList (const ComponentList &list)
void	setSubtract (Bool b)
String	getClass () const
void	modify (Bool verbose)
Static Public Member Functions
static void	project (ImageInterface< Float > &image, const ComponentList &list)
	Project the componentlist onto the image.
Private Member Functions
CasacRegionManager::StokesControl	_getStokesControl () const
std::vector< Coordinate::Type >	_getNecessaryCoordinates () const
	Represents the minimum set of coordinates necessary for the task to function.
Static Private Member Functions
static std::unique_ptr < ComponentList >	_doPoints (ImageInterface< Float > &image, const ComponentList &list, int longAxis, int latAxis, const Unit &fluxUnits, const MeasRef< MDirection > &dirRef, const MVAngle &pixelLatSize, const MVAngle &pixelLongSize, const Vector< MVFrequency > &freqValues, const MeasRef< MFrequency > &freqRef, Int freqAxis, Int polAxis, uInt nStokes)
Private Attributes
SPIIF	_image
	we cannot use pointer stored in base class because that's const
ComponentList	_list
Bool	_subtract

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 115 of file ComponentImager.h.

Constructor & Destructor Documentation

casa::ComponentImager::ComponentImager ( )

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

casa::ComponentImager::~ComponentImager ( )

Member Function Documentation

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

std::vector<Coordinate::Type> casa::ComponentImager::_getNecessaryCoordinates ( ) const [inline, private, virtual]

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

Implements casa::ImageTask< Float >.

Definition at line 160 of file ComponentImager.h.

CasacRegionManager::StokesControl casa::ComponentImager::_getStokesControl ( ) const [inline, private, virtual]

Implements casa::ImageTask< Float >.

Definition at line 156 of file ComponentImager.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

String casa::ComponentImager::getClass ( ) const [inline, virtual]

Implements casa::ImageTask< Float >.

Definition at line 133 of file ComponentImager.h.

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

static void casa::ComponentImager::project	(	ImageInterface< 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 127 of file ComponentImager.h.

References _list.

void casa::ComponentImager::setSubtract ( Bool b ) [inline]

Definition at line 131 of file ComponentImager.h.

References _subtract.