#include <FITSImgParser.h>

Public Member Functions
	FITSImgParser (const String &name)
	Construct a parser from the FITS file.

	FITSImgParser (const FITSImgParser &other)
	Copy constructor (reference semantics).

	~FITSImgParser ()
	Destructor, does not much.

FITSImgParser &	operator= (const FITSImgParser &other)
	Assignment (reference semantics).

String	fitsname (Bool stripPath=False) const
	Returns the name of the disk file.

Int	get_index (const FITSExtInfo &extinfo)
	Identify the index of an extension.

Int	find_extension (const String &extname, const Int &extversion=-1)
	Find an extension; return -1 if not found.

uInt	get_firstdata_index (void)
	Get the index of the first extension with data.

uInt	get_numhdu (void)
	Get the number of extensions.

String	get_extlist_string (const String &delimiter, const String &qualmarker="", const String &fitsmarker="", const Bool &listall=True)
	Get a string representation of the extension list.

Bool	has_qualityimg (void)
	Get the flag indicating at least one quality image.

Bool	is_qualityimg (const String &extexpr)
	Check whether the extensions named in the extension expression can be loaded as a quality image.

Bool	get_quality_data (const String &extexpr, Int &data_HDU, Int &error_HDU, String &error_type, Int &mask_HDU, String &mask_type, Int &mask_value)
	Find all necessary access information for the extensions to be loaded as a quality image.

Private Member Functions
void	setup (void)
	Setup the object (used by constructors).

void	process_extension (HeaderDataUnit *h, const uInt &extindex)
	Get the information on an extension.

Bool	get_extlist (const String &extexpr, Vector< String > &extlist)
	Extract the list of extensions from the extension expression.

Int	get_dataindex (const Vector< Int > &extindex)
	Get the first extension with HDU type "data" from the list of indices.

String	get_errorext (const Int &ext_index)
	Get the error extension name for the given data extension.

String	get_maskext (const Int &ext_index)
	Get the mask extension name for the given data extension.

Bool	confirm_fix_keywords (const Int &ext_index)
	Check the keywords with fixed values.

Bool	index_is_HDUtype (const Int &ext_index, const String &hdutype)
	Check whether the extension has a certain HDU type.

Bool	find_qualimgs (void)
	Find and store all set of extensions that can be loaded as a quality image.

Private Attributes
String	name_p

uInt	numhdu_p

FITSExtInfo *	extensions_p

Vector< String >	qualimglist_p

Bool	hasmeasurement_p

Static Private Attributes
static const char *	storeKwords_p []

static const int	nKwords_p

Detailed Description

Class for handling FITS Image extensions

Intended use:

Public interface

Review Status

Test programs:: tFITSImgParser

Prerequisite

Etymology

This class parses through a FITS image and stores essential information for each extension.

Synopsis

The class parses through a FITS image and extracts information on its extensions, e.g. the extension name and the extension version. It is possible to identify a certain extension and to get the its extension index.

It is also explored whether some of the FITS extensions can be loaded as a quality image (data + error + mask).

Example

FITSImgParser fitsImg("in.fits");
uInt numHDU    = fitsImg.get_numhdu();                // get the total number of HDU's
uInt firstdata = fitsImg.get_firstdata_index();       // get the first HDU with data
String allExts = fitsImg.get_extlist_string(String("\n"));  // get a string representation of all extensions
String hasQual = fitsImg.has_qualityimg();            // check whether some of the extensions form quality image

Motivation

Investigate and select FITS extensions

Definition at line 86 of file FITSImgParser.h.

Constructor & Destructor Documentation

◆ FITSImgParser() [1/2]

casacore::FITSImgParser::FITSImgParser ( const String & name )

Construct a parser from the FITS file.

◆ FITSImgParser() [2/2]

casacore::FITSImgParser::FITSImgParser ( const FITSImgParser & other )

Copy constructor (reference semantics).

◆ ~FITSImgParser()

casacore::FITSImgParser::~FITSImgParser ( )

Destructor, does not much.

Member Function Documentation

◆ confirm_fix_keywords()

Bool casacore::FITSImgParser::confirm_fix_keywords ( const Int & ext_index )

private

Check the keywords with fixed values.

◆ find_extension()

Int casacore::FITSImgParser::find_extension	(	const String &	extname,
		const Int &	extversion = `-1`
	)

Find an extension; return -1 if not found.

◆ find_qualimgs()

Bool casacore::FITSImgParser::find_qualimgs ( void )

private

Find and store all set of extensions that can be loaded as a quality image.

◆ fitsname()

String casacore::FITSImgParser::fitsname ( Bool stripPath = False ) const

Returns the name of the disk file.

◆ get_dataindex()

Int casacore::FITSImgParser::get_dataindex ( const Vector< Int > & extindex )

private

Get the first extension with HDU type "data" from the list of indices.

Returns "-1" if there is none.

◆ get_errorext()

String casacore::FITSImgParser::get_errorext ( const Int & ext_index )

private

Get the error extension name for the given data extension.

◆ get_extlist()

Bool casacore::FITSImgParser::get_extlist	(	const String &	extexpr,
		Vector< String > &	extlist
	)

private

Extract the list of extensions from the extension expression.

◆ get_extlist_string()

String casacore::FITSImgParser::get_extlist_string	(	const String &	delimiter,
		const String &	qualmarker = `""`,
		const String &	fitsmarker = `""`,
		const Bool &	listall = `True`
	)

Get a string representation of the extension list.

◆ get_firstdata_index()

uInt casacore::FITSImgParser::get_firstdata_index ( void )

Get the index of the first extension with data.

◆ get_index()

Int casacore::FITSImgParser::get_index ( const FITSExtInfo & extinfo )

Identify the index of an extension.

◆ get_maskext()

String casacore::FITSImgParser::get_maskext ( const Int & ext_index )

private

Get the mask extension name for the given data extension.

◆ get_numhdu()

uInt casacore::FITSImgParser::get_numhdu ( void )

inline

Get the number of extensions.

Definition at line 114 of file FITSImgParser.h.

References numhdu_p.

◆ get_quality_data()

Bool casacore::FITSImgParser::get_quality_data	(	const String &	extexpr,
		Int &	data_HDU,
		Int &	error_HDU,
		String &	error_type,
		Int &	mask_HDU,
		String &	mask_type,
		Int &	mask_value
	)

Find all necessary access information for the extensions to be loaded as a quality image.

◆ has_qualityimg()

Bool casacore::FITSImgParser::has_qualityimg ( void )

inline

Get the flag indicating at least one quality image.

Definition at line 121 of file FITSImgParser.h.

References casacore::False, qualimglist_p, and casacore::True.

◆ index_is_HDUtype()

Bool casacore::FITSImgParser::index_is_HDUtype	(	const Int &	ext_index,
		const String &	hdutype
	)

private

Check whether the extension has a certain HDU type.

◆ is_qualityimg()

Bool casacore::FITSImgParser::is_qualityimg ( const String & extexpr )

Check whether the extensions named in the extension expression can be loaded as a quality image.

◆ operator=()

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

Assignment (reference semantics).

◆ process_extension()

void casacore::FITSImgParser::process_extension	(	HeaderDataUnit *	h,
		const uInt &	extindex
	)

private

Get the information on an extension.

◆ setup()

void casacore::FITSImgParser::setup ( void )

private

Setup the object (used by constructors).

Member Data Documentation

◆ extensions_p

FITSExtInfo* casacore::FITSImgParser::extensions_p

private

Definition at line 136 of file FITSImgParser.h.

◆ hasmeasurement_p

Bool casacore::FITSImgParser::hasmeasurement_p

private

Definition at line 139 of file FITSImgParser.h.

◆ name_p

String casacore::FITSImgParser::name_p

private

Definition at line 133 of file FITSImgParser.h.

◆ nKwords_p

const int casacore::FITSImgParser::nKwords_p

staticprivate

Definition at line 142 of file FITSImgParser.h.

◆ numhdu_p

uInt casacore::FITSImgParser::numhdu_p

private

Definition at line 134 of file FITSImgParser.h.

Referenced by get_numhdu().

◆ qualimglist_p

Vector<String> casacore::FITSImgParser::qualimglist_p

private

Definition at line 137 of file FITSImgParser.h.

Referenced by has_qualityimg().

◆ storeKwords_p

const char* casacore::FITSImgParser::storeKwords_p[]

staticprivate

Definition at line 141 of file FITSImgParser.h.

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

images/Images/FITSImgParser.h

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Example

Motivation

Constructor & Destructor Documentation

◆ FITSImgParser() [1/2]

◆ FITSImgParser() [2/2]

◆ ~FITSImgParser()

Member Function Documentation

◆ confirm_fix_keywords()

◆ find_extension()

◆ find_qualimgs()

◆ fitsname()

◆ get_dataindex()

◆ get_errorext()

◆ get_extlist()

◆ get_extlist_string()

◆ get_firstdata_index()

◆ get_index()

◆ get_maskext()

◆ get_numhdu()

◆ get_quality_data()

◆ has_qualityimg()

◆ index_is_HDUtype()

◆ is_qualityimg()

◆ operator=()

◆ process_extension()

◆ setup()

Member Data Documentation

◆ extensions_p

◆ hasmeasurement_p

◆ name_p

◆ nKwords_p

◆ numhdu_p

◆ qualimglist_p

◆ storeKwords_p