casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | Static Private Member Functions | List of all members
casacore::GaussianBeam Class Reference

Represents a Gaussian restoring beam associated with an image. More...

#include <GaussianBeam.h>

Public Member Functions

 GaussianBeam ()
 create a beam with all quantities zero (a null beam). More...
 
 GaussianBeam (const Quantity &major, const Quantity &minor, const Quantity &pa)
 Construct a beam from a set of Quantities. More...
 
 GaussianBeam (const Vector< Quantity > &parms)
 Construct a beam from a 3-Vector of Quantities representing the major axis, the minor axis and the position angle (in that order). More...
 
 GaussianBeam (const GaussianBeam &other)
 
 ~GaussianBeam ()
 
GaussianBeamoperator= (const GaussianBeam &other)
 
Bool operator== (const GaussianBeam &other) const
 
Bool operator!= (const GaussianBeam &other) const
 
const QuantitygetMajor () const
 returns the major axis in the same units as it had at construction More...
 
Double getMajor (const Unit &u) const
 returns the value portion of the major axis in the specified units More...
 
const QuantitygetMinor () const
 returns the minor axis in the same units as it had at construction More...
 
Double getMinor (const Unit &u) const
 returns the value portion of the minor axis in the specified units More...
 
Quantity getPA (const Bool unwrap=True) const
 returns the position angle's value as it was at construction, unless unwrap is True, in which case the value of the angle returned will be between -90 and 90 degrees (but with unit the same as it had when this object was constructed). More...
 
Double getPA (const Unit &u, const Bool unwrap=True) const
 returns the value portion of the position angle in the specified units More...
 
Double getArea (const Unit &unit) const
 returns the beam area in the specified unit, which much conform to solid angle units. More...
 
Bool isNull () const
 is this object a null beam (ie is either its major and/or minor axis zero)? More...
 
Record toRecord () const
 
void setMajorMinor (const Quantity &majAx, const Quantity &minAx)
 
void setPA (const Quantity &pa, Bool unwrap=False)
 if unwrap=True, unwrap pa so its value lies in the range -90 to 90 degrees before setting it. More...
 
Vector< QuantitytoVector (const Bool unwrap=True) const
 convert this object to a three-Vector of (major FWHM, minor FWHM, and pa). More...
 
void convert (const String &majUnit, const String &minUnit, const String &paUnit)
 convert stored Quantities to the specified units More...
 

Static Public Member Functions

static const StringclassName ()
 returns GassianBeam. More...
 
static GaussianBeam fromRecord (const Record &rec)
 

Static Public Attributes

static const GaussianBeam NULL_BEAM
 

Protected Attributes

Quantity _major
 
Quantity _minor
 
Quantity _pa
 

Static Private Member Functions

static Quantity _unwrap (const Quantity &pa)
 

Detailed Description

Represents a Gaussian restoring beam associated with an image.

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Etymology

A Gaussian Beam.

Synopsis

This class represents a Gaussian restoring beam associated with a deconvolved image.

Example

Motivation

Restoring beams are used many places in image analysis tasks.

Definition at line 68 of file GaussianBeam.h.

Constructor & Destructor Documentation

casacore::GaussianBeam::GaussianBeam ( )

create a beam with all quantities zero (a null beam).

casacore::GaussianBeam::GaussianBeam ( const Quantity major,
const Quantity minor,
const Quantity pa 
)

Construct a beam from a set of Quantities.

If minor > major an exception is thrown. If any units are not angular, an exception is thrown

casacore::GaussianBeam::GaussianBeam ( const Vector< Quantity > &  parms)

Construct a beam from a 3-Vector of Quantities representing the major axis, the minor axis and the position angle (in that order).

If parms[1] > parms[0] (minor axis > major axis), an exception is thrown. If any units are not angular, an exception is thrown

casacore::GaussianBeam::GaussianBeam ( const GaussianBeam other)
casacore::GaussianBeam::~GaussianBeam ( )

Member Function Documentation

static Quantity casacore::GaussianBeam::_unwrap ( const Quantity pa)
staticprivate
static const String& casacore::GaussianBeam::className ( )
static

returns GassianBeam.

void casacore::GaussianBeam::convert ( const String majUnit,
const String minUnit,
const String paUnit 
)

convert stored Quantities to the specified units

static GaussianBeam casacore::GaussianBeam::fromRecord ( const Record rec)
static
Double casacore::GaussianBeam::getArea ( const Unit unit) const

returns the beam area in the specified unit, which much conform to solid angle units.

const Quantity& casacore::GaussianBeam::getMajor ( ) const

returns the major axis in the same units as it had at construction

Double casacore::GaussianBeam::getMajor ( const Unit u) const

returns the value portion of the major axis in the specified units

const Quantity& casacore::GaussianBeam::getMinor ( ) const

returns the minor axis in the same units as it had at construction

Double casacore::GaussianBeam::getMinor ( const Unit u) const

returns the value portion of the minor axis in the specified units

Quantity casacore::GaussianBeam::getPA ( const Bool  unwrap = True) const

returns the position angle's value as it was at construction, unless unwrap is True, in which case the value of the angle returned will be between -90 and 90 degrees (but with unit the same as it had when this object was constructed).

Double casacore::GaussianBeam::getPA ( const Unit u,
const Bool  unwrap = True 
) const

returns the value portion of the position angle in the specified units

Bool casacore::GaussianBeam::isNull ( ) const

is this object a null beam (ie is either its major and/or minor axis zero)?

Bool casacore::GaussianBeam::operator!= ( const GaussianBeam other) const
GaussianBeam& casacore::GaussianBeam::operator= ( const GaussianBeam other)
Bool casacore::GaussianBeam::operator== ( const GaussianBeam other) const
void casacore::GaussianBeam::setMajorMinor ( const Quantity majAx,
const Quantity minAx 
)
void casacore::GaussianBeam::setPA ( const Quantity pa,
Bool  unwrap = False 
)

if unwrap=True, unwrap pa so its value lies in the range -90 to 90 degrees before setting it.

Record casacore::GaussianBeam::toRecord ( ) const
Vector<Quantity> casacore::GaussianBeam::toVector ( const Bool  unwrap = True) const

convert this object to a three-Vector of (major FWHM, minor FWHM, and pa).

If unwrap is True, the returned pa will fall between -90 and +90 degrees.

Member Data Documentation

Quantity casacore::GaussianBeam::_major
protected

Definition at line 155 of file GaussianBeam.h.

Quantity casacore::GaussianBeam::_minor
protected

Definition at line 155 of file GaussianBeam.h.

Quantity casacore::GaussianBeam::_pa
protected

Definition at line 155 of file GaussianBeam.h.

const GaussianBeam casacore::GaussianBeam::NULL_BEAM
static

Definition at line 71 of file GaussianBeam.h.


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