CCfits - HEASARC - NASA

CCfits - HEASARC - NASA CCfits - HEASARC - NASA

heasarc.gsfc.nasa.gov
from heasarc.gsfc.nasa.gov More from this publisher
27.01.2015 Views

24.12 CCfits::ExtHDU Class Reference 77 Exceptions WrongExtensionType thrown if ∗this is an image extension. Reimplemented in CCfits::Table. 24.12.3.4 const map< string, Column ∗ > & CCfits::ExtHDU::column ( ) const [virtual] return a reference to the array containing the columns. Exceptions WrongExtensionType thrown if ∗this is an image extension. Reimplemented in CCfits::Table. 24.12.3.5 void CCfits::ExtHDU::deleteColumn ( const String & columnName ) [virtual] delete a column in a Table extension by name. Parameters column- Name The name of the column to be deleted. Exceptions WrongExtensionType if extension is an image. Reimplemented in CCfits::Table. 24.12.3.6 long CCfits::ExtHDU::getRowsize ( ) const [virtual] return the optimal number of rows to read or write at a time A wrapper for the CFITSIO function fits_get_rowsize, useful for obtaining maximum I/O efficiency. This will throw if it is not called for a Table extension. Reimplemented in CCfits::Table. 24.12.3.7 bool CCfits::ExtHDU::isCompressed ( ) const return true if image is stored using compression. This is simply a wrapper around the CFITSIO fits_is_compressed_image function. It will throw if this is not an Image extension. Generated on Tue Dec 6 2011 16:12:51 for CCfits by Doxygen

24.12 CCfits::ExtHDU Class Reference 78 24.12.3.8 void CCfits::ExtHDU::makeThisCurrent ( ) const [virtual] move the fitsfile pointer to this current HDU. This function should never need to be called by the user since it is called internally whenever required. Reimplemented from CCfits::HDU. 24.12.3.9 int CCfits::ExtHDU::numCols ( ) const [virtual] return the number of Columns in the Table (the TFIELDS keyword). Exceptions WrongExtensionType thrown if ∗this is an image extension. Reimplemented in CCfits::Table. 24.12.3.10 template void CCfits::ExtHDU::read ( std::valarray< S > & image ) Read image data into container. The container image contains the entire image array after the call. This and all the other variants of read() throw a WrongExtensionType exception if called for a Table object. 24.12.3.11 template void CCfits::ExtHDU::read ( std::valarray< S > & image, long first, long nElements, S ∗ nullValue ) read part of an image array, processing null values. Implicit data conversion is supported (i.e. user does not need to know the type of the data stored. A WrongExtensionType extension is thrown if ∗this is not an image. Parameters image The receiving container, a std::valarray reference first The first pixel from the array to read [a long value] nElements The number of values to read nullValue A pointer containing the value in the table to be considered as undefined. See cfitsio for details 24.12.3.12 template void CCfits::ExtHDU::read ( std::valarray< S > & image, const std::vector< long > & first, long nElements, S ∗ nullValue ) read part of an image array, processing null values. As above except for Generated on Tue Dec 6 2011 16:12:51 for CCfits by Doxygen

24.12 <strong>CCfits</strong>::ExtHDU Class Reference 78<br />

24.12.3.8 void <strong>CCfits</strong>::ExtHDU::makeThisCurrent ( ) const [virtual]<br />

move the fitsfile pointer to this current HDU.<br />

This function should never need to be called by the user since it is called internally<br />

whenever required.<br />

Reimplemented from <strong>CCfits</strong>::HDU.<br />

24.12.3.9 int <strong>CCfits</strong>::ExtHDU::numCols ( ) const [virtual]<br />

return the number of Columns in the Table (the TFIELDS keyword).<br />

Exceptions<br />

WrongExtensionType thrown if ∗this is an image extension.<br />

Reimplemented in <strong>CCfits</strong>::Table.<br />

24.12.3.10 template void <strong>CCfits</strong>::ExtHDU::read ( std::valarray< S > & image )<br />

Read image data into container.<br />

The container image contains the entire image array after the call. This and all the other<br />

variants of read() throw a WrongExtensionType exception if called for a Table object.<br />

24.12.3.11 template void <strong>CCfits</strong>::ExtHDU::read ( std::valarray< S > & image,<br />

long first, long nElements, S ∗ nullValue )<br />

read part of an image array, processing null values.<br />

Implicit data conversion is supported (i.e. user does not need to know the type of the<br />

data stored. A WrongExtensionType extension is thrown if ∗this is not an image.<br />

Parameters<br />

image The receiving container, a std::valarray reference<br />

first The first pixel from the array to read [a long value]<br />

nElements The number of values to read<br />

nullValue A pointer containing the value in the table to be considered as undefined.<br />

See cfitsio for details<br />

24.12.3.12 template void <strong>CCfits</strong>::ExtHDU::read ( std::valarray< S > & image,<br />

const std::vector< long > & first, long nElements, S ∗ nullValue )<br />

read part of an image array, processing null values.<br />

As above except for<br />

Generated on Tue Dec 6 2011 16:12:51 for <strong>CCfits</strong> by Doxygen

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!