#include <ImageMetaDataBase.h>

Inheritance diagram for casa::ImageMetaDataBase< T >:

Public Member Functions
	ImageMetaDataBase ()=delete

virtual	~ImageMetaDataBase ()

casacore::CoordinateSystem	coordsys (const std::vector< casacore::Int > &axes) const

casacore::DataType	dataType () const

casacore::uInt	nChannels () const

casacore::Bool	isChannelNumberValid (const casacore::uInt chan) const
	Is the specified channel number valid for this image? More...

casacore::Int	stokesPixelNumber (const casacore::String &stokesString) const
	Get the pixel number on the polarization axis of the specified stokes parameter. More...

casacore::String	stokesAtPixel (const casacore::uInt pixel) const
	get the stokes parameter at the specified pixel value on the polarization axis. More...

casacore::uInt	nStokes () const
	Get the number of stokes parameters in this image. More...

casacore::Bool	isStokesValid (const casacore::String &stokesString) const
	is the specified stokes parameter present in the image? More...

casacore::Vector< casacore::Int >	directionShape () const
	Get the shape of the direction axes. More...

casacore::Bool	areChannelAndStokesValid (casacore::String &message, const casacore::uInt chan, const casacore::String &stokesString) const
	if the specified stokes parameter is valid. More...

casacore::Record *	getBoundingBox (const casacore::Record &region) const
	get the bounding box in the image for the specified region. More...

virtual casacore::Record	toRecord (casacore::Bool verbose) const =0
	convert the header info to a casacore::Record and list to logger if verbose=true More...

casacore::ValueHolder	getFITSValue (const casacore::String &key) const
	get the value of the datum corresponding to the given casacore::FITS keyword. More...

casacore::Record	toWorld (const casacore::Vector< double > &value, const casacore::String &format="n", casacore::Bool doVelocity=true, const casacore::String &dirFrame="cl", const casacore::String &freqFrame="cl") const
	if doVelocity=true, compute spectral velocities as well as frequencies, if false, only compute frequencies. More...

Protected Member Functions
	ImageMetaDataBase (SPCIIT)

casacore::LogIO &	_getLog ()

virtual const casacore::ImageInfo &	_getInfo () const =0

virtual const casacore::CoordinateSystem &	_getCoords () const =0

virtual casacore::Vector < casacore::String >	_getAxisNames () const =0

virtual casacore::Vector < casacore::String >	_getAxisUnits () const =0

virtual casacore::GaussianBeam	_getBeam () const =0

virtual casacore::String	_getBrightnessUnit () const =0

virtual casacore::String	_getImType () const =0

virtual std::vector < casacore::Quantity >	_getIncrements () const =0

virtual casacore::Vector < casacore::String >	_getMasks () const =0

virtual casacore::String	_getObject () const =0

virtual casacore::String	_getEquinox () const =0

virtual casacore::MEpoch	_getObsDate () const =0

casacore::String	_getEpochString () const

virtual casacore::String	_getObserver () const =0

virtual casacore::String	_getProjection () const

virtual casacore::String	_getRefFreqType () const =0

virtual casacore::Vector < casacore::Double >	_getRefPixel () const =0

virtual casacore::Vector < casacore::Quantity >	_getRefValue () const =0

virtual casacore::Quantity	_getRestFrequency () const =0

casacore::IPosition	_getShape () const

virtual casacore::Record	_getStatistics () const =0

virtual casacore::String	_getTelescope () const =0

casacore::Record	_makeHeader () const

void	_toLog (const casacore::Record &header) const

casacore::uInt	_getAxisNumber (const casacore::String &key) const

casacore::Record	_calcStats () const

const casacore::TableRecord	_miscInfo () const

casacore::uInt	_ndim () const

virtual casacore::Vector < casacore::String >	_getStokes () const =0

Private Member Functions
void	_fieldToLog (const casacore::Record &header, const casacore::String &field, casacore::Int precision=-1) const
	precision < 0 => use default precision when printing numbers More...

casacore::String	_doStandardFormat (casacore::Double value, const casacore::String &unit) const

casacore::Record	_calcStatsT (std::shared_ptr< const casacore::ImageInterface< T > > image) const

Static Private Member Functions
static casacore::Record	_worldVectorToRecord (const casacore::CoordinateSystem &csys, const casacore::Vector< casacore::Double > &world, casacore::Int c, const casacore::String &format, casacore::Bool isAbsolute, casacore::Bool showAsAbsolute, casacore::Bool doVelocity, casacore::MDirection::Types dirFrame, casacore::MFrequency::Types freqFrame)

static casacore::Record	_worldVectorToMeasures (const casacore::CoordinateSystem &csys, const casacore::Vector< casacore::Double > &world, casacore::Int c, casacore::Bool abs, casacore::Bool doVelocity, casacore::MDirection::Types dirFrame, casacore::MFrequency::Types freqFrame)

Private Attributes
SPCIIT	_image

casacore::LogIO	_log

casacore::IPosition	_shape

Detailed Description

template<class T>
class casa::ImageMetaDataBase< T >

Definition at line 74 of file ImageMetaDataBase.h.

Constructor & Destructor Documentation

template<class T >

casa::ImageMetaDataBase< T >::ImageMetaDataBase ( )

delete

template<class T >

virtual casa::ImageMetaDataBase< T >::~ImageMetaDataBase ( )

inlinevirtual

Definition at line 81 of file ImageMetaDataBase.h.

template<class T >

casa::ImageMetaDataBase< T >::ImageMetaDataBase ( SPCIIT )

protected

Member Function Documentation

template<class T >

casacore::Record casa::ImageMetaDataBase< T >::_calcStats ( ) const

protected

template<class T >

casacore::Record casa::ImageMetaDataBase< T >::_calcStatsT ( std::shared_ptr< const casacore::ImageInterface< T > > image ) const

private

template<class T >

casacore::String casa::ImageMetaDataBase< T >::_doStandardFormat	(	casacore::Double	value,
		const casacore::String &	unit
	)		const

private

template<class T >

void casa::ImageMetaDataBase< T >::_fieldToLog	(	const casacore::Record &	header,
		const casacore::String &	field,
		casacore::Int	precision = `-1`
	)		const

private

precision < 0 => use default precision when printing numbers

template<class T >

virtual casacore::Vector<casacore::String> casa::ImageMetaDataBase< T >::_getAxisNames ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

casacore::uInt casa::ImageMetaDataBase< T >::_getAxisNumber ( const casacore::String & key ) const

protected

template<class T >

virtual casacore::Vector<casacore::String> casa::ImageMetaDataBase< T >::_getAxisUnits ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual casacore::GaussianBeam casa::ImageMetaDataBase< T >::_getBeam ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual casacore::String casa::ImageMetaDataBase< T >::_getBrightnessUnit ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual const casacore::CoordinateSystem& casa::ImageMetaDataBase< T >::_getCoords ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

casacore::String casa::ImageMetaDataBase< T >::_getEpochString ( ) const

protected

template<class T >

virtual casacore::String casa::ImageMetaDataBase< T >::_getEquinox ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual casacore::String casa::ImageMetaDataBase< T >::_getImType ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual std::vector<casacore::Quantity> casa::ImageMetaDataBase< T >::_getIncrements ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual const casacore::ImageInfo& casa::ImageMetaDataBase< T >::_getInfo ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

casacore::LogIO& casa::ImageMetaDataBase< T >::_getLog ( )

inlineprotected

Definition at line 149 of file ImageMetaDataBase.h.

References casa::ImageMetaDataBase< T >::_log.

template<class T >

virtual casacore::Vector<casacore::String> casa::ImageMetaDataBase< T >::_getMasks ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual casacore::String casa::ImageMetaDataBase< T >::_getObject ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual casacore::MEpoch casa::ImageMetaDataBase< T >::_getObsDate ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual casacore::String casa::ImageMetaDataBase< T >::_getObserver ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual casacore::String casa::ImageMetaDataBase< T >::_getProjection ( ) const

protectedvirtual

Reimplemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual casacore::String casa::ImageMetaDataBase< T >::_getRefFreqType ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual casacore::Vector<casacore::Double> casa::ImageMetaDataBase< T >::_getRefPixel ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual casacore::Vector<casacore::Quantity> casa::ImageMetaDataBase< T >::_getRefValue ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual casacore::Quantity casa::ImageMetaDataBase< T >::_getRestFrequency ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

casacore::IPosition casa::ImageMetaDataBase< T >::_getShape ( ) const

protected

template<class T >

virtual casacore::Record casa::ImageMetaDataBase< T >::_getStatistics ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual casacore::Vector<casacore::String> casa::ImageMetaDataBase< T >::_getStokes ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

virtual casacore::String casa::ImageMetaDataBase< T >::_getTelescope ( ) const

protectedpure virtual

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

casacore::Record casa::ImageMetaDataBase< T >::_makeHeader ( ) const

protected

template<class T >

const casacore::TableRecord casa::ImageMetaDataBase< T >::_miscInfo ( ) const

protected

template<class T >

casacore::uInt casa::ImageMetaDataBase< T >::_ndim ( ) const

protected

template<class T >

void casa::ImageMetaDataBase< T >::_toLog ( const casacore::Record & header ) const

protected

template<class T >

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

staticprivate

template<class T >

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

staticprivate

template<class T >

casacore::Bool casa::ImageMetaDataBase< T >::areChannelAndStokesValid	(	casacore::String &	message,
		const casacore::uInt	chan,
		const casacore::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.

template<class T >

casacore::CoordinateSystem casa::ImageMetaDataBase< T >::coordsys ( const std::vector< casacore::Int > & axes ) const

template<class T >

casacore::DataType casa::ImageMetaDataBase< T >::dataType ( ) const

template<class T >

casacore::Vector<casacore::Int> casa::ImageMetaDataBase< T >::directionShape ( ) const

Get the shape of the direction axes.

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

template<class T >

casacore::Record* casa::ImageMetaDataBase< T >::getBoundingBox ( const casacore::Record & region ) const

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

template<class T >

casacore::ValueHolder casa::ImageMetaDataBase< T >::getFITSValue ( const casacore::String & key ) const

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

template<class T >

casacore::Bool casa::ImageMetaDataBase< T >::isChannelNumberValid ( const casacore::uInt chan ) const

Is the specified channel number valid for this image?

template<class T >

casacore::Bool casa::ImageMetaDataBase< T >::isStokesValid ( const casacore::String & stokesString ) const

is the specified stokes parameter present in the image?

template<class T >

casacore::uInt casa::ImageMetaDataBase< T >::nChannels ( ) const

template<class T >

casacore::uInt casa::ImageMetaDataBase< T >::nStokes ( ) const

Get the number of stokes parameters in this image.

template<class T >

casacore::String casa::ImageMetaDataBase< T >::stokesAtPixel ( const casacore::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.

template<class T >

casacore::Int casa::ImageMetaDataBase< T >::stokesPixelNumber ( const casacore::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.

template<class T >

virtual casacore::Record casa::ImageMetaDataBase< T >::toRecord ( casacore::Bool verbose ) const

pure virtual

convert the header info to a casacore::Record and list to logger if verbose=true

Implemented in casa::ImageMetaDataRW< T >, and casa::ImageMetaData< T >.

template<class T >

casacore::Record casa::ImageMetaDataBase< T >::toWorld	(	const casacore::Vector< double > &	value,
		const casacore::String &	format = `"n"`,
		casacore::Bool	doVelocity = `true`,
		const casacore::String &	dirFrame = `"cl"`,
		const casacore::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 casacore::MDirection::showType() or casacore::MFrequency::showType().