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). | |
| 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 | |
Static Public Member Functions | |
| static const String & | className () |
| returns GassianBeam. | |
| static GaussianBeam | fromRecord (const Record &rec) |
Static Public Attributes | |
| static const GaussianBeam | NULL_BEAM |
Protected Attributes | |
| Quantity | _major |
| Quantity | _minor |
| Quantity | _pa |
Represents a Gaussian restoring beam associated with an image.
Public interface
A Gaussian Beam.
This class represents a Gaussian restoring beam associated with a deconvolved image.
Restoring beams are used many places in image analysis tasks.
Definition at line 68 of file GaussianBeam.h.
| 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
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 | ( | ) |
| 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] |
returns the beam area in the specified unit, which much conform to solid angle units.
returns the value portion of the major axis in the specified units
| const Quantity& casacore::GaussianBeam::getMajor | ( | ) | const |
returns the major axis in the same units as it had at construction
returns the value portion of the minor axis in the specified units
| const Quantity& casacore::GaussianBeam::getMinor | ( | ) | const |
returns the minor axis in the same units as it had at construction
returns the value portion of the position angle in the specified units
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).
| 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::setPA | ( | const Quantity & | pa | ) |
| Record casacore::GaussianBeam::toRecord | ( | ) | 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.
Quantity casacore::GaussianBeam::_major [protected] |
Definition at line 153 of file GaussianBeam.h.
Quantity casacore::GaussianBeam::_minor [protected] |
Definition at line 153 of file GaussianBeam.h.
Quantity casacore::GaussianBeam::_pa [protected] |
Definition at line 153 of file GaussianBeam.h.
const GaussianBeam casacore::GaussianBeam::NULL_BEAM [static] |
Definition at line 71 of file GaussianBeam.h.
1.6.1
