GammaLib  2.0.0.dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GFitsTableFloatCol Class Reference

FITS table float column. More...

#include <GFitsTableFloatCol.hpp>

Inheritance diagram for GFitsTableFloatCol:
GFitsTableCol GBase

Public Member Functions

 GFitsTableFloatCol (void)
 Constructor. More...
 
 GFitsTableFloatCol (const std::string &name, const int &nrows, const int &size=1)
 Constructor. More...
 
 GFitsTableFloatCol (const GFitsTableFloatCol &column)
 Copy constructor. More...
 
virtual ~GFitsTableFloatCol (void)
 Destructor. More...
 
GFitsTableFloatColoperator= (const GFitsTableFloatCol &column)
 Assignment operator. More...
 
float & operator() (const int &row, const int &inx=0)
 Column data access operator. More...
 
const float & operator() (const int &row, const int &inx=0) const
 Column data access operator (const variant) More...
 
virtual void clear (void)
 Clear instance. More...
 
virtual GFitsTableFloatColclone (void) const
 Clone column. More...
 
virtual std::string classname (void) const
 Return class name. More...
 
virtual std::string string (const int &row, const int &col=0) const
 Get string value. More...
 
virtual double real (const int &row, const int &col=0) const
 Get double precision value. More...
 
virtual int integer (const int &row, const int &col=0) const
 Get integer value. More...
 
virtual void insert (const int &row, const int &nrows)
 Insert rows in column. More...
 
virtual void remove (const int &row, const int &nrows)
 Remove rows from column. More...
 
virtual bool is_loaded (void) const
 Checks if column has been loaded. More...
 
float * data (void)
 Returns pointer to column data. More...
 
float * nulval (void)
 Returns pointer to nul value. More...
 
void nulval (const float *value)
 Set nul value. More...
 
- Public Member Functions inherited from GFitsTableCol
 GFitsTableCol (void)
 Void constructor. More...
 
 GFitsTableCol (const std::string &name, const int &nrows, const int &number, const int &width)
 Column constructor. More...
 
 GFitsTableCol (const GFitsTableCol &column)
 Copy constructor. More...
 
virtual ~GFitsTableCol (void)
 Destructor. More...
 
GFitsTableColoperator= (const GFitsTableCol &column)
 Assignment operator. More...
 
void name (const std::string &name)
 Set column name. More...
 
const std::string & name (void) const
 Returns column name. More...
 
void unit (const std::string &unit)
 Set column unit. More...
 
const std::string & unit (void) const
 Returns column unit. More...
 
void dim (const std::vector< int > &dim)
 Set column dimension. More...
 
const std::vector< int > & dim (void) const
 Returns column dimension. More...
 
void colnum (const int &colnum)
 Set column number. More...
 
const int & colnum (void) const
 Returns column number in FITS file (starting from 1) More...
 
void type (const int &type)
 Set type code. More...
 
const int & type (void) const
 Returns CFITSIO column type. More...
 
void repeat (const int &repeat)
 Set repeat value. More...
 
const int & repeat (void) const
 Returns column repeat value (only used for binary tables) More...
 
void width (const int &width)
 Set width in Bytes of one column element. More...
 
const int & width (void) const
 Return width in Bytes of one column element. More...
 
void number (const int &number)
 Set number of elements in column. More...
 
const int & number (void) const
 Returns number of elements in column. More...
 
void elements (const int &row, const int &elements)
 Set number of column elements for specific row. More...
 
int elements (const int &row) const
 Returns number of elements in column for specific row. More...
 
void nrows (const int &nrows)
 Set number of rows in column. More...
 
const int & nrows (void) const
 Returns number of rows in column. More...
 
void is_variable (const bool &variable)
 Set variable-length flag. More...
 
const bool & is_variable (void) const
 Signals if column is of variable length. More...
 
void anynul (const int &anynul)
 Set number of NULLs encountered. More...
 
const int & anynul (void) const
 Returns number of NULLs encountered. More...
 
void scale (const double &tscale, const double &tzero) const
 Set table column scale value. More...
 
std::string tform_binary (void) const
 Returns TFORM code for binary table column. More...
 
std::string print (const GChatter &chatter=NORMAL) const
 Print column information. More...
 
- Public Member Functions inherited from GBase
virtual ~GBase (void)
 Destructor. More...
 

Private Member Functions

void init_members (void)
 Initialise class members. More...
 
void copy_members (const GFitsTableFloatCol &column)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
void alloc_nulval (const float *value)
 Allocates null value. More...
 
virtual void alloc_data (void)
 Allocates column data. More...
 
virtual void init_data (void)
 Initialise column data. More...
 
virtual void fetch_data (void) const
 Fetch column data. More...
 
virtual void resize_data (const int &index, const int &number)
 Resize column data. More...
 
virtual void release_data (void)
 Release column data. More...
 
virtual void * ptr_data (const int &index=0)
 Returns void pointer to column data. More...
 
virtual void * ptr_nulval (void)
 Returns void pointer to nul value. More...
 
virtual std::string ascii_format (void) const
 Returns format string of ASCII table. More...
 

Private Attributes

float * m_data
 Data vector. More...
 
float * m_nulval
 NULL value. More...
 

Additional Inherited Members

- Protected Member Functions inherited from GFitsTableCol
void init_members (void)
 Initialise class members. More...
 
void copy_members (const GFitsTableCol &column)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
void connect (void *vptr)
 Connect table column to FITS file. More...
 
virtual void save (void)
 Save table column into FITS file. More...
 
virtual void load_column (void)
 Load table column from FITS file. More...
 
virtual void load_column_fixed (void)
 Load fixed-length column from FITS file. More...
 
virtual void load_column_variable (void)
 Load variable-length column from FITS file. More...
 
virtual void save_column (void)
 Save table column into FITS file. More...
 
virtual void save_column_fixed (void)
 Save table column into FITS file. More...
 
virtual void save_column_variable (void)
 Save table column into FITS file. More...
 
virtual int offset (const int &row, const int &inx) const
 Compute offset of column element in memory. More...
 
- Protected Attributes inherited from GFitsTableCol
std::string m_name
 Column name. More...
 
std::string m_unit
 Column unit. More...
 
std::vector< int > m_dim
 Column dimension. More...
 
int m_colnum
 Column number (starting from 1). This parameter is used to signal if a table column corresponds to a FITS file column. If it is set to 0 there is no correspondence. More...
 
int m_type
 Column type. More...
 
int m_repeat
 Repeat value of column. More...
 
int m_width
 Width in Bytes of single column element. More...
 
int m_number
 Number of elements in column. More...
 
int m_length
 Length of column (number of rows) More...
 
bool m_variable
 Signals if column is variable length. More...
 
int m_varlen
 Maximum number of elements in variable-length. More...
 
std::vector< int > m_rowstart
 Start index of each row. More...
 
int m_size
 Size of allocated data area (0 if not loaded) More...
 
int m_anynul
 Number of NULLs encountered. More...
 
void * m_fitsfile
 FITS file pointer associated with column. More...
 

Detailed Description

FITS table float column.

This class implements a FITS table float column.

Definition at line 42 of file GFitsTableFloatCol.hpp.

Constructor & Destructor Documentation

GFitsTableFloatCol::GFitsTableFloatCol ( void  )

Constructor.

Definition at line 57 of file GFitsTableFloatCol.cpp.

References init_members().

Referenced by clone().

GFitsTableFloatCol::GFitsTableFloatCol ( const std::string &  name,
const int &  nrows,
const int &  size = 1 
)

Constructor.

Parameters
[in]nameName of column.
[in]nrowsNumber of rows in column.
[in]sizeVector size of column.

Definition at line 74 of file GFitsTableFloatCol.cpp.

References init_members().

GFitsTableFloatCol::GFitsTableFloatCol ( const GFitsTableFloatCol column)

Copy constructor.

Parameters
[in]columnTable column.

Definition at line 92 of file GFitsTableFloatCol.cpp.

References copy_members(), and init_members().

GFitsTableFloatCol::~GFitsTableFloatCol ( void  )
virtual

Destructor.

Definition at line 109 of file GFitsTableFloatCol.cpp.

References free_members().

Member Function Documentation

void GFitsTableFloatCol::alloc_data ( void  )
privatevirtual

Allocates column data.

Implements GFitsTableCol.

Definition at line 597 of file GFitsTableFloatCol.cpp.

References m_data, and GFitsTableCol::m_size.

Referenced by copy_members(), and insert().

void GFitsTableFloatCol::alloc_nulval ( const float *  value)
private

Allocates null value.

Definition at line 713 of file GFitsTableFloatCol.cpp.

References m_nulval.

Referenced by copy_members(), and nulval().

std::string GFitsTableFloatCol::ascii_format ( void  ) const
privatevirtual

Returns format string of ASCII table.

Implements GFitsTableCol.

Definition at line 578 of file GFitsTableFloatCol.cpp.

std::string GFitsTableFloatCol::classname ( void  ) const
inlinevirtual

Return class name.

Returns
String containing the class name ("GFitsTableFloatCol").

Implements GFitsTableCol.

Definition at line 102 of file GFitsTableFloatCol.hpp.

void GFitsTableFloatCol::clear ( void  )
virtual

Clear instance.

This method properly resets the object to an initial state.

Implements GFitsTableCol.

Definition at line 202 of file GFitsTableFloatCol.cpp.

References free_members(), GFitsTableCol::free_members(), init_members(), and GFitsTableCol::init_members().

GFitsTableFloatCol * GFitsTableFloatCol::clone ( void  ) const
virtual

Clone column.

Implements GFitsTableCol.

Definition at line 220 of file GFitsTableFloatCol.cpp.

References GFitsTableFloatCol().

void GFitsTableFloatCol::copy_members ( const GFitsTableFloatCol column)
private

Copy class members.

Parameters
[in]columnColumn.

Sets the content of the vector column by copying from another column. If the code is compiled with the small memory option, and if the source column has not yet been loaded, then we only load the column temporarily for copying purposes and release it again once copying is finished.

Definition at line 517 of file GFitsTableFloatCol.cpp.

References alloc_data(), alloc_nulval(), fetch_data(), is_loaded(), m_data, m_nulval, GFitsTableCol::m_rowstart, GFitsTableCol::m_size, GFitsTableCol::m_type, GFitsTableCol::m_varlen, and release_data().

Referenced by GFitsTableFloatCol(), and operator=().

float * GFitsTableFloatCol::data ( void  )
inline

Returns pointer to column data.

Returns
Pointer to column data.

Definition at line 126 of file GFitsTableFloatCol.hpp.

References m_data.

void GFitsTableFloatCol::fetch_data ( void  ) const
privatevirtual

Fetch column data.

Implements GFitsTableCol.

Definition at line 618 of file GFitsTableFloatCol.cpp.

References GFitsTableCol::load_column().

Referenced by copy_members(), insert(), integer(), operator()(), real(), remove(), resize_data(), and string().

void GFitsTableFloatCol::free_members ( void  )
private

Delete class members.

Definition at line 557 of file GFitsTableFloatCol.cpp.

References m_data, m_nulval, and GFitsTableCol::m_size.

Referenced by clear(), operator=(), and ~GFitsTableFloatCol().

void GFitsTableFloatCol::init_data ( void  )
privatevirtual

Initialise column data.

Implements GFitsTableCol.

Definition at line 735 of file GFitsTableFloatCol.cpp.

References m_data, and GFitsTableCol::m_size.

Referenced by insert().

void GFitsTableFloatCol::init_members ( void  )
private

Initialise class members.

Definition at line 495 of file GFitsTableFloatCol.cpp.

References __TFLOAT, m_data, m_nulval, and GFitsTableCol::m_type.

Referenced by clear(), GFitsTableFloatCol(), and operator=().

void GFitsTableFloatCol::insert ( const int &  row,
const int &  nrows 
)
virtual

Insert rows in column.

Parameters
[in]rowRow after which rows should be inserted (0=first row).
[in]nrowsNumber of rows to be inserted.
Exceptions
GException::fits_invalid_rowSpecified row is invalid.

Inserts rows into a FITS table. This implies that all columns will be loaded into memory.

Implements GFitsTableCol.

Definition at line 298 of file GFitsTableFloatCol.cpp.

References alloc_data(), fetch_data(), G_INSERT, init_data(), m_data, GFitsTableCol::m_length, GFitsTableCol::m_number, GFitsTableCol::m_size, and GFitsTableCol::nrows().

int GFitsTableFloatCol::integer ( const int &  row,
const int &  inx = 0 
) const
virtual

Get integer value.

Parameters
[in]rowTable row.
[in]inxTable column vector index.

Returns value of specified row and vector index as integer.

Implements GFitsTableCol.

Definition at line 273 of file GFitsTableFloatCol.cpp.

References fetch_data(), m_data, and GFitsTableCol::offset().

bool GFitsTableFloatCol::is_loaded ( void  ) const
inlinevirtual

Checks if column has been loaded.

Returns
True if column has been loaded, false otherwise

Implements GFitsTableCol.

Definition at line 114 of file GFitsTableFloatCol.hpp.

References m_data.

Referenced by copy_members().

float * GFitsTableFloatCol::nulval ( void  )
inline

Returns pointer to nul value.

Returns
Pointer to nul value.

Definition at line 138 of file GFitsTableFloatCol.hpp.

References m_nulval.

void GFitsTableFloatCol::nulval ( const float *  value)

Set nul value.

Parameters
[in]valueNul value.
Todo:
To correctly reflect the nul value in the data, the column should be reloaded. However, the column may have been changed, so in principle saving is needed. However, we may not want to store the data, hence saving is also not desired. We thus have to develop a method to update the column information for a new nul value in place ...

Definition at line 470 of file GFitsTableFloatCol.cpp.

References alloc_nulval().

float & GFitsTableFloatCol::operator() ( const int &  row,
const int &  inx = 0 
)

Column data access operator.

Parameters
[in]rowRow of column to access.
[in]inxVector index in column row to access.

Provides access to data in a column.

Definition at line 163 of file GFitsTableFloatCol.cpp.

References fetch_data(), m_data, and GFitsTableCol::offset().

const float & GFitsTableFloatCol::operator() ( const int &  row,
const int &  inx = 0 
) const

Column data access operator (const variant)

Parameters
[in]rowRow of column to access.
[in]inxVector index in column row to access.

Provides access to data in a column.

Definition at line 181 of file GFitsTableFloatCol.cpp.

References fetch_data(), m_data, and GFitsTableCol::offset().

GFitsTableFloatCol & GFitsTableFloatCol::operator= ( const GFitsTableFloatCol column)

Assignment operator.

Parameters
[in]columnTable column.
Returns
Table column.

Definition at line 131 of file GFitsTableFloatCol.cpp.

References copy_members(), free_members(), init_members(), and GFitsTableCol::operator=().

void * GFitsTableFloatCol::ptr_data ( const int &  index = 0)
inlineprivatevirtual

Returns void pointer to column data.

Returns
Void pointer to column data.

Implements GFitsTableCol.

Definition at line 150 of file GFitsTableFloatCol.hpp.

References m_data.

void * GFitsTableFloatCol::ptr_nulval ( void  )
inlineprivatevirtual

Returns void pointer to nul value.

Returns
Void pointer to nul value.

Implements GFitsTableCol.

Definition at line 162 of file GFitsTableFloatCol.hpp.

References m_nulval.

double GFitsTableFloatCol::real ( const int &  row,
const int &  inx = 0 
) const
virtual

Get double precision value.

Parameters
[in]rowTable row.
[in]inxTable column vector index.

Returns value of specified row and vector index as double precision.

Implements GFitsTableCol.

Definition at line 252 of file GFitsTableFloatCol.cpp.

References fetch_data(), m_data, and GFitsTableCol::offset().

void GFitsTableFloatCol::release_data ( void  )
privatevirtual

Release column data.

Implements GFitsTableCol.

Definition at line 696 of file GFitsTableFloatCol.cpp.

References m_data, and GFitsTableCol::m_size.

Referenced by copy_members(), and resize_data().

void GFitsTableFloatCol::remove ( const int &  row,
const int &  nrows 
)
virtual

Remove rows from column.

Parameters
[in]rowRow after which rows should be removed (0=first row).
[in]nrowsNumber of rows to be removed.
Exceptions
GException::fits_invalid_rowSpecified row is invalid.
GException::fits_invalid_nrowsInvalid number of rows specified.

This method removes rows from a FITS table. This implies that the column will be loaded into memory.

Implements GFitsTableCol.

Definition at line 383 of file GFitsTableFloatCol.cpp.

References fetch_data(), G_REMOVE, m_data, GFitsTableCol::m_length, GFitsTableCol::m_number, GFitsTableCol::m_size, and GFitsTableCol::nrows().

void GFitsTableFloatCol::resize_data ( const int &  index,
const int &  number 
)
privatevirtual

Resize column data.

Parameters
[in]indexStart index.
[in]numberNumber of elements to add/remove.

Adds or removes elements from specified index on. Adding is done if number is a positive number, removing if number is negative. Note that the method does not change the validity of the arguments. This needs to be done by the client.

Implements GFitsTableCol.

Definition at line 639 of file GFitsTableFloatCol.cpp.

References fetch_data(), gammalib::left(), m_data, GFitsTableCol::m_size, GFitsTableCol::number(), and release_data().

std::string GFitsTableFloatCol::string ( const int &  row,
const int &  inx = 0 
) const
virtual

Get string value.

Parameters
[in]rowTable row.
[in]inxTable column vector index.

Returns value of specified row and vector index as string.

Implements GFitsTableCol.

Definition at line 234 of file GFitsTableFloatCol.cpp.

References fetch_data(), m_data, GFitsTableCol::offset(), and gammalib::str().

Member Data Documentation

float* GFitsTableFloatCol::m_data
private
float* GFitsTableFloatCol::m_nulval
private

NULL value.

Definition at line 92 of file GFitsTableFloatCol.hpp.

Referenced by alloc_nulval(), copy_members(), free_members(), init_members(), nulval(), and ptr_nulval().


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