casa::ComponentShape Class Reference

Base class for component shapes. More...

#include <ComponentShape.h>

Inheritance diagram for casa::ComponentShape:
casa::PointShape casa::TwoSidedShape casa::DiskShape casa::GaussianShape casa::LimbDarkenedDiskShape

List of all members.

Public Member Functions

virtual ~ComponentShape ()
virtual ComponentType::Shape type () const =0
virtual const String & ident () const
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
void copyDirectionInfo (const ComponentShape &that)
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 ComponentShapeclone () 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
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 ComponentShapegetPtr () 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)
ComponentShapeoperator= (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

Review Status

Date Reviewed:
yyyy/mm/dd
Test programs:
tComponentShape
Demo programs:
dPointShape

Prerequisite

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 casacore::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]
virtual Bool casa::ComponentShape::convertUnit ( String &  errorMessage,
const RecordInterface &  record 
) [pure virtual]

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

void casa::ComponentShape::copyDirectionInfo ( const ComponentShape that  ) 
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::PointShape, and casa::TwoSidedShape.

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]

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

virtual const ComponentShape* casa::ComponentShape::getPtr (  )  const [pure virtual]
static ComponentType::Shape casa::ComponentShape::getType ( String &  errorMessage,
const RecordInterface &  record 
) [static]
virtual const String& casa::ComponentShape::ident (  )  const [virtual]
virtual Bool casa::ComponentShape::isSymmetric (  )  const [pure virtual]

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

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

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

virtual Bool casa::ComponentShape::ok (  )  const [virtual]
ComponentShape& casa::ComponentShape::operator= ( const ComponentShape other  )  [protected]
virtual Vector<Double> casa::ComponentShape::optParameters (  )  const [pure virtual]
virtual Vector<Double> casa::ComponentShape::parameters (  )  const [pure virtual]

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

const MDirection& casa::ComponentShape::refDirection (  )  const
const Quantum<Double>& casa::ComponentShape::refDirectionErrorLat (  )  const
const Quantum<Double>& casa::ComponentShape::refDirectionErrorLong (  )  const
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]
virtual Double casa::ComponentShape::sample ( const MDirection &  direction,
const MVAngle &  pixelLatSize,
const MVAngle &  pixelLongSize 
) const [pure virtual]
virtual void casa::ComponentShape::setErrors ( const Vector< Double > &  newErrs  )  [pure virtual]

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

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

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

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]
virtual Vector<Double> casa::ComponentShape::toPixel ( const DirectionCoordinate &  dirCoord  )  const [virtual]

Reimplemented in casa::TwoSidedShape.

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

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

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

Member Data Documentation

MDirection casa::ComponentShape::itsDir [private]

Definition at line 337 of file ComponentShape.h.

Quantum<Double> casa::ComponentShape::itsDirErrLat [private]

Definition at line 339 of file ComponentShape.h.

Quantum<Double> casa::ComponentShape::itsDirErrLong [private]

Definition at line 340 of file ComponentShape.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1