casa::ImageMetaDataRW Class Reference

A class in which to store and allow read-write access to image metadata. More...

#include <ImageMetaDataRW.h>

Inheritance diagram for casa::ImageMetaDataRW:

Public Member Functions
	ImageMetaDataRW ()
	ImageMetaDataRW (SPIIF image)
	ImageMetaDataRW (SPIIC image)
Bool	remove (const String &key)
	remove, if possible, the specified parameter.
Bool	removeMask (const String &maskName)
	remove the specified mask.
Record	toRecord (Bool verbose) const
	convert the header info to a Record and list to logger if verbose=True
Bool	add (const String &key, const ValueHolder &value)
	add a key-value pair
Bool	set (const String &key, const ValueHolder &value)
	set (update) the value associated with the key.
void	setCsys (const Record &coordinates)
	set the coordinate system from a Record.
Protected Member Functions
SPCIIF	_getFloatImage () const
SPCIIC	_getComplexImage () const
const ImageInfo &	_getInfo () const
const CoordinateSystem &	_getCoords () const
Vector< String >	_getAxisNames () const
Vector< String >	_getAxisUnits () const
GaussianBeam	_getBeam () const
String	_getBrightnessUnit () const
String	_getImType () const
vector< Quantity >	_getIncrements () const
Vector< String >	_getMasks () const
String	_getObject () const
String	_getEquinox () const
MEpoch	_getObsDate () const
String	_getObserver () const
String	_getProjection () const
String	_getRefFreqType () const
Vector< Double >	_getRefPixel () const
Vector< Quantity >	_getRefValue () const
Quantity	_getRestFrequency () const
String	_getTelescope () const
Record	_getStatistics () const
Vector< String >	_getStokes () const
Private Member Functions
std::unique_ptr< CoordinateSystem >	_makeCoordinateSystem (const Record &coordinates, const IPosition &shape)
void	_setCoordinateValue (const String &key, const ValueHolder &value)
String	_getString (const String &key, const ValueHolder &value) const
void	_setUserDefined (const String &key, const ValueHolder &v)
Bool	_setUnit (const String &unit)
Bool	_setCsys (const CoordinateSystem &csys)
Bool	_setImageInfo (const ImageInfo &info)
const TableRecord	_miscInfo () const
void	_setMiscInfo (const TableRecord &rec)
Bool	_hasRegion (const String &maskName) const
Bool	_isWritable () const
template<class T , class U >
void	_modHistory (const String &func, const String &keyword, const T &oldVal, const U &newVal)
template<class T >
void	_addHistory (const String &func, const String &keyword, const T &newVal)
void	_toHistory (const String &origin, const String &record)
Static Private Member Functions
static Quantity	_getQuantity (const ValueHolder &v)
template<class T >
static String	_quotify (const T &val)
Private Attributes
SPIIF	_floatImage
SPIIC	_complexImage
String	_bunit
	These are mutable because they are only to be set once and then cached.
String	_imtype
String	_object
String	_equinox
String	_observer
String	_projection
String	_reffreqtype
String	_telescope
MEpoch	_obsdate
Quantity	_restFreq
Vector< String >	_masks
Vector< String >	_stokes
GaussianBeam	_beam
Vector< String >	_axisNames
Vector< String >	_axisUnits
Vector< Double >	_refPixel
vector< Quantity >	_refVal
vector< Quantity >	_increment
Record	_header
Record	_stats

Detailed Description

A class in which to store and allow read-write access to image metadata.

Intended use:

Public interface

Prerequisite

ImageInterface

Etymology

The ImageMetaDataRW class name is derived from its role as holding image metadata and providing read-write access.

Synopsis

The ImageMetaDataRW object is meant to allow access to image metadata (eg, shape, coordinate system info such as spectral and polarization axes numbers, etc). It allows write access to some values. This class contains the writable methods and extends ImageMetaData which contains the read-only methods.

Example

Construct an object of this class by passing the associated image to the constructor.

 PagedImage<Float> myImage("myImage");
 ImageMetaDataRW<Float> myImageMetaData(myImage);

Motivation

This class is meant to provide an object-oriented interface for accessing image metadata without polluting the ImageInterface and CoordinateSystem classes with these methods.

Definition at line 78 of file ImageMetaDataRW.h.

Constructor & Destructor Documentation

casa::ImageMetaDataRW::ImageMetaDataRW ( )

casa::ImageMetaDataRW::ImageMetaDataRW ( SPIIF image )

casa::ImageMetaDataRW::ImageMetaDataRW ( SPIIC image )

Member Function Documentation

template<class T >

void casa::ImageMetaDataRW::_addHistory	(	const String &	func,
		const String &	keyword,
		const T &	newVal
	)			`[inline, private]`

Vector<String> casa::ImageMetaDataRW::_getAxisNames ( ) const [protected, virtual]

String casa::ImageMetaDataRW::_getString	(	const String &	key,
		const ValueHolder &	value
	)			const `[private]`

std::unique_ptr<CoordinateSystem> casa::ImageMetaDataRW::_makeCoordinateSystem	(	const Record &	coordinates,
		const IPosition &	shape
	)			`[private]`

void casa::ImageMetaDataRW::_modHistory	(	const String &	func,
		const String &	keyword,
		const T &	oldVal,
		const U &	newVal
	)			`[inline, private]`

void casa::ImageMetaDataRW::_setCoordinateValue	(	const String &	key,
		const ValueHolder &	value
	)			`[private]`

void casa::ImageMetaDataRW::_setUserDefined	(	const String &	key,
		const ValueHolder &	v
	)			`[private]`

void casa::ImageMetaDataRW::_toHistory	(	const String &	origin,
		const String &	record
	)			`[private]`

Bool casa::ImageMetaDataRW::add	(	const String &	key,
		const ValueHolder &	value
	)

Bool casa::ImageMetaDataRW::set	(	const String &	key,
		const ValueHolder &	value
	)

casa::ImageMetaDataRW Class Reference

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes