GammaLib
2.0.0
|
FITS table double complex column. More...
#include <GFitsTableCDoubleCol.hpp>
Public Member Functions | |
GFitsTableCDoubleCol (void) | |
Constructor. More... | |
GFitsTableCDoubleCol (const std::string &name, const int &nrows, const int &size=1) | |
Constructor. More... | |
GFitsTableCDoubleCol (const GFitsTableCDoubleCol &column) | |
Copy constructor. More... | |
virtual | ~GFitsTableCDoubleCol (void) |
Destructor. More... | |
GFitsTableCDoubleCol & | operator= (const GFitsTableCDoubleCol &column) |
Assignment operator. More... | |
GFits::cdouble & | operator() (const int &row, const int &inx=0) |
Column data access operator. More... | |
const GFits::cdouble & | operator() (const int &row, const int &inx=0) const |
Column data access operator (const variant) More... | |
virtual void | clear (void) |
Clear instance. More... | |
virtual GFitsTableCDoubleCol * | clone (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 (real part) More... | |
virtual int | integer (const int &row, const int &col=0) const |
Get integer value (real part) 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... | |
GFits::cdouble * | data (void) |
Returns pointer to column data. More... | |
GFits::cdouble * | nulval (void) |
Returns pointer to nul value. More... | |
void | nulval (const GFits::cdouble *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... | |
GFitsTableCol & | operator= (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 |
Return number of NULLs encountered. More... | |
void | tscale (const double &tscale) |
Set TSCALE value. More... | |
const double & | tscale (void) const |
Return TSCALE 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 GFitsTableCDoubleCol &column) |
Copy class members. More... | |
void | free_members (void) |
Delete class members. More... | |
void | alloc_nulval (const GFits::cdouble *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 | |
GFits::cdouble * | m_data |
Data vector. More... | |
GFits::cdouble * | 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... | |
double | m_tscale |
Optional scaling factor (1 = no scaling) More... | |
FITS table double complex column.
This class implements a FITS table double complex column.
Definition at line 43 of file GFitsTableCDoubleCol.hpp.
GFitsTableCDoubleCol::GFitsTableCDoubleCol | ( | void | ) |
Constructor.
Definition at line 57 of file GFitsTableCDoubleCol.cpp.
References init_members().
Referenced by clone().
GFitsTableCDoubleCol::GFitsTableCDoubleCol | ( | const std::string & | name, |
const int & | nrows, | ||
const int & | size = 1 |
||
) |
Constructor.
[in] | name | Name of column. |
[in] | nrows | Number of rows in column. |
[in] | size | Vector size of column. |
Definition at line 74 of file GFitsTableCDoubleCol.cpp.
References init_members().
GFitsTableCDoubleCol::GFitsTableCDoubleCol | ( | const GFitsTableCDoubleCol & | column | ) |
Copy constructor.
[in] | column | Table column. |
Definition at line 92 of file GFitsTableCDoubleCol.cpp.
References copy_members(), and init_members().
|
virtual |
|
privatevirtual |
Allocates column data.
Implements GFitsTableCol.
Definition at line 606 of file GFitsTableCDoubleCol.cpp.
References m_data, and GFitsTableCol::m_size.
Referenced by copy_members(), and insert().
|
private |
Allocates null value.
Definition at line 724 of file GFitsTableCDoubleCol.cpp.
References m_nulval.
Referenced by copy_members(), and nulval().
|
privatevirtual |
Returns format string of ASCII table.
Implements GFitsTableCol.
Definition at line 587 of file GFitsTableCDoubleCol.cpp.
References GFitsTableCol::m_width, and gammalib::str().
|
inlinevirtual |
Return class name.
Implements GFitsTableCol.
Definition at line 103 of file GFitsTableCDoubleCol.hpp.
|
virtual |
Clear instance.
This method properly resets the object to an initial state.
Implements GFitsTableCol.
Definition at line 203 of file GFitsTableCDoubleCol.cpp.
References free_members(), GFitsTableCol::free_members(), init_members(), and GFitsTableCol::init_members().
|
virtual |
Clone column.
Implements GFitsTableCol.
Definition at line 221 of file GFitsTableCDoubleCol.cpp.
References GFitsTableCDoubleCol().
|
private |
Copy class members.
[in] | column | Table column. |
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 526 of file GFitsTableCDoubleCol.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 GFitsTableCDoubleCol(), and operator=().
|
inline |
Returns pointer to column data.
Definition at line 127 of file GFitsTableCDoubleCol.hpp.
References m_data.
|
privatevirtual |
Fetch column data.
Implements GFitsTableCol.
Definition at line 627 of file GFitsTableCDoubleCol.cpp.
References GFitsTableCol::load_column().
Referenced by copy_members(), insert(), integer(), operator()(), real(), remove(), resize_data(), and string().
|
private |
Delete class members.
Definition at line 566 of file GFitsTableCDoubleCol.cpp.
References m_data, m_nulval, and GFitsTableCol::m_size.
Referenced by clear(), operator=(), and ~GFitsTableCDoubleCol().
|
privatevirtual |
Initialise column data.
Implements GFitsTableCol.
Definition at line 746 of file GFitsTableCDoubleCol.cpp.
References GFits::cdouble::im, m_data, GFitsTableCol::m_size, and GFits::cdouble::re.
Referenced by insert().
|
private |
Initialise class members.
Definition at line 504 of file GFitsTableCDoubleCol.cpp.
References __TDBLCOMPLEX, m_data, m_nulval, and GFitsTableCol::m_type.
Referenced by clear(), GFitsTableCDoubleCol(), and operator=().
|
virtual |
Insert rows in column.
[in] | row | Row after which rows should be inserted (0=first row). |
[in] | nrows | Number of rows to be inserted. |
GException::out_of_range | Specified row is invalid. |
Inserts rows into a FITS table. This implies that all columns will be loaded into memory.
Implements GFitsTableCol.
Definition at line 303 of file GFitsTableCDoubleCol.cpp.
References alloc_data(), fetch_data(), G_INSERT, GFits::cdouble::im, init_data(), m_data, GFitsTableCol::m_length, GFitsTableCol::m_number, GFitsTableCol::m_size, GFitsTableCol::nrows(), and GFits::cdouble::re.
|
virtual |
Get integer value (real part)
[in] | row | Table row. |
[in] | inx | Table column vector index. |
Returns value of specified row and vector index as integer.
Implements GFitsTableCol.
Definition at line 278 of file GFitsTableCDoubleCol.cpp.
References fetch_data(), m_data, GFitsTableCol::offset(), and GFits::cdouble::re.
|
inlinevirtual |
Checks if column has been loaded.
Implements GFitsTableCol.
Definition at line 115 of file GFitsTableCDoubleCol.hpp.
References m_data.
Referenced by copy_members().
|
inline |
Returns pointer to nul value.
Definition at line 139 of file GFitsTableCDoubleCol.hpp.
References m_nulval.
void GFitsTableCDoubleCol::nulval | ( | const GFits::cdouble * | value | ) |
Set nul value.
[in] | value | Nul value. |
Definition at line 479 of file GFitsTableCDoubleCol.cpp.
References alloc_nulval().
GFits::cdouble & GFitsTableCDoubleCol::operator() | ( | const int & | row, |
const int & | inx = 0 |
||
) |
Column data access operator.
[in] | row | Row of column to access. |
[in] | inx | Vector index in column row to access. |
Provides access to data in a column.
Definition at line 163 of file GFitsTableCDoubleCol.cpp.
References fetch_data(), m_data, and GFitsTableCol::offset().
const GFits::cdouble & GFitsTableCDoubleCol::operator() | ( | const int & | row, |
const int & | inx = 0 |
||
) | const |
Column data access operator (const variant)
[in] | row | Row of column to access. |
[in] | inx | Vector index in column row to access. |
Provides access to data in a column.
Definition at line 181 of file GFitsTableCDoubleCol.cpp.
References fetch_data(), m_data, and GFitsTableCol::offset().
GFitsTableCDoubleCol & GFitsTableCDoubleCol::operator= | ( | const GFitsTableCDoubleCol & | column | ) |
Assignment operator.
[in] | column | Table column. |
Definition at line 131 of file GFitsTableCDoubleCol.cpp.
References copy_members(), free_members(), init_members(), and GFitsTableCol::operator=().
|
inlineprivatevirtual |
Returns void pointer to column data.
Implements GFitsTableCol.
Definition at line 151 of file GFitsTableCDoubleCol.hpp.
References m_data.
|
inlineprivatevirtual |
Returns void pointer to nul value.
Implements GFitsTableCol.
Definition at line 163 of file GFitsTableCDoubleCol.hpp.
References m_nulval.
|
virtual |
Get double precision value (real part)
[in] | row | Table row. |
[in] | inx | Table column vector index. |
Returns value of specified row and vector index as double precision.
Implements GFitsTableCol.
Definition at line 257 of file GFitsTableCDoubleCol.cpp.
References fetch_data(), m_data, GFitsTableCol::offset(), and GFits::cdouble::re.
|
privatevirtual |
Release column data.
Implements GFitsTableCol.
Definition at line 707 of file GFitsTableCDoubleCol.cpp.
References m_data, and GFitsTableCol::m_size.
Referenced by copy_members(), and resize_data().
|
virtual |
Remove rows from column.
[in] | row | Row after which rows should be removed (0=first row). |
[in] | nrows | Number of rows to be removed. |
GException::out_of_range | Specified row is invalid. Invalid 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 390 of file GFitsTableCDoubleCol.cpp.
References fetch_data(), G_REMOVE, m_data, GFitsTableCol::m_length, GFitsTableCol::m_number, GFitsTableCol::m_size, and GFitsTableCol::nrows().
|
privatevirtual |
Resize column data.
[in] | index | Start index. |
[in] | number | Number 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 648 of file GFitsTableCDoubleCol.cpp.
References fetch_data(), GFits::cdouble::im, gammalib::left(), m_data, GFitsTableCol::m_size, GFitsTableCol::number(), GFits::cdouble::re, and release_data().
|
virtual |
Get string value.
[in] | row | Table row. |
[in] | inx | Table column vector index. |
Returns value of specified row and vector index as string.
Implements GFitsTableCol.
Definition at line 235 of file GFitsTableCDoubleCol.cpp.
References fetch_data(), m_data, GFitsTableCol::offset(), and gammalib::str().
|
private |
Data vector.
Definition at line 92 of file GFitsTableCDoubleCol.hpp.
Referenced by alloc_data(), copy_members(), data(), free_members(), init_data(), init_members(), insert(), integer(), is_loaded(), operator()(), ptr_data(), real(), release_data(), remove(), resize_data(), and string().
|
private |
NULL value.
Definition at line 93 of file GFitsTableCDoubleCol.hpp.
Referenced by alloc_nulval(), copy_members(), free_members(), init_members(), nulval(), and ptr_nulval().