casa::MSPrimaryGroupHolder Class Reference [MSFits_module_internal_classes]

A helper class for MSFitsInput. More...

#include <MSFitsInput.h>

List of all members.

Public Member Functions
	MSPrimaryGroupHolder ()
	This is a helper class to avoid cumbersome switch statements on the template type of the primary group It forwards all the PrimaryGroup member function we need in the filler.
	MSPrimaryGroupHolder (FitsInput &infile)
	Construct from an input file containing a FITS primary group hdu.
	~MSPrimaryGroupHolder ()
void	attach (FitsInput &infile)
	Attach to the input file, create the appropriate PrimaryGroup.
void	detach ()
	Detach from the input file.
Int	dims ()
	Number of dimensions.
Int	dim (Int i)
	Length of i'th axis.
Char *	ctype (Int i)
	Coordinate type.
Double	crval (Int i)
	Coordinate reference value.
Double	crpix (Int i)
	Coordinate reference pixel.
Double	cdelt (Int i)
	Coordinate delta.
const FitsKeyword *	kw (const FITS::ReservedName &n)
	Keyword of given type.
ConstFitsKeywordList &	kwlist ()
	All keywords.
const FitsKeyword *	nextkw ()
	Advance to next keyword.
Int	gcount () const
	Number of groups.
Int	pcount () const
	Number of parameters.
Char *	ptype (Int i) const
	Parameter type.
Int	read ()
	Read the next group.
Double	parm (Int i)
	Get i'th parameter.
Double	operator() (Int i) const
	Get group data with index i, scaled and converted to Double.
Private Attributes
HeaderDataUnit *	hdu_p
PrimaryGroup< Short > *	ps
PrimaryGroup< FitsLong > *	pl
PrimaryGroup< Float > *	pf

---

Detailed Description

A helper class for MSFitsInput.

Intended use:

Internal

Etymology

This class can hold a primary group of several datatypes

Synopsis

This is a helper class to avoid cumbersome switch statements on the template type of the primary group It forwards all the PrimaryGroup member functions we need in the filler.

Definition at line 62 of file MSFitsInput.h.

---

Constructor & Destructor Documentation

casa::MSPrimaryGroupHolder::MSPrimaryGroupHolder

(

)

This is a helper class to avoid cumbersome switch statements on the template type of the primary group It forwards all the PrimaryGroup member function we need in the filler.

Construct an empty holder, used to attach to later

casa::MSPrimaryGroupHolder::MSPrimaryGroupHolder

(

FitsInput &

infile

)

Construct from an input file containing a FITS primary group hdu.

Throws an exception if the datatype is not Short, FitsLong or Float

casa::MSPrimaryGroupHolder::~MSPrimaryGroupHolder

(

)

---

Member Function Documentation

void casa::MSPrimaryGroupHolder::attach

(

FitsInput &

infile

)

Attach to the input file, create the appropriate PrimaryGroup.

Throws an exception if the datatype is not Short, FitsLong or Float

Double casa::MSPrimaryGroupHolder::cdelt

(

Int

i

)

[inline]

Coordinate delta.

Definition at line 107 of file MSFitsInput.h.

References casa::PrimaryArray< TYPE >::cdelt(), pf, pl, and ps.

Double casa::MSPrimaryGroupHolder::crpix

(

Int

i

)

[inline]

Coordinate reference pixel.

Definition at line 103 of file MSFitsInput.h.

References casa::PrimaryArray< TYPE >::crpix(), pf, pl, and ps.

Double casa::MSPrimaryGroupHolder::crval

(

Int

i

)

[inline]

Coordinate reference value.

Definition at line 99 of file MSFitsInput.h.

References casa::PrimaryArray< TYPE >::crval(), pf, pl, and ps.

Char* casa::MSPrimaryGroupHolder::ctype

(

Int

i

)

[inline]

Coordinate type.

Definition at line 95 of file MSFitsInput.h.

References casa::PrimaryArray< TYPE >::ctype(), pf, pl, and ps.

void casa::MSPrimaryGroupHolder::detach

(

)

Detach from the input file.

Int casa::MSPrimaryGroupHolder::dim

(

Int

i

)

[inline]

Length of i'th axis.

Definition at line 91 of file MSFitsInput.h.

References casa::HeaderDataUnit::dim(), and hdu_p.

Int casa::MSPrimaryGroupHolder::dims

(

)

[inline]

Number of dimensions.

Definition at line 87 of file MSFitsInput.h.

References casa::HeaderDataUnit::dims(), and hdu_p.

Int casa::MSPrimaryGroupHolder::gcount

(

)

const [inline]

Number of groups.

Definition at line 123 of file MSFitsInput.h.

References casa::PrimaryGroup< TYPE >::gcount(), pf, pl, and ps.

const FitsKeyword* casa::MSPrimaryGroupHolder::kw

(

const FITS::ReservedName &

n

)

[inline]

Keyword of given type.

Definition at line 111 of file MSFitsInput.h.

References hdu_p, and casa::HeaderDataUnit::kw().

ConstFitsKeywordList& casa::MSPrimaryGroupHolder::kwlist

(

)

[inline]

All keywords.

Definition at line 115 of file MSFitsInput.h.

References hdu_p, and casa::HeaderDataUnit::kwlist().

const FitsKeyword* casa::MSPrimaryGroupHolder::nextkw

(

)

[inline]

Advance to next keyword.

Definition at line 119 of file MSFitsInput.h.

References hdu_p, and casa::HeaderDataUnit::nextkw().

Double casa::MSPrimaryGroupHolder::operator()

(

Int

i

)

const [inline]

Get group data with index i, scaled and converted to Double.

Definition at line 143 of file MSFitsInput.h.

References pf, pl, and ps.

Double casa::MSPrimaryGroupHolder::parm

(

Int

i

)

[inline]

Get i'th parameter.

Definition at line 139 of file MSFitsInput.h.

References casa::PrimaryGroup< TYPE >::parm(), pf, pl, and ps.

Int casa::MSPrimaryGroupHolder::pcount

(

)

const [inline]

Number of parameters.

Definition at line 127 of file MSFitsInput.h.

References casa::PrimaryGroup< TYPE >::pcount(), pf, pl, and ps.

Char* casa::MSPrimaryGroupHolder::ptype

(

Int

i

)

const [inline]

Parameter type.

Definition at line 131 of file MSFitsInput.h.

References pf, pl, ps, and casa::PrimaryGroup< TYPE >::ptype().

Int casa::MSPrimaryGroupHolder::read

(

)

[inline]

Read the next group.

Definition at line 135 of file MSFitsInput.h.

References pf, pl, ps, and casa::PrimaryGroup< TYPE >::read().

---

Member Data Documentation

HeaderDataUnit* casa::MSPrimaryGroupHolder::hdu_p [private]

Definition at line 147 of file MSFitsInput.h.

Referenced by dim(), dims(), kw(), kwlist(), and nextkw().

PrimaryGroup<Float>* casa::MSPrimaryGroupHolder::pf [private]

Definition at line 150 of file MSFitsInput.h.

Referenced by cdelt(), crpix(), crval(), ctype(), gcount(), operator()(), parm(), pcount(), ptype(), and read().

PrimaryGroup<FitsLong>* casa::MSPrimaryGroupHolder::pl [private]

Definition at line 149 of file MSFitsInput.h.

Referenced by cdelt(), crpix(), crval(), ctype(), gcount(), operator()(), parm(), pcount(), ptype(), and read().

PrimaryGroup<Short>* casa::MSPrimaryGroupHolder::ps [private]

Definition at line 148 of file MSFitsInput.h.

Referenced by cdelt(), crpix(), crval(), ctype(), gcount(), operator()(), parm(), pcount(), ptype(), and read().

---

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

• msfits/MSFits/MSFitsInput.h