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.3 CCfits::Column Class Reference 57 Parameters vals The output container. The function will resize this as necessary first,last the span of row numbers to read. nullValue pointer to value to be applied to undefined elements. 24.3.3.10 template void CCfits::Column::read ( std::valarray< S > & vals, long first, long last, S ∗ nullValue ) Retrieve data from a scalar column into a std::valarray, applying nullValue when relevant. If both nullValue and ∗nullValue are not 0, then any undefined values in the file will be converted to ∗nullValue when copied into the vals valarray. See cfitsio documentation for further details Parameters vals The output container. The function will resize this as necessary first,last the span of row numbers to read. nullValue pointer to value to be applied to undefined elements. 24.3.3.11 template void CCfits::Column::readArrays ( std::vector< std::valarray< S > > & vals, long first, long last ) return a set of rows of a vector column into a vector of valarrays Parameters vals The output container. The function will resize this as necessary first,last the span of row numbers to read. 24.3.3.12 template void CCfits::Column::readArrays ( std::vector< std::valarray< S > > & vals, long first, long last, S ∗ nullValue ) return a set of rows of a vector column into a container, setting undefined values Parameters vals The output container. The function will resize this as necessary first,last the span of row numbers to read. nullValue pointer to integer value regarded as undefined Generated on Tue Dec 6 2011 16:12:51 for CCfits by Doxygen

24.3 CCfits::Column Class Reference 58 24.3.3.13 void CCfits::Column::readData ( long firstRow = 1, long nelements = 1, long firstElem = 1 ) [pure virtual] Read (or reread) data from the disk into the Column object’s internal arrays. This function normally does not need to be called. See the resetRead function for an alternative way of performing a reread from disk. Parameters firstRow The first row to be read nelements The number of elements to read firstElem The number of the element on the first row to start at (ignored for scalar columns) 24.3.3.14 void CCfits::Column::resetRead ( ) [inline] reset the Column’s isRead flag to false This forces the data to be reread from the disk the next time a read command is called on the Column, rather than simply retrieving the data already stored in the Column object’s internal arrays. This may be useful for example if trying to reread a Column using a different nullValue argument than for an earlier read. 24.3.3.15 int CCfits::Column::rows ( ) const return the number of rows in the table. return number of rows in the Column 24.3.3.16 double CCfits::Column::scale ( ) const [inline] get TSCALn value TSCALn is used to convert a data array represented on disk in integer format as floating. Useful for compact storage of digitized data. 24.3.3.17 template void CCfits::Column::write ( const std::vector< S > & indata, long firstRow ) write a vector of values into a scalar column starting with firstRow Parameters indata The data to be written. firstRow The first row to be written Generated on Tue Dec 6 2011 16:12:51 for CCfits by Doxygen

24.3 <strong>CCfits</strong>::Column Class Reference 58<br />

24.3.3.13 void <strong>CCfits</strong>::Column::readData ( long firstRow = 1, long nelements = 1, long<br />

firstElem = 1 ) [pure virtual]<br />

Read (or reread) data from the disk into the Column object’s internal arrays.<br />

This function normally does not need to be called. See the resetRead function for an<br />

alternative way of performing a reread from disk.<br />

Parameters<br />

firstRow The first row to be read<br />

nelements The number of elements to read<br />

firstElem The number of the element on the first row to start at (ignored for scalar<br />

columns)<br />

24.3.3.14 void <strong>CCfits</strong>::Column::resetRead ( ) [inline]<br />

reset the Column’s isRead flag to false<br />

This forces the data to be reread from the disk the next time a read command is called<br />

on the Column, rather than simply retrieving the data already stored in the Column<br />

object’s internal arrays. This may be useful for example if trying to reread a Column<br />

using a different nullValue argument than for an earlier read.<br />

24.3.3.15 int <strong>CCfits</strong>::Column::rows ( ) const<br />

return the number of rows in the table.<br />

return number of rows in the Column<br />

24.3.3.16 double <strong>CCfits</strong>::Column::scale ( ) const [inline]<br />

get TSCALn value<br />

TSCALn is used to convert a data array represented on disk in integer format as floating.<br />

Useful for compact storage of digitized data.<br />

24.3.3.17 template void <strong>CCfits</strong>::Column::write ( const std::vector< S > &<br />

indata, long firstRow )<br />

write a vector of values into a scalar column starting with firstRow<br />

Parameters<br />

indata The data to be written.<br />

firstRow The first row to be written<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!