CCfits  2.4
Public Member Functions | List of all members
CCfits::ImageExt< T > Class Template Reference
Inheritance diagram for CCfits::ImageExt< T >:
CCfits::ExtHDU CCfits::HDU

Public Member Functions

virtual ~ImageExt ()
 destructor
virtual ImageExt< T > * clone (FITSBase *p) const
 virtual copy constructor
const std::valarray< T > & image () const
 return the image data
virtual void readData (bool readFlag=false, const std::vector< String > &keys=std::vector< String >())
 read Image extension HDU data
virtual void scale (double value)
 set the BSCALE keyword value for images (see warning for images of int type)
virtual double scale () const
 return the BSCALE keyword value
virtual void zero (double value)
 set the BZERO keyword value for images (see warning for images of int type)
virtual double zero () const
 return the BZERO keyword value
- Public Member Functions inherited from CCfits::ExtHDU
 ExtHDU (const ExtHDU &right)
 copy constructor
virtual ~ExtHDU ()
 destructor
virtual void addColumn (ValueType type, const String &columnName, long repeatWidth, const String &colUnit=String(""), long decimals=-1, size_t columnNumber=0)
 add a new column to an existing table HDU.
virtual Columncolumn (const String &colName, bool caseSensitive=true) const
 return a reference to a Table column specified by name.
virtual Columncolumn (int colIndex) const
 return a reference to a Table column specified by column index.
virtual const std::map< string,
Column * > & 
column () const
 return a reference to the array containing the columns.
virtual void deleteColumn (const String &columnName)
 delete a column in a Table extension by name.
virtual long getRowsize () const
 return the optimal number of rows to read or write at a time
bool isCompressed () const
 return true if image is stored using compression.
virtual void makeThisCurrent () const
 move the fitsfile pointer to this current HDU.
const String & name () const
 return the name of the extension.
virtual int numCols () const
 return the number of Columns in the Table (the TFIELDS keyword).
template<typename S >
void read (std::valarray< S > &image)
 Read image data into container.
template<typename S >
void read (std::valarray< S > &image, long first, long nElements, S *nullValue)
 read part of an image array, processing null values.
template<typename S >
void read (std::valarray< S > &image, const std::vector< long > &first, long nElements, S *nullValue)
 read part of an image array, processing null values.
template<typename S >
void read (std::valarray< S > &image, const std::vector< long > &firstVertex, const std::vector< long > &lastVertex, const std::vector< long > &stride)
 read an image subset
template<typename S >
void read (std::valarray< S > &image, long first, long nElements)
 read an image section starting at a specified pixel
template<typename S >
void read (std::valarray< S > &image, const std::vector< long > &first, long nElements)
 read an image section starting at a location specified by an n-tuple
template<typename S >
void read (std::valarray< S > &image, const std::vector< long > &firstVertex, const std::vector< long > &lastVertex, const std::vector< long > &stride, S *nullValue)
 read an image subset into valarray image, processing null values
virtual long rows () const
 return the number of rows in the extension.
int version () const
 return the extension version number.
void version (int value)
 set the extension version number
template<typename S >
void write (const std::vector< long > &first, long nElements, const std::valarray< S > &data, S *nullValue)
 Write a set of pixels to an image extension with the first pixel specified by an n-tuple, processing undefined data.
template<typename S >
void write (long first, long nElements, const std::valarray< S > &data, S *nullValue)
 write array to image starting with a specified pixel and allowing undefined data to be processed
template<typename S >
void write (const std::vector< long > &first, long nElements, const std::valarray< S > &data)
 write array starting from specified n-tuple, without undefined data processing
template<typename S >
void write (long first, long nElements, const std::valarray< S > &data)
 write array starting from specified pixel number, without undefined data processing
template<typename S >
void write (const std::vector< long > &firstVertex, const std::vector< long > &lastVertex, const std::valarray< S > &data)
 write a subset (generalize slice) of data to the image
- Public Member Functions inherited from CCfits::HDU
 HDU (const HDU &right)
 copy constructor
template<typename T >
KeywordaddKey (const String &name, T val, const String &comment)
 create a new keyword in the HDU with specified value and comment fields
KeywordaddKey (const Keyword *inKeyword)
 create a copy of an existing Keyword and add to HDU
long axes () const
 return the number of axes in the HDU data section (always 2 for tables).
long axis (size_t index) const
 return the size of axis numbered index [zero based].
long bitpix () const
 return the data type keyword.
const string & comment () const
 return the comment string previously read by getComment()
void copyAllKeys (const HDU *inHdu)
 copy all keys from another header
void deleteKey (const String &doomed)
 delete a keyword from the header
fitsfile * fitsPointer () const
 return the fitsfile pointer for the FITS object containing the HDU
std::pair< unsigned long,
unsigned long > 
getChecksum () const
 compute and return the checksum values for the HDU without creating or modifying the CHECKSUM/DATASUM keywords.
const String & getComments ()
 read the comments from the HDU and add it to the FITS object.
const String & getHistory ()
 read the history information from the HDU and add it to the FITS object.
const string & history () const
 return the history string previously read by getHistory()
void index (int value)
 set the HDU number
int index () const
 return the HDU number
std::map< String, Keyword * > & keyWord ()
 return the associative array containing the HDU keywords so far read.
KeywordkeyWord (const String &keyName)
 return a (previously read) keyword from the HDU object.
const std::map< string,
Keyword * > & 
keyWord () const
 return the associative array containing the HDU Keywords that have been read so far.
const KeywordkeyWord (const string &keyname) const
 return a (previously read) keyword from the HDU object. const version
bool operator!= (const HDU &right) const
 inequality operator
bool operator== (const HDU &right) const
 equality operator
FITSBase * parent () const
 return reference to the pointer representing the FITSBase object containing the HDU
void readAllKeys ()
 read all of the keys in the header
template<typename T >
void readKey (const String &keyName, T &val)
 read a keyword of specified type from the header of a disk FITS file and return its value.
template<typename T >
void readKeys (std::vector< String > &keyNames, std::vector< T > &vals)
 read a set of specified keywords of the same data type from the header of a disk FITS file and return their values
void suppressScaling (bool toggle=true)
 turn off image scaling regardless of the BSCALE and BZERO keyword values
void updateChecksum ()
 update the CHECKSUM keyword value, assuming DATASUM exists and is correct
std::pair< int, int > verifyChecksum () const
 verify the HDU by computing the checksums and comparing them with the CHECKSUM/DATASUM keywords
void writeChecksum ()
 compute and write the DATASUM and CHECKSUM keyword values
void writeComment (const String &comment="Generic Comment")
 write a comment string.
void writeDate ()
 write a date string to *this.
void writeHistory (const String &history="Generic History String")
 write a history string.

Additional Inherited Members

- Static Public Member Functions inherited from CCfits::ExtHDU
static void readHduName (const fitsfile *fptr, int hduIndex, String &hduName, int &hduVersion)
 read extension name.
- Protected Member Functions inherited from CCfits::ExtHDU
 ExtHDU (FITSBase *p, HduType xtype, const String &hduName, int version)
 default constructor, required as Standard Library Container content.
 ExtHDU (FITSBase *p, HduType xtype, const String &hduName, int bitpix, int naxis, const std::vector< long > &axes, int version)
 writing constructor.
 ExtHDU (FITSBase *p, HduType xtype, int number)
 ExtHDU constructor for getting ExtHDUs by number.
long gcount () const
 return required gcount keyword value
void gcount (long value)
 set required gcount keyword value
long pcount () const
 return required pcount keyword value
void pcount (long value)
 set required pcount keyword value
HduType xtension () const
 return the extension type
void xtension (HduType value)
 set the extension type

Detailed Description

template<typename T>
class CCfits::ImageExt< T >

ImageExt<T> is a subclass of ExtHDU that contains image data of type T.

Member Function Documentation

template<typename T >
void CCfits::ImageExt< T >::readData ( bool  readFlag = false,
const std::vector< String > &  keys = std::vector<String>() 
)
virtual

read Image extension HDU data

Called by FITS ctor, not intended for general use. parameters control how much gets read on initialization.

Parameters
readFlagread the image data if true
keya vector of strings of keyword names to be read from the HDU

Implements CCfits::ExtHDU.

template<typename T >
void CCfits::ImageExt< T >::scale ( double  value)
virtual

set the BSCALE keyword value for images (see warning for images of int type)

For primary HDUs and image extensions, this will add (or update) the BSCALE keyword in the header. The new setting will affect future image array read/writes as described in section 4.7 Data Scaling of the CFITSIO manual. For table extensions this function does nothing.

WARNING: If the image contains integer-type data (as indicated by the bitpix() return value), the new scale and zero value combination must not be such that the scaled data would require a floating-point type (this uses the CFITSIO function fits_get_img_equivtype to make the determination). If this situation occurs, the function will throw a FitsException.

Reimplemented from CCfits::HDU.

template<typename T >
void CCfits::ImageExt< T >::zero ( double  value)
virtual

set the BZERO keyword value for images (see warning for images of int type)

For primary HDUs and image extensions, this will add (or update) the BZERO keyword in the header. The new setting will affect future image array read/writes as described in section 4.7 Data Scaling of the CFITSIO manual. For table extensions this function does nothing.

WARNING: If the image contains integer-type data (as indicated by the bitpix() return value), the new scale and zero value combination must not be such that the scaled data would require a floating-point type (this uses the CFITSIO function fits_get_img_equivtype to make the determination). If this situation occurs, the function will throw a FitsException.

Reimplemented from CCfits::HDU.


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