casacore
Public Member Functions | Private Attributes | List of all members
casacore::FITSExtInfo Class Reference

class FitsKeywordList; More...

#include <FITSImgParser.h>

Public Member Functions

 FITSExtInfo (const String &name, const uInt &extindex, const String &extname, const Int &extversion, const Bool &hasdata)
 Construct the object. More...
 
 FITSExtInfo ()
 Construct the object. More...
 
 FITSExtInfo (const FITSExtInfo &other)
 Copy constructor (reference semantics) More...
 
 ~FITSExtInfo ()
 Destructor does nothing. More...
 
FITSExtInfooperator= (const FITSExtInfo &other)
 Assignment (reference semantics). More...
 
Bool operator== (const FITSExtInfo &extinfo)
 Relational operator. More...
 
String get_extexpr (void)
 All extension information as a string. More...
 
String get_extname (void)
 Return the extension name. More...
 
Int get_extversion (void)
 Return the extension version. More...
 
Bool has_data (void)
 Return whether there is data. More...
 
void add_kwlist (FitsKeywordList &kwlist)
 Add a list of keywords. More...
 
FitsKeywordget_keyword (const String kname)
 Return a keyword. More...
 

Private Attributes

String name_p
 
uInt extindex_p
 
String extname_p
 
Int extversion_p
 
Bool hasdata_p
 
FitsKeywordList kwlist_p
 

Detailed Description

class FitsKeywordList;

Class for storing FITS Image extension information

Intended use:

Public interface

Review Status

Test programs:
tFITSImgParser

Etymology

The class stores the essential information on a FITS image extension.

Synopsis

The class stores the essential information on a FITS image extension, which is the FITS file name, the extension name, the extension version, the index within the FITS file.

Example

FITSImgParser fitsImg("in.fits");
FITSExtInfo extinfo("in.fits", 0, "SCI", 1, True);
Int index = fitsImg.get_index(extinfo); // get the index of extension "[SCI, 1]"
FITSExtInfo()
Construct the object.
int Int
Definition: aipstype.h:50
const Bool True
Definition: aipstype.h:43

Motivation

Helper class for accessing multi-extension FITS files.

Definition at line 216 of file FITSImgParser.h.

Constructor & Destructor Documentation

◆ FITSExtInfo() [1/3]

casacore::FITSExtInfo::FITSExtInfo ( const String name,
const uInt extindex,
const String extname,
const Int extversion,
const Bool hasdata 
)

Construct the object.

◆ FITSExtInfo() [2/3]

casacore::FITSExtInfo::FITSExtInfo ( )
inline

Construct the object.

Definition at line 224 of file FITSImgParser.h.

References casacore::False.

◆ FITSExtInfo() [3/3]

casacore::FITSExtInfo::FITSExtInfo ( const FITSExtInfo other)

Copy constructor (reference semantics)

◆ ~FITSExtInfo()

casacore::FITSExtInfo::~FITSExtInfo ( )

Destructor does nothing.

Member Function Documentation

◆ add_kwlist()

void casacore::FITSExtInfo::add_kwlist ( FitsKeywordList kwlist)

Add a list of keywords.

◆ get_extexpr()

String casacore::FITSExtInfo::get_extexpr ( void  )

All extension information as a string.

◆ get_extname()

String casacore::FITSExtInfo::get_extname ( void  )
inline

Return the extension name.

Definition at line 245 of file FITSImgParser.h.

References extname_p.

◆ get_extversion()

Int casacore::FITSExtInfo::get_extversion ( void  )
inline

Return the extension version.

Definition at line 248 of file FITSImgParser.h.

References extversion_p.

◆ get_keyword()

FitsKeyword* casacore::FITSExtInfo::get_keyword ( const String  kname)
inline

Return a keyword.

Definition at line 257 of file FITSImgParser.h.

References casacore::String::c_str(), and kwlist_p.

◆ has_data()

Bool casacore::FITSExtInfo::has_data ( void  )
inline

Return whether there is data.

Definition at line 251 of file FITSImgParser.h.

References hasdata_p.

◆ operator=()

FITSExtInfo& casacore::FITSExtInfo::operator= ( const FITSExtInfo other)

Assignment (reference semantics).

◆ operator==()

Bool casacore::FITSExtInfo::operator== ( const FITSExtInfo extinfo)

Relational operator.

Member Data Documentation

◆ extindex_p

uInt casacore::FITSExtInfo::extindex_p
private

Definition at line 261 of file FITSImgParser.h.

◆ extname_p

String casacore::FITSExtInfo::extname_p
private

Definition at line 262 of file FITSImgParser.h.

Referenced by get_extname().

◆ extversion_p

Int casacore::FITSExtInfo::extversion_p
private

Definition at line 263 of file FITSImgParser.h.

Referenced by get_extversion().

◆ hasdata_p

Bool casacore::FITSExtInfo::hasdata_p
private

Definition at line 264 of file FITSImgParser.h.

Referenced by has_data().

◆ kwlist_p

FitsKeywordList casacore::FITSExtInfo::kwlist_p
private

Definition at line 265 of file FITSImgParser.h.

Referenced by get_keyword().

◆ name_p

String casacore::FITSExtInfo::name_p
private

Definition at line 260 of file FITSImgParser.h.


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