casa::ImageMetaDataBase Class Reference

Base class for image metadata access. More...

#include <ImageMetaDataBase.h>

Inheritance diagram for casa::ImageMetaDataBase:

List of all members.

Public Member Functions
virtual	~ImageMetaDataBase ()
CoordinateSystem	coordsys (const vector< Int > &axes) const
uInt	nChannels () const
Bool	isChannelNumberValid (const uInt chan) const
	Is the specified channel number valid for this image?
Int	stokesPixelNumber (const String &stokesString) const
	Get the pixel number on the polarization axis of the specified stokes parameter.
String	stokesAtPixel (const uInt pixel) const
	get the stokes parameter at the specified pixel value on the polarization axis.
uInt	nStokes () const
	Get the number of stokes parameters in this image.
Bool	isStokesValid (const String &stokesString) const
	is the specified stokes parameter present in the image?
Vector< Int >	directionShape () const
	Get the shape of the direction axes.
Bool	areChannelAndStokesValid (String &message, const uInt chan, const String &stokesString) const
	if the specified stokes parameter is valid.
Record *	getBoundingBox (const Record &region) const
	get the bounding box in the image for the specified region.
virtual Record	toRecord (Bool verbose) const =0
	convert the header info to a Record and list to logger if verbose=True
ValueHolder	getFITSValue (const String &key) const
	get the value of the datum corresponding to the given FITS keyword.
Record	toWorld (const Vector< double > &value, const String &format="n", Bool doVelocity=True, const String &dirFrame="cl", const String &freqFrame="cl") const
	if doVelocity=True, compute spectral velocities as well as frequencies, if False, only compute frequencies.
Static Public Attributes
static const String	MASKS
Protected Member Functions
virtual SPCIIF	_getFloatImage () const =0
virtual SPCIIC	_getComplexImage () const =0
	ImageMetaDataBase ()
LogIO &	_getLog ()
virtual const ImageInfo &	_getInfo () const =0
virtual const CoordinateSystem &	_getCoords () const =0
virtual Vector< String >	_getAxisNames () const =0
virtual Vector< String >	_getAxisUnits () const =0
virtual GaussianBeam	_getBeam () const =0
virtual String	_getBrightnessUnit () const =0
virtual String	_getImType () const =0
virtual vector< Quantity >	_getIncrements () const =0
virtual Vector< String >	_getMasks () const =0
virtual String	_getObject () const =0
virtual String	_getEquinox () const =0
virtual MEpoch	_getObsDate () const =0
String	_getEpochString () const
virtual String	_getObserver () const =0
virtual String	_getProjection () const
virtual String	_getRefFreqType () const =0
virtual Vector< Double >	_getRefPixel () const =0
virtual Vector< Quantity >	_getRefValue () const =0
virtual Quantity	_getRestFrequency () const =0
IPosition	_getShape () const
virtual Record	_getStatistics () const =0
virtual String	_getTelescope () const =0
Record	_makeHeader () const
void	_toLog (const Record &header) const
uInt	_getAxisNumber (const String &key) const
Record	_calcStats () const
const TableRecord	_miscInfo () const
uInt	_ndim () const
virtual Vector< String >	_getStokes () const =0
Static Protected Attributes
static const String	_BEAMMAJOR
static const String	_BEAMMINOR
static const String	_BEAMPA
static const String	_BMAJ
static const String	_BMIN
static const String	_BPA
static const String	_BUNIT
static const String	_CDELT
static const String	_CRPIX
static const String	_CRVAL
static const String	_CTYPE
static const String	_CUNIT
static const String	_DATAMAX
static const String	_DATAMIN
static const String	_EPOCH
static const String	_EQUINOX
static const String	_IMTYPE
static const String	_MAXPIXPOS
static const String	_MAXPOS
static const String	_MINPIXPOS
static const String	_MINPOS
static const String	_OBJECT
static const String	_OBSDATE
static const String	_OBSERVER
static const String	_PROJECTION
static const String	_RESTFREQ
static const String	_REFFREQTYPE
static const String	_SHAPE
static const String	_TELESCOPE
Private Member Functions
void	_fieldToLog (const Record &header, const String &field, Int precision=-1) const
	precision < 0 => use default precision when printing numbers
String	_doStandardFormat (Double value, const String &unit) const
template<class T >
Record	_calcStatsT (SHARED_PTR< const ImageInterface< T > > image) const
Record	_worldVectorToRecord (const CoordinateSystem &csys, const Vector< Double > &world, Int c, const String &format, Bool isAbsolute, Bool showAsAbsolute, Bool doVelocity, MDirection::Types dirFrame, MFrequency::Types freqFrame) const
Record	_worldVectorToMeasures (const CoordinateSystem &csys, const Vector< Double > &world, Int c, Bool abs, Bool doVelocity, MDirection::Types dirFrame, MFrequency::Types freqFrame) const
Private Attributes
LogIO	_log
IPosition	_shape

---

Detailed Description

Base class for image metadata access.

Intended use:

Public interface

Prerequisite

• ImageInterface

Etymology

Synopsis

Example

Motivation

Definition at line 64 of file ImageMetaDataBase.h.

---

Constructor & Destructor Documentation

virtual casa::ImageMetaDataBase::~ImageMetaDataBase

(

)

[inline, virtual]

Definition at line 70 of file ImageMetaDataBase.h.

casa::ImageMetaDataBase::ImageMetaDataBase

(

)

[inline, protected]

Definition at line 144 of file ImageMetaDataBase.h.

---

Member Function Documentation

Record casa::ImageMetaDataBase::_calcStats

(

)

const [protected]

template<class T >

Record casa::ImageMetaDataBase::_calcStatsT

(

SHARED_PTR< const ImageInterface< T > >

image

)

const [inline, private]

String casa::ImageMetaDataBase::_doStandardFormat	(	Double	value,
		const String &	unit
	)			const [private]

void casa::ImageMetaDataBase::_fieldToLog	(	const Record &	header,
		const String &	field,
		Int	precision = -1
	)			const [private]

precision < 0 => use default precision when printing numbers

virtual Vector<String> casa::ImageMetaDataBase::_getAxisNames

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

uInt casa::ImageMetaDataBase::_getAxisNumber

(

const String &

key

)

const [protected]

virtual Vector<String> casa::ImageMetaDataBase::_getAxisUnits

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual GaussianBeam casa::ImageMetaDataBase::_getBeam

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual String casa::ImageMetaDataBase::_getBrightnessUnit

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual SPCIIC casa::ImageMetaDataBase::_getComplexImage

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual const CoordinateSystem& casa::ImageMetaDataBase::_getCoords

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

String casa::ImageMetaDataBase::_getEpochString

(

)

const [protected]

virtual String casa::ImageMetaDataBase::_getEquinox

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual SPCIIF casa::ImageMetaDataBase::_getFloatImage

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual String casa::ImageMetaDataBase::_getImType

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual vector<Quantity> casa::ImageMetaDataBase::_getIncrements

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual const ImageInfo& casa::ImageMetaDataBase::_getInfo

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

LogIO& casa::ImageMetaDataBase::_getLog

(

)

[inline, protected]

Definition at line 146 of file ImageMetaDataBase.h.

References _log.

virtual Vector<String> casa::ImageMetaDataBase::_getMasks

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual String casa::ImageMetaDataBase::_getObject

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual MEpoch casa::ImageMetaDataBase::_getObsDate

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual String casa::ImageMetaDataBase::_getObserver

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual String casa::ImageMetaDataBase::_getProjection

(

)

const [protected, virtual]

Reimplemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual String casa::ImageMetaDataBase::_getRefFreqType

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual Vector<Double> casa::ImageMetaDataBase::_getRefPixel

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual Vector<Quantity> casa::ImageMetaDataBase::_getRefValue

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual Quantity casa::ImageMetaDataBase::_getRestFrequency

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

IPosition casa::ImageMetaDataBase::_getShape

(

)

const [protected]

virtual Record casa::ImageMetaDataBase::_getStatistics

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual Vector<String> casa::ImageMetaDataBase::_getStokes

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

virtual String casa::ImageMetaDataBase::_getTelescope

(

)

const [protected, pure virtual]

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

Record casa::ImageMetaDataBase::_makeHeader

(

)

const [protected]

const TableRecord casa::ImageMetaDataBase::_miscInfo

(

)

const [protected]

Reimplemented in casa::ImageMetaDataRW.

uInt casa::ImageMetaDataBase::_ndim

(

)

const [protected]

void casa::ImageMetaDataBase::_toLog

(

const Record &

header

)

const [protected]

Record casa::ImageMetaDataBase::_worldVectorToMeasures	(	const CoordinateSystem &	csys,
		const Vector< Double > &	world,
		Int	c,
		Bool	abs,
		Bool	doVelocity,
		MDirection::Types	dirFrame,
		MFrequency::Types	freqFrame
	)			const [private]

Record casa::ImageMetaDataBase::_worldVectorToRecord	(	const CoordinateSystem &	csys,
		const Vector< Double > &	world,
		Int	c,
		const String &	format,
		Bool	isAbsolute,
		Bool	showAsAbsolute,
		Bool	doVelocity,
		MDirection::Types	dirFrame,
		MFrequency::Types	freqFrame
	)			const [private]

Bool casa::ImageMetaDataBase::areChannelAndStokesValid	(	String &	message,
		const uInt	chan,
		const String &	stokesString
	)			const

if the specified stokes parameter is valid.

A message suitable for error notification is returned in the form of an in-out parameter if one or both of these is invalid.

CoordinateSystem casa::ImageMetaDataBase::coordsys

(

const vector< Int > &

axes

)

const

Vector<Int> casa::ImageMetaDataBase::directionShape

(

)

const

Get the shape of the direction axes.

Returns a two element Vector if there is a direction coordinate, if not returns a zero element vector.

Record* casa::ImageMetaDataBase::getBoundingBox

(

const Record &

region

)

const

get the bounding box in the image for the specified region.

ValueHolder casa::ImageMetaDataBase::getFITSValue

(

const String &

key

)

const

get the value of the datum corresponding to the given FITS keyword.

Bool casa::ImageMetaDataBase::isChannelNumberValid

(

const uInt

chan

)

const

Is the specified channel number valid for this image?

Bool casa::ImageMetaDataBase::isStokesValid

(

const String &

stokesString

)

const

is the specified stokes parameter present in the image?

uInt casa::ImageMetaDataBase::nChannels

(

)

const

uInt casa::ImageMetaDataBase::nStokes

(

)

const

Get the number of stokes parameters in this image.

String casa::ImageMetaDataBase::stokesAtPixel

(

const uInt

pixel

)

const

get the stokes parameter at the specified pixel value on the polarization axis.

returns "" if the specified pixel is out of range or if no polarization axis.

Int casa::ImageMetaDataBase::stokesPixelNumber

(

const String &

stokesString

)

const

Get the pixel number on the polarization axis of the specified stokes parameter.

If the specified stokes parameter does not exist in the image, the value returned is not gauranteed to be anything other than outside the range of 0 to nStokes-1 inclusive. Return -1 if the specified stokes parameter is not present or if this image does not have a polarization axis.

virtual Record casa::ImageMetaDataBase::toRecord

(

Bool

verbose

)

const [pure virtual]

convert the header info to a Record and list to logger if verbose=True

Implemented in casa::ImageMetaData, and casa::ImageMetaDataRW.

Record casa::ImageMetaDataBase::toWorld	(	const Vector< double > &	value,
		const String &	format = "n",
		Bool	doVelocity = True,
		const String &	dirFrame = "cl",
		const String &	freqFrame = "cl"
	)			const

if doVelocity=True, compute spectral velocities as well as frequencies, if False, only compute frequencies.

dirFrame and freqFrame are the codes for the frames for which it is desired that the returned measures should be specified. In both cases, one can specify "native" for the native coordinate frame, "cl" for the conversion layer frame, or any valid frame string from MDirection::showType() or MFrequency::showType().

---

Member Data Documentation

const String casa::ImageMetaDataBase::_BEAMMAJOR [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_BEAMMINOR [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_BEAMPA [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_BMAJ [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_BMIN [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_BPA [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_BUNIT [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_CDELT [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_CRPIX [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_CRVAL [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_CTYPE [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_CUNIT [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_DATAMAX [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_DATAMIN [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_EPOCH [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_EQUINOX [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_IMTYPE [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

LogIO casa::ImageMetaDataBase::_log [mutable, private]

Definition at line 208 of file ImageMetaDataBase.h.

Referenced by _getLog().

const String casa::ImageMetaDataBase::_MAXPIXPOS [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_MAXPOS [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_MINPIXPOS [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_MINPOS [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_OBJECT [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_OBSDATE [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_OBSERVER [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_PROJECTION [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_REFFREQTYPE [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_RESTFREQ [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

IPosition casa::ImageMetaDataBase::_shape [mutable, private]

Definition at line 210 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_SHAPE [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::_TELESCOPE [static, protected]

Definition at line 134 of file ImageMetaDataBase.h.

const String casa::ImageMetaDataBase::MASKS [static]

Definition at line 68 of file ImageMetaDataBase.h.

---

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

• code/imageanalysis/ImageAnalysis/ImageMetaDataBase.h