Base class for component shapes. More...

#include <ComponentShape.h>

Inheritance diagram for casa::ComponentShape:

Public Member Functions
virtual	~ComponentShape ()

virtual ComponentType::Shape	type () const =0

virtual const String &	ident () const
	Specify the identification of the record (e.g.
void	setRefDirection (const MDirection &newRefDir)

const MDirection &	refDirection () const
void	setRefDirectionError (const Quantum< Double > &newRefDirErrLat, const Quantum< Double > &newRefDirErrLong)

const Quantum< Double > &	refDirectionErrorLat () const
const Quantum< Double > &	refDirectionErrorLong () const
virtual Double	sample (const MDirection &direction, const MVAngle &pixelLatSize, const MVAngle &pixelLongSize) const =0

virtual void	sample (Vector< Double > &scale, const Vector< MDirection::MVType > &directions, const MDirection::Ref &refFrame, const MVAngle &pixelLatSize, const MVAngle &pixelLongSize) const =0

virtual DComplex	visibility (const Vector< Double > &uvw, const Double &frequency) const =0

virtual void	visibility (Vector< DComplex > &scale, const Matrix< Double > &uvw, const Double &frequency) const =0

virtual void	visibility (Matrix< DComplex > &scale, const Matrix< Double > &uvw, const Vector< Double > &frequency) const =0

virtual Bool	isSymmetric () const =0

virtual ComponentShape *	clone () const =0

virtual uInt	nParameters () const =0

virtual void	setParameters (const Vector< Double > &newParms)=0
virtual Vector< Double >	parameters () const =0
virtual void	setErrors (const Vector< Double > &newErrs)=0
virtual Vector< Double >	errors () const =0
virtual Vector< Double >	optParameters () const =0
virtual void	setOptParameters (const Vector< Double > &newOptParms)=0
virtual Bool	fromRecord (String &errorMessage, const RecordInterface &record)=0

virtual Bool	toRecord (String &errorMessage, RecordInterface &record) const =0
	Convert the class to an Record representation.
virtual Bool	convertUnit (String &errorMessage, const RecordInterface &record)=0

virtual Vector< Double >	toPixel (const DirectionCoordinate &dirCoord) const

virtual Bool	fromPixel (const Vector< Double > &parameters, const DirectionCoordinate &dirCoord)

virtual Bool	ok () const

virtual const ComponentShape *	getPtr () const =0
virtual String	sizeToString () const =0

Static Public Member Functions
static ComponentType::Shape	getType (String &errorMessage, const RecordInterface &record)

Protected Member Functions
	ComponentShape ()

	ComponentShape (const MDirection &direction)
	ComponentShape (const ComponentShape &other)
ComponentShape &	operator= (const ComponentShape &other)
Static Protected Member Functions
static Bool	differentRefs (const MeasRef< MDirection > &ref1, const MeasRef< MDirection > &ref2)

static Bool	badError (const Quantum< Double > &quantum)
static Bool	fromAngQRecord (Quantum< Double > &returnValue, String &errorMessage, const String &fieldString, const RecordInterface &record)

Private Attributes
MDirection	itsDir
Quantum< Double >	itsDirErrLat
Quantum< Double >	itsDirErrLong

Detailed Description

Base class for component shapes.

Intended use:

Public interface

 <h3>Review Status</h3><dl><dt>Date Reviewed:<dd>yyyy/mm/dd<dt>Test programs:<dd>tComponentShape<dt>Demo programs:<dd>dPointShape</dl>

Prerequisite

MDirection

Synopsis

This abstract base class defines the interface for classes which define the shape of a component. The most fundamental derived class is the point shape class but the Gaussian shape, disk shape and

limbdarkeneddisk classes are also available. These classes model the spatial distribution of emission from the sky. Classes derived from the casa::SpectralModel SpectralModel class are used to model the spectral characteristics and the Flux class is used to model the flux. The

SkyComponent class incorporates these three characteristics (flux, shape & spectrum) and the

ComponentList class handles groups of SkyComponent objects. This base class parameterises shapes with two quantities.

A reference direction.: This is specified using an

Definition at line 139 of file ComponentShape.h.

Constructor & Destructor Documentation

virtual casa::ComponentShape::~ComponentShape ( ) [virtual]

casa::ComponentShape::ComponentShape ( ) [protected]

casa::ComponentShape::ComponentShape ( const MDirection & direction ) [protected]

casa::ComponentShape::ComponentShape ( const ComponentShape & other ) [protected]

Member Function Documentation

static Bool casa::ComponentShape::badError ( const Quantum< Double > & quantum ) [static, protected]

virtual ComponentShape* casa::ComponentShape::clone ( ) const [pure virtual]

Implemented in casa::TwoSidedShape, casa::GaussianShape, casa::DiskShape, casa::PointShape, and casa::LimbDarkenedDiskShape.

virtual Bool casa::ComponentShape::convertUnit	(	String &	errorMessage,
		const RecordInterface &	record
	)		`[pure virtual]`

Implemented in casa::TwoSidedShape, and casa::PointShape.

static Bool casa::ComponentShape::differentRefs	(	const MeasRef< MDirection > &	ref1,
		const MeasRef< MDirection > &	ref2
	)		`[static, protected]`

virtual Vector<Double> casa::ComponentShape::errors ( ) const [pure virtual]

Implemented in casa::TwoSidedShape, and casa::PointShape.

static Bool casa::ComponentShape::fromAngQRecord	(	Quantum< Double > &	returnValue,
		String &	errorMessage,
		const String &	fieldString,
		const RecordInterface &	record
	)		`[static, protected]`

virtual Bool casa::ComponentShape::fromPixel	(	const Vector< Double > &	parameters,
		const DirectionCoordinate &	dirCoord
	)		`[virtual]`

Reimplemented in casa::TwoSidedShape.

virtual Bool casa::ComponentShape::fromRecord	(	String &	errorMessage,
		const RecordInterface &	record
	)		`[pure virtual]`

Implements casa::RecordTransformable.

Implemented in casa::TwoSidedShape, and casa::PointShape.

virtual const ComponentShape* casa::ComponentShape::getPtr ( ) const [pure virtual]

Implemented in casa::PointShape, casa::GaussianShape, casa::DiskShape, and casa::LimbDarkenedDiskShape.

static ComponentType::Shape casa::ComponentShape::getType	(	String &	errorMessage,
		const RecordInterface &	record
	)		`[static]`

virtual const String& casa::ComponentShape::ident ( ) const [virtual]

Specify the identification of the record (e.g.

'meas', 'quant'). The default implementation returns a empty string.

Reimplemented from casa::RecordTransformable.

virtual Bool casa::ComponentShape::isSymmetric ( ) const [pure virtual]

Implemented in casa::TwoSidedShape, and casa::PointShape.

virtual uInt casa::ComponentShape::nParameters ( ) const [pure virtual]

Implemented in casa::TwoSidedShape, and casa::PointShape.

virtual Bool casa::ComponentShape::ok ( ) const [virtual]

Reimplemented in casa::TwoSidedShape, casa::PointShape, casa::GaussianShape, casa::DiskShape, and casa::LimbDarkenedDiskShape.

ComponentShape& casa::ComponentShape::operator= ( const ComponentShape & other ) [protected]

virtual Vector<Double> casa::ComponentShape::optParameters ( ) const [pure virtual]

Implemented in casa::TwoSidedShape, casa::PointShape, and casa::LimbDarkenedDiskShape.

virtual Vector<Double> casa::ComponentShape::parameters ( ) const [pure virtual]

Implemented in casa::TwoSidedShape, and casa::PointShape.

const MDirection& casa::ComponentShape::refDirection ( ) const

const Quantum<Double>& casa::ComponentShape::refDirectionErrorLat ( ) const

const Quantum<Double>& casa::ComponentShape::refDirectionErrorLong ( ) const

virtual Double casa::ComponentShape::sample	(	const MDirection &	direction,
		const MVAngle &	pixelLatSize,
		const MVAngle &	pixelLongSize
	)		const `[pure virtual]`

Implemented in casa::TwoSidedShape, casa::GaussianShape, casa::DiskShape, casa::PointShape, and casa::LimbDarkenedDiskShape.

virtual void casa::ComponentShape::sample	(	Vector< Double > &	scale,
		const Vector< MDirection::MVType > &	directions,
		const MDirection::Ref &	refFrame,
		const MVAngle &	pixelLatSize,
		const MVAngle &	pixelLongSize
	)		const `[pure virtual]`

Implemented in casa::TwoSidedShape, casa::GaussianShape, casa::DiskShape, casa::PointShape, and casa::LimbDarkenedDiskShape.

virtual void casa::ComponentShape::setErrors ( const Vector< Double > & newErrs ) [pure virtual]

Implemented in casa::TwoSidedShape, and casa::PointShape.

virtual void casa::ComponentShape::setOptParameters ( const Vector< Double > & newOptParms ) [pure virtual]

Implemented in casa::TwoSidedShape, casa::PointShape, and casa::LimbDarkenedDiskShape.

virtual void casa::ComponentShape::setParameters ( const Vector< Double > & newParms ) [pure virtual]

Implemented in casa::TwoSidedShape, and casa::PointShape.

void casa::ComponentShape::setRefDirection ( const MDirection & newRefDir )

void casa::ComponentShape::setRefDirectionError	(	const Quantum< Double > &	newRefDirErrLat,
		const Quantum< Double > &	newRefDirErrLong
	)

virtual String casa::ComponentShape::sizeToString ( ) const [pure virtual]

Implemented in casa::TwoSidedShape, casa::PointShape, casa::GaussianShape, casa::DiskShape, and casa::LimbDarkenedDiskShape.

virtual Vector<Double> casa::ComponentShape::toPixel ( const DirectionCoordinate & dirCoord ) const [virtual]

Reimplemented in casa::TwoSidedShape.

virtual Bool casa::ComponentShape::toRecord	(	String &	error,
		RecordInterface &	outRecord
	)		const `[pure virtual]`

Convert the class to an Record representation.

The input record may already contain fields and these fields may be silently overridden. New fields may be added to the input Record. If the transformation succeeds then the error String is unchanged and the function returns True. Otherwise the function returns False and appends an error message to the supplied String giving the reason why the conversion failed.

Implements casa::RecordTransformable.

Implemented in casa::TwoSidedShape, and casa::PointShape.

virtual ComponentType::Shape casa::ComponentShape::type ( ) const [pure virtual]

Implemented in casa::GaussianShape, casa::DiskShape, casa::PointShape, casa::TwoSidedShape, and casa::LimbDarkenedDiskShape.

virtual DComplex casa::ComponentShape::visibility	(	const Vector< Double > &	uvw,
		const Double &	frequency
	)		const `[pure virtual]`

Implemented in casa::TwoSidedShape, casa::GaussianShape, casa::DiskShape, casa::PointShape, and casa::LimbDarkenedDiskShape.

virtual void casa::ComponentShape::visibility	(	Vector< DComplex > &	scale,
		const Matrix< Double > &	uvw,
		const Double &	frequency
	)		const `[pure virtual]`

Implemented in casa::TwoSidedShape, casa::GaussianShape, casa::DiskShape, casa::PointShape, and casa::LimbDarkenedDiskShape.

virtual void casa::ComponentShape::visibility	(	Matrix< DComplex > &	scale,
		const Matrix< Double > &	uvw,
		const Vector< Double > &	frequency
	)		const `[pure virtual]`