/usr/include/casacore/images/Images/FITSImgParser.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 | //# FITSImgParser.h: Class for parsing multi-extension FITS images
//# Copyright (C) 2001,2002
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//# $Id$
#ifndef IMAGES_FITSImgParser_H
#define IMAGES_FITSImgParser_H
#include <casacore/casa/aips.h>
#include <casacore/fits/FITS/fits.h>
#include <casacore/casa/Arrays/Vector.h>
#include <casacore/casa/BasicSL/String.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class FITSExtInfo;
class HeaderDataUnit;
// <summary>
// Class for handling FITS Image extensions
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="" tests="tFITSImgParser.cc">
// </reviewed>
// <prerequisite>
// <li> <linkto class=FITSExtInfo>FITSExtInfo</linkto>
// <li> <linkto class=HeaderDataUnit>HeaderDataUnit</linkto>
// </prerequisite>
// <etymology>
// This class parses through a FITS image and stores essential information
// for each extension.
// </etymology>
// <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).
// </synopsis>
// <example>
// <srcblock>
// 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
// </srcblock>
// </example>
// <motivation>
// Investigate and select FITS extensions
// </motivation>
//# <todo asof="2011/08/16">
//# </todo>
class FITSImgParser
{
public:
// Construct a parser from the FITS file.
FITSImgParser(const String& name);
// Copy constructor (reference semantics).
FITSImgParser(const FITSImgParser& other);
// Destructor, does not much.
~FITSImgParser();
// Assignment (reference semantics).
FITSImgParser& operator=(const FITSImgParser& other);
// Returns the name of the disk file.
String fitsname (Bool stripPath=False) const;
// Identify the index of an extension.
Int get_index(const FITSExtInfo &extinfo);
// Find an extension; return -1 if not found.
Int find_extension(const String &extname, const Int &extversion=-1);
// Get the index of the first extension with data.
uInt get_firstdata_index(void);
// Get the number of extensions.
uInt get_numhdu(void) { return numhdu_p;};
// Get a string representation of the extension list.
String get_extlist_string(const String &delimiter, const String &qualmarker="",
const String &fitsmarker="", const Bool &listall=True);
// Get the flag indicating at least one quality image.
Bool has_qualityimg(void) {return qualimglist_p.size() > 0 ? True : False;};
// Check whether the extensions named in the extension expression
// can be loaded as a quality image.
Bool is_qualityimg(const String &extexpr);
// Find all necessary access information for the extensions to 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);
private:
String name_p;
uInt numhdu_p;
FITSExtInfo *extensions_p;
Vector<String> qualimglist_p;
Bool hasmeasurement_p;
static const char *storeKwords_p[];
static const int nKwords_p;
// Setup the object (used by constructors).
void setup(void);
// Get the information on an extension.
void process_extension(HeaderDataUnit *h, const uInt &extindex);
// Extract the list of extensions from the extension expression.
Bool get_extlist(const String &extexpr, Vector<String> &extlist);
// Get the first extension with HDU type "data" from the
// list of indices. Returns "-1" if there is none.
Int get_dataindex(const Vector<Int> &extindex);
// Get the error extension name for the given data extension.
String get_errorext(const Int &ext_index);
// Get the mask extension name for the given data extension.
String get_maskext(const Int &ext_index);
// Check the keywords with fixed values
Bool confirm_fix_keywords(const Int &ext_index);
// Check whether the extension has a certain HDU type.
Bool index_is_HDUtype(const Int &ext_index, const String &hdutype);
// Find and store all set of extensions
// that can be loaded as a quality image.
Bool find_qualimgs(void);
};
//class FitsKeywordList;
// <summary>
// Class for storing FITS Image extension information
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="" tests="tFITSImgParser.cc">
// </reviewed>
// <prerequisite>
// </prerequisite>
// <etymology>
// The class stores the essential information on a FITS
// image extension.
// </etymology>
// <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.
// </synopsis>
//
// <example>
// <srcblock>
// 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]"
// </srcblock>
// </example>
//
// <motivation>
// Helper class for accessing multi-extension FITS files.
// </motivation>
//
//# <todo asof="2011/02/17">
//# </todo>
class FITSExtInfo
{
public:
// Construct the object
FITSExtInfo(const String &name, const uInt &extindex, const String &extname,
const Int &extversion, const Bool &hasdata);
// Construct the object
FITSExtInfo()
{
FITSExtInfo("", 0, "", 0, False);
};
// Copy constructor (reference semantics)
FITSExtInfo(const FITSExtInfo& other);
// Destructor does nothing.
~FITSExtInfo();
// Assignment (reference semantics).
FITSExtInfo& operator=(const FITSExtInfo& other);
// Relational operator.
Bool operator==(const FITSExtInfo &extinfo);
// All extension information as a string.
String get_extexpr(void);
// Return the extension name.
String get_extname(void){return extname_p;};
// Return the extension version.
Int get_extversion(void){return extversion_p;};
// Return whether there is data.
Bool has_data(void){return hasdata_p;};
// Add a list of keywords.
void add_kwlist(FitsKeywordList &kwlist);
// Return a keyword.
FitsKeyword *get_keyword(const String kname){return kwlist_p(kname.c_str());};
private:
String name_p;
uInt extindex_p;
String extname_p;
Int extversion_p;
Bool hasdata_p;
FitsKeywordList kwlist_p;
};
} //# NAMESPACE CASACORE - END
#endif
|