casa::GaussianBeam Class Reference

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

#include <GaussianBeam.h>

List of all members.

Public Member Functions
	GaussianBeam ()
	create a beam with all quantities zero (a null beam).
	GaussianBeam (const Quantity &major, const Quantity &minor, const Quantity &pa)
	Construct a beam from a set of Quantities.
	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).
	GaussianBeam (const GaussianBeam &other)
	~GaussianBeam ()
GaussianBeam &	operator= (const GaussianBeam &other)
Bool	operator== (const GaussianBeam &other) const
Bool	operator!= (const GaussianBeam &other) const
const Quantity &	getMajor () const
	returns the major axis in the same units as it had at construction
Double	getMajor (const Unit &u) const
	returns the value portion of the major axis in the specified units
const Quantity &	getMinor () const
	returns the minor axis in the same units as it had at construction
Double	getMinor (const Unit &u) const
	returns the value portion of the minor axis in the specified units
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).
Double	getPA (const Unit &u, const Bool unwrap=True) const
	returns the value portion of the position angle in the specified units
Double	getArea (const Unit &unit) const
	returns the beam area in the specified unit, which much conform to solid angle units.
Bool	isNull () const
	is this object a null beam (ie is either its major and/or minor axis zero)?
Record	toRecord () const
void	setMajorMinor (const Quantity &majAx, const Quantity &minAx)
void	setPA (const Quantity &pa)
Vector< Quantity >	toVector (const Bool unwrap=True) const
	convert this object to a three-Vector of (major FWHM, minor FWHM, and pa).
void	convert (const String &majUnit, const String &minUnit, const String &paUnit)
	convert stored Quantities to the specified units
Bool	deconvolve (Angular2DGaussian &deconvolvedSize, const Angular2DGaussian &convolvedSize) const
	Deconvolve the parameters of a source Gaussian from a this GaussianBeam to give the deconvolved Gaussian source.
Static Public Member Functions
static const String &	className ()
	returns GassianBeam.
static GaussianBeam	fromRecord (const Record &rec)
Static Public Attributes
static const GaussianBeam	NULL_BEAM
Private Attributes
Quantity	_major
Quantity	_minor
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 73 of file GaussianBeam.h.

---

Constructor & Destructor Documentation

casa::GaussianBeam::GaussianBeam

(

)

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

casa::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

casa::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

casa::GaussianBeam::GaussianBeam

(

const GaussianBeam &

other

)

casa::GaussianBeam::~GaussianBeam

(

)

---

Member Function Documentation

static const String& casa::GaussianBeam::className

(

)

[static]

returns GassianBeam.

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

convert stored Quantities to the specified units

Bool casa::GaussianBeam::deconvolve	(	Angular2DGaussian &	deconvolvedSize,
		const Angular2DGaussian &	convolvedSize
	)		const

Deconvolve the parameters of a source Gaussian from a this GaussianBeam to give the deconvolved Gaussian source.

The return is True if the model appears to be a point source and the output model will be set to the parameters of the beam.

static GaussianBeam casa::GaussianBeam::fromRecord

(

const Record &

rec

)

[static]

Double casa::GaussianBeam::getArea

(

const Unit &

unit

)

const

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

const Quantity& casa::GaussianBeam::getMajor

(

)

const

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

Double casa::GaussianBeam::getMajor

(

const Unit &

u

)

const

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

const Quantity& casa::GaussianBeam::getMinor

(

)

const

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

Double casa::GaussianBeam::getMinor

(

const Unit &

u

)

const

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

Quantity casa::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 casa::GaussianBeam::getPA	(	const Unit &	u,
		const Bool	unwrap = True
	)		const

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

Bool casa::GaussianBeam::isNull

(

)

const

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

Bool casa::GaussianBeam::operator!=

(

const GaussianBeam &

other

)

const

GaussianBeam& casa::GaussianBeam::operator=

(

const GaussianBeam &

other

)

Bool casa::GaussianBeam::operator==

(

const GaussianBeam &

other

)

const

void casa::GaussianBeam::setMajorMinor	(	const Quantity &	majAx,
		const Quantity &	minAx
	)

void casa::GaussianBeam::setPA

(

const Quantity &

pa

)

Record casa::GaussianBeam::toRecord

(

)

const

Vector<Quantity> casa::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 casa::GaussianBeam::_major [private]

Definition at line 169 of file GaussianBeam.h.

Quantity casa::GaussianBeam::_minor [private]

Definition at line 169 of file GaussianBeam.h.

Quantity casa::GaussianBeam::_pa [private]

Definition at line 169 of file GaussianBeam.h.

const GaussianBeam casa::GaussianBeam::NULL_BEAM [static]

Definition at line 76 of file GaussianBeam.h.

---

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

• casacore/components/ComponentModels/GaussianBeam.h