casa::ImageMetaData Class Reference

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

#include <ImageMetaData.h>

Inheritance diagram for casa::ImageMetaData:

Public Member Functions
	ImageMetaData (SPCIIF imagef)
	ImageMetaData (SPIIF imagef)
	ImageMetaData (SPCIIC imagec)
	ImageMetaData (SPIIC imagec)
	~ImageMetaData ()
Record	toRecord (Bool verbose) const
	convert the header info to a Record and list to logger if verbose=True
Record	summary (const String &doppler, const Bool list, const Bool pixelorder, const Bool verbose)
	For ia.summary() moved from ImageAnalysis.
Protected Member Functions
SPCIIF	_getFloatImage () const
SPCIIC	_getComplexImage () const
	ImageMetaData ()
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
Record	_getStatistics () const
String	_getTelescope () const
Vector< String >	_getStokes () const
template<class T >
Record	_summary (SPCIIT image, const String &doppler, const Bool list, const Bool pixelorder, const Bool verbose)
Private Attributes
SPCIIF	_floatImage
SPCIIC	_complexImage
const ImageInfo	_info
const CoordinateSystem	_csys
Record	_header
	These are mutable because they are only to be set once and then cached.
String	_bunit
String	_imtype
String	_object
String	_equinox
String	_projection
String	_observer
String	_telescope
String	_reffreqtype
MEpoch	_obsdate
Quantity	_restFreq
GaussianBeam	_beam
Vector< String >	_masks
Vector< String >	_stokes
Vector< String >	_axisNames
Vector< String >	_axisUnits
Vector< Double >	_refPixel
vector< Quantity >	_refVal
vector< Quantity >	_increment
Record	_stats

Detailed Description

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

Intended use:

Public interface

Prerequisite

ImageInterface

Etymology

The ImageMetaData class name is derived from its role as holding image metadata.

Synopsis

The ImageMetaData object is meant to allow access to image metadata (eg, shape, coordinate system info such as spectral and polarization axes numbers, etc).

Example

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

 PagedImage<Float> myImage("myImage");
 ImageMetaData<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 77 of file ImageMetaData.h.

Constructor & Destructor Documentation

casa::ImageMetaData::ImageMetaData ( SPCIIF imagef )

casa::ImageMetaData::ImageMetaData ( SPIIF imagef )

casa::ImageMetaData::ImageMetaData ( SPCIIC imagec )

casa::ImageMetaData::ImageMetaData ( SPIIC imagec )

casa::ImageMetaData::~ImageMetaData ( ) [inline]

Definition at line 87 of file ImageMetaData.h.

casa::ImageMetaData::ImageMetaData ( ) [inline, protected]

Definition at line 103 of file ImageMetaData.h.

Member Function Documentation

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

Record casa::ImageMetaData::_summary	(	SPCIIT	image,
		const String &	doppler,
		const Bool	list,
		const Bool	pixelorder,
		const Bool	verbose
	)			`[inline, protected]`

Record casa::ImageMetaData::summary	(	const String &	doppler,
		const Bool	list,
		const Bool	pixelorder,
		const Bool	verbose
	)