Abstract FITS image base class. More...

#include <GFitsImage.hpp>

Inheritance diagram for GFitsImage:

Public Member Functions
	GFitsImage (void)
	Void constructor. More...

	GFitsImage (const int &bitpix, const int &nx)
	1D image constructor More...

	GFitsImage (const int &bitpix, const int &nx, const int &ny)
	2D image constructor More...

	GFitsImage (const int &bitpix, const int &nx, const int &ny, const int &nz)
	3D image constructor More...

	GFitsImage (const int &bitpix, const int &nx, const int &ny, const int &nz, const int &nt)
	4D image constructor More...

	GFitsImage (const int &bitpix, const std::vector< int > &naxes)
	Constructor. More...

	GFitsImage (const GFitsImage &image)
	Copy constructor. More...

virtual	~GFitsImage (void)
	Destructor. More...

GFitsImage &	operator= (const GFitsImage &image)
	Assignment operator. More...

virtual void	clear (void)=0
	Clear object. More...

virtual GFitsImage *	clone (void) const =0
	Clones object. More...

virtual std::string	classname (void) const =0
	Return class name. More...

virtual void *	pixels (void)=0

virtual double	pixel (const int &ix) const =0

virtual double	pixel (const int &ix, const int &iy) const =0

virtual double	pixel (const int &ix, const int &iy, const int &iz) const =0

virtual double	pixel (const int &ix, const int &iy, const int &iz, const int &it) const =0

virtual int	type (void) const =0

HDUType	exttype (void) const
	Return extension type. More...

const int &	npix (void) const
	Return size of pixel array. More...

const int &	bitpix (void) const
	Return number of Bits per pixel (negative=floating point) More...

const int &	naxis (void) const
	Return dimension of image. More...

int	naxes (const int &axis) const
	Return dimension of an image axis. More...

const int &	anynul (void) const
	Return number of nul values encountered during loading. More...

void	nulval (const void *value)
	Set nul value. More...

const void *	nulval (void) const
	Return nul value. More...

std::string	print (const GChatter &chatter=NORMAL) const
	Print column information. More...

Public Member Functions inherited from GFitsHDU
	GFitsHDU (void)
	Void constructor. More...

	GFitsHDU (const GFitsHDU &hdu)
	Copy constructor. More...

virtual	~GFitsHDU (void)
	Destructor. More...

GFitsHDU &	operator= (const GFitsHDU &hdu)
	Assignment operator. More...

int	cards (void) const
	Return number of cards in HDU header. More...

const std::string &	extname (void) const
	Return extension name. More...

void	extname (const std::string &extname)
	Set HDU extension name (EXTNAME keyword) More...

const int &	extno (void) const
	Return extension number. More...

void	extno (const int &extno)
	Set extension number. More...

const GFitsHeader &	header (void) const
	Return extension header. More...

void	header (const GFitsHeader &header)
	Set extension header. More...

bool	has_card (const int &cardno) const
	Check existence of header card. More...

bool	has_card (const std::string &keyname) const
	Checks for presence of header card. More...

GFitsHeaderCard &	card (const int &cardno)
	Return header card. More...

const GFitsHeaderCard &	card (const int &cardno) const
	Return header card (const version) More...

GFitsHeaderCard &	card (const std::string &keyname)
	Return header card. More...

const GFitsHeaderCard &	card (const std::string &keyname) const
	Return header card (const version) More...

void	card (const GFitsHeaderCard &card)
	Append or update header card. More...

void	card (const std::string &keyname, const std::string &value, const std::string &comment)
	Append or update string value header card. More...

void	card (const std::string &keyname, const double &value, const std::string &comment)
	Append or update double precision value header card. More...

void	card (const std::string &keyname, const int &value, const std::string &comment)
	Append or update integer value header card. More...

void	card (const std::string &keyname, const bool &value, const std::string &comment)
	Append or update boolean value header card. More...

void	card (const std::string &keyname, const char *value, const std::string &comment)
	Append or update character value header card. More...

std::string	string (const std::string &keyname) const
	Return card value as string. More...

double	real (const std::string &keyname) const
	Return card value as double precision. More...

int	integer (const std::string &keyname) const
	Return card value as integer. More...

Public Member Functions inherited from GBase
virtual	~GBase (void)
	Destructor. More...

Protected Member Functions
void	init_members (void)
	Initialise class members. More...

void	copy_members (const GFitsImage &image)
	Copy class members. More...

void	free_members (void)
	Delete class members. More...

void	data_open (void *vptr)
	Open FITS image. More...

void	data_save (void)
	Save FITS image. More...

void	data_close (void)
	Close FITS image. More...

void	data_connect (void *vptr)
	Connect FITS image. More...

void	init_image_header (void)
	Initialise image header. More...

void	open_image (void *vptr)
	Open Image. More...

void	load_image (int datatype, const void pixels, const void nulval, int *anynul)
	Load FITS image. More...

void	save_image (int datatype, const void *pixels)
	Save FITS image. More...

void	fetch_data (void)
	Fetch image pixels. More...

int	offset (const int &ix) const
	Return pixel offset. More...

int	offset (const int &ix, const int &iy) const
	Return 2D pixel offset. More...

int	offset (const int &ix, const int &iy, const int &iz) const
	Return 3D pixel offset. More...

int	offset (const int &ix, const int &iy, const int &iz, const int &it) const
	Return 4D pixel offset. More...

virtual void	alloc_data (void)=0

virtual void	init_data (void)=0

virtual void	release_data (void)=0

virtual void	alloc_nulval (const void *value)=0

virtual void *	ptr_data (void)=0

virtual void *	ptr_nulval (void)=0

Protected Member Functions inherited from GFitsHDU
void	init_members (void)
	Initialise class members. More...

void	copy_members (const GFitsHDU &hdu)
	Copy class members. More...

void	free_members (void)
	Delete class members. More...

void	connect (void *fptr)
	Connect HDU to FITS file. More...

void	move_to_hdu (void)
	Move FITS file pointer to HDU. More...

HDUType	get_hdu_type (void) const
	Get HDU type from FITS file. More...

void	open (void *vptr, int hdunum)
	Open HDU. More...

void	save (void)
	Saves HDU. More...

std::string	print_hdu (const GChatter &chatter=NORMAL) const
	Print basic HDU information. More...

std::string	typecode (int type) const
	Return typecode as string. More...

Protected Attributes
int	m_bitpix
	Number of Bits/pixel. More...

int	m_naxis
	Image dimension. More...

long *	m_naxes
	Number of pixels in each dimension. More...

int	m_num_pixels
	Number of image pixels. More...

int	m_anynul
	Number of NULLs encountered. More...

Protected Attributes inherited from GFitsHDU
void *	m_fitsfile
	FITS file pointer pointing on actual HDU. More...

int	m_hdunum
	HDU number (starting from 0) More...

std::string	m_name
	HDU name (extname) More...

GFitsHeader	m_header
	HDU header. More...

Additional Inherited Members
Public Types inherited from GFitsHDU
enum	HDUType { HT_IMAGE = 0, HT_ASCII_TABLE = 1, HT_BIN_TABLE = 2 }

Detailed Description

Abstract FITS image base class.

This class defines the abstract interface for a FITS image.

Definition at line 43 of file GFitsImage.hpp.

Constructor & Destructor Documentation

GFitsImage::GFitsImage ( void )

Void constructor.

Construct instance of an empty image. No header cards are present in an empty image.

Definition at line 66 of file GFitsImage.cpp.

References init_members().

GFitsImage::GFitsImage	(	const int &	bitpix,
		const int &	nx
	)

1D image constructor

Parameters

[in]	bitpix	Number of Bits per pixel (negative is floating point).
[in]	nx	Number of pixels.

Construct 1D instance of GFitsImage by specifying the number of pixels. This method also adds the relevant header cards.

Definition at line 85 of file GFitsImage.cpp.

References bitpix(), init_image_header(), init_members(), m_bitpix, m_naxes, m_naxis, and m_num_pixels.

GFitsImage::GFitsImage	(	const int &	bitpix,
		const int &	nx,
		const int &	ny
	)

2D image constructor

Parameters

[in]	bitpix	Number of Bits per pixel (negative is floating point).
[in]	nx	Number of pixels in first dimension.
[in]	ny	Number of pixels in second dimension.

Construct 2D instance of GFitsImage by specifying the number of pixels in each dimension. This method also adds the relevant header cards.

Definition at line 119 of file GFitsImage.cpp.

References bitpix(), init_image_header(), init_members(), m_bitpix, m_naxes, m_naxis, and m_num_pixels.

GFitsImage::GFitsImage	(	const int &	bitpix,
		const int &	nx,
		const int &	ny,
		const int &	nz
	)

3D image constructor

Parameters

[in]	bitpix	Number of Bits per pixel (negative is floating point).
[in]	nx	Number of pixels in first dimension.
[in]	ny	Number of pixels in second dimension.
[in]	nz	Number of pixels in third dimension.

Construct 3D instance of GFitsImage by specifying the number of pixels in each dimension. This method also adds the relevant header cards.

Definition at line 156 of file GFitsImage.cpp.

References bitpix(), init_image_header(), init_members(), m_bitpix, m_naxes, m_naxis, and m_num_pixels.

GFitsImage::GFitsImage	(	const int &	bitpix,
		const int &	nx,
		const int &	ny,
		const int &	nz,
		const int &	nt
	)

4D image constructor

Parameters

[in]	bitpix	Number of Bits per pixel (negative is floating point).
[in]	nx	Number of pixels in first dimension.
[in]	ny	Number of pixels in second dimension.
[in]	nz	Number of pixels in third dimension.
[in]	nt	Number of pixels in forth dimension.

Construct 4D instance of GFitsImage by specifying the number of pixels in each dimension. This method also adds the relevant header cards.

Definition at line 195 of file GFitsImage.cpp.

References bitpix(), init_image_header(), init_members(), m_bitpix, m_naxes, m_naxis, and m_num_pixels.

GFitsImage::GFitsImage	(	const int &	bitpix,
		const std::vector< int > &	naxes
	)

Constructor.

Parameters

[in]	bitpix	Number of Bits per pixel (negative is floating point).
[in]	naxes	Vector of number of pixels in each dimension.

Construct instance of GFitsImage by specifying the image dimension and the number of pixels in each dimension. This method also adds the relevant header cards.

Definition at line 233 of file GFitsImage.cpp.

References bitpix(), init_image_header(), init_members(), m_bitpix, m_naxes, m_naxis, and m_num_pixels.

GFitsImage::GFitsImage ( const GFitsImage & image )

Copy constructor.

Parameters

[in] image FITS image.

Definition at line 268 of file GFitsImage.cpp.

References copy_members(), and init_members().

GFitsImage::~GFitsImage ( void )

virtual

Destructor.

Definition at line 284 of file GFitsImage.cpp.

References free_members().

Member Function Documentation

virtual void GFitsImage::alloc_data ( void )

protectedpure virtual

Implemented in GFitsImageByte, GFitsImageDouble, GFitsImageFloat, GFitsImageLong, GFitsImageLongLong, GFitsImageSByte, GFitsImageShort, GFitsImageULong, and GFitsImageUShort.

Referenced by fetch_data().

virtual void GFitsImage::alloc_nulval ( const void * value )

protectedpure virtual

Implemented in GFitsImageByte, GFitsImageDouble, GFitsImageFloat, GFitsImageLong, GFitsImageLongLong, GFitsImageSByte, GFitsImageShort, GFitsImageULong, and GFitsImageUShort.

Referenced by nulval().

const int & GFitsImage::anynul ( void ) const

inline

Return number of nul values encountered during loading.

Definition at line 166 of file GFitsImage.hpp.

References m_anynul.

const int & GFitsImage::bitpix ( void ) const

inline

Return number of Bits per pixel (negative=floating point)

Definition at line 146 of file GFitsImage.hpp.

References m_bitpix.

Referenced by GFitsImage(), and init_image_header().

virtual std::string GFitsImage::classname ( void ) const

pure virtual

Return class name.

Returns: String containing the class name.

Returns the class name for non-abstract classes in a human readable way.

Implements GFitsHDU.

Implemented in GFitsImageByte, GFitsImageDouble, GFitsImageFloat, GFitsImageLong, GFitsImageLongLong, GFitsImageSByte, GFitsImageShort, GFitsImageULong, and GFitsImageUShort.

virtual void GFitsImage::clear ( void )

pure virtual

Clear object.

Sets the object to a clean initial state. After calling the method the object will be in the same state as it were if an empty instance of the object would have been created.

Implements GFitsHDU.

Implemented in GFitsImageByte, GFitsImageDouble, GFitsImageFloat, GFitsImageLong, GFitsImageLongLong, GFitsImageSByte, GFitsImageShort, GFitsImageULong, and GFitsImageUShort.

virtual GFitsImage* GFitsImage::clone ( void ) const

pure virtual

Clones object.

Returns: Pointer to deep copy of object.

Creates a deep copy of the object and returns a pointer to the object.

Implements GFitsHDU.

Implemented in GFitsImageByte, GFitsImageDouble, GFitsImageFloat, GFitsImageLong, GFitsImageLongLong, GFitsImageSByte, GFitsImageShort, GFitsImageULong, and GFitsImageUShort.

void GFitsImage::copy_members ( const GFitsImage & image )

protected

Copy class members.

Parameters

[in] image FITS image to copy

Definition at line 461 of file GFitsImage.cpp.

References m_anynul, m_bitpix, m_naxes, m_naxis, and m_num_pixels.

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

void GFitsImage::data_close ( void )

protectedvirtual

Close FITS image.

Closing a FITS image resets the object into its initial state. Closing does NOT save the image into the FITS file. Use the save method for this purpose.

Todo:: Not sure that this is efficient at this level since the pixel array will not be deallocated!!!

Implements GFitsHDU.

Definition at line 542 of file GFitsImage.cpp.

References free_members(), and init_members().

void GFitsImage::data_connect ( void * vptr )

protectedvirtual

Connect FITS image.

Parameters

[in] vptr FITS file pointer

Connects a FITS file pointer to an image. This method actually does nothing since any GFitsImage can directly access the FITS file pointer that is stored in the GFitsHDU base class.

Implements GFitsHDU.

Definition at line 564 of file GFitsImage.cpp.

void GFitsImage::data_open ( void * vptr )

protectedvirtual

Open FITS image.

Parameters

[in] vptr FITS file pointer

Open FITS image in FITS file. Opening means connecting the FITS file pointer to the image and reading the image and axes dimensions.

Implements GFitsHDU.

Definition at line 507 of file GFitsImage.cpp.

References open_image().

void GFitsImage::data_save ( void )

protectedvirtual

Save FITS image.

Saves the image into the FITS file.

Implements GFitsHDU.

Definition at line 522 of file GFitsImage.cpp.

References pixels(), save_image(), and type().

GFitsHDU::HDUType GFitsImage::exttype ( void ) const

inlinevirtual

Return extension type.

Returns: Extension type (HT_IMAGE).

Implements GFitsHDU.

Definition at line 126 of file GFitsImage.hpp.

References GFitsHDU::HT_IMAGE.

Referenced by save_image().

void GFitsImage::fetch_data ( void )

protected

Fetch image pixels.

Fetch the image pixels. This function is in general called if pixel values should be read or written yet no pixel array is allocated. In case that pixels existed already before they will be deleted before fetching new ones. There are two possibilities to fetch the pixels: (1) In case that a FITS file is attached to the image, the pixel array will be loaded from the FITS file using the load_image() method. (2) In case that no FITS file is attached, a new pixel array will be allocated that is initalised to zero.

Definition at line 818 of file GFitsImage.cpp.

References alloc_data(), FPTR, init_data(), load_image(), m_anynul, GFitsHDU::m_fitsfile, m_num_pixels, ptr_data(), ptr_nulval(), and type().

Referenced by GFitsImageByte::copy_members(), GFitsImageFloat::copy_members(), GFitsImageLongLong::copy_members(), GFitsImageUShort::copy_members(), GFitsImageULong::copy_members(), GFitsImageSByte::copy_members(), GFitsImageDouble::copy_members(), GFitsImageShort::copy_members(), GFitsImageLong::copy_members(), GFitsImageLongLong::load_data(), GFitsImageDouble::load_data(), GFitsImageUShort::load_data(), GFitsImageSByte::load_data(), GFitsImageFloat::load_data(), GFitsImageULong::load_data(), GFitsImageLong::load_data(), GFitsImageByte::load_data(), and GFitsImageShort::load_data().

void GFitsImage::free_members ( void )

protected

Delete class members.

Definition at line 486 of file GFitsImage.cpp.

References m_naxes.

Referenced by GFitsImageByte::clear(), GFitsImageDouble::clear(), GFitsImageULong::clear(), GFitsImageLongLong::clear(), GFitsImageSByte::clear(), GFitsImageShort::clear(), GFitsImageLong::clear(), GFitsImageUShort::clear(), GFitsImageFloat::clear(), data_close(), operator=(), and ~GFitsImage().

virtual void GFitsImage::init_data ( void )

protectedpure virtual

Implemented in GFitsImageByte, GFitsImageDouble, GFitsImageFloat, GFitsImageLong, GFitsImageLongLong, GFitsImageSByte, GFitsImageShort, GFitsImageULong, and GFitsImageUShort.

Referenced by fetch_data().

void GFitsImage::init_image_header ( void )

protected

Initialise image header.

Initialises the image header by setting the default header cards. This method requires the members m_bitpix, m_naxis, and m_naxes to be set previously.

Definition at line 578 of file GFitsImage.cpp.

References GFitsHeader::append(), bitpix(), GFitsHDU::m_header, naxes(), and naxis().

Referenced by GFitsImage().

void GFitsImage::init_members ( void )

protected

Initialise class members.

Definition at line 442 of file GFitsImage.cpp.

References m_anynul, m_bitpix, m_naxes, m_naxis, and m_num_pixels.

Referenced by GFitsImageByte::clear(), GFitsImageDouble::clear(), GFitsImageULong::clear(), GFitsImageLongLong::clear(), GFitsImageSByte::clear(), GFitsImageShort::clear(), GFitsImageLong::clear(), GFitsImageUShort::clear(), GFitsImageFloat::clear(), data_close(), GFitsImage(), and operator=().

void GFitsImage::load_image	(	int	datatype,
		const void *	pixels,
		const void *	nulval,
		int *	anynul
	)

protected

Load FITS image.

Parameters

[in]	datatype	Datatype of pixels to be saved.
[in]	pixels	Pixel array to be saved.
[in]	nulval	Pointer to pixel nul value.
[out]	anynul	Number of nul values encountered during loading.

Exceptions

GException::fits_error FITS error.

Load image pixels from FITS file.

Definition at line 674 of file GFitsImage.cpp.

References __ffgsv, FPTR, G_LOAD_IMAGE, GFitsHDU::m_fitsfile, m_naxes, m_naxis, and GFitsHDU::move_to_hdu().

Referenced by fetch_data().

int GFitsImage::naxes ( const int & axis ) const

Return dimension of an image axis.

Parameters

[in] axis Image axis [0,...,naxis()-1].

Exceptions

GException::out_of_range Image axis not valid.

Definition at line 344 of file GFitsImage.cpp.

References G_NAXES, m_naxes, and naxis().

Referenced by GCOMIaq::compton_kinematics(), init_image_header(), GCOMIaq::klein_nishina(), GCOMIaq::location_smearing(), GCOMIaq::location_spread(), GCOMIaq::print(), print(), GCOMResponse::read(), GSkyMap::read_wcs(), GCOMDris::vetorate_load(), and GCOMIaq::weight_iaq().

const int & GFitsImage::naxis ( void ) const

inline

Return dimension of image.

Definition at line 156 of file GFitsImage.hpp.

References m_naxis.

Referenced by init_image_header(), naxes(), GCOMIaq::print(), print(), GCOMResponse::read(), and GSkyMap::read_wcs().

const int & GFitsImage::npix ( void ) const

inline

Return size of pixel array.

Definition at line 136 of file GFitsImage.hpp.

References m_num_pixels.

Referenced by GCOMIaq::print(), print(), and GCOMIaq::set().

void GFitsImage::nulval ( const void * value )

Set nul value.

Parameters

[in] value Nul value.

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

Definition at line 372 of file GFitsImage.cpp.

References alloc_nulval().

const void * GFitsImage::nulval ( void ) const

inline

Return nul value.

Definition at line 176 of file GFitsImage.hpp.

References ptr_nulval().

int GFitsImage::offset ( const int & ix ) const

protected

Return pixel offset.

Parameters

[in] ix Pixel index [0,...,m_num_pixels-1].

Exceptions

GException::out_of_range Pixel index is outside valid range.

Definition at line 847 of file GFitsImage.cpp.

References G_OFFSET_1D, and m_num_pixels.

Referenced by GFitsImageByte::at(), GFitsImageDouble::at(), GFitsImageLong::at(), GFitsImageULong::at(), GFitsImageUShort::at(), GFitsImageLongLong::at(), GFitsImageFloat::at(), GFitsImageSByte::at(), GFitsImageShort::at(), GFitsImageFloat::operator()(), GFitsImageUShort::operator()(), GFitsImageLongLong::operator()(), GFitsImageDouble::operator()(), GFitsImageShort::operator()(), GFitsImageULong::operator()(), GFitsImageByte::operator()(), GFitsImageSByte::operator()(), and GFitsImageLong::operator()().

int GFitsImage::offset	(	const int &	ix,
		const int &	iy
	)		const

protected

Return 2D pixel offset.

Parameters

[in]	ix	Pixel index in first dimension (starting from 0).
[in]	iy	Pixel index in second dimension (starting from 0).

Exceptions

GException::invalid_argument	Pixel array has less than 2 dimensions.
GException::out_of_range	Image axis not valid.

Computes of offset in the pixel array of a 2D coordinate. This method is only applicable to pixels arrays that have at least 2 dimenions.

Definition at line 875 of file GFitsImage.cpp.

References G_OFFSET_2D, m_naxes, m_naxis, and gammalib::str().

int GFitsImage::offset	(	const int &	ix,
		const int &	iy,
		const int &	iz
	)		const

protected

Return 3D pixel offset.

Parameters

[in]	ix	Pixel index in first dimension (starting from 0).
[in]	iy	Pixel index in second dimension (starting from 0).
[in]	iz	Pixel index in third dimension (starting from 0).

Exceptions

GException::invalid_argument	Pixel array has less than 3 dimensions.
GException::out_of_range	Image axis not valid.

Computes of offset in the pixel array of a 3D coordinate. This method is only applicable to pixels arrays that have at least 3 dimenions.

Definition at line 919 of file GFitsImage.cpp.

References G_OFFSET_3D, m_naxes, m_naxis, and gammalib::str().

int GFitsImage::offset	(	const int &	ix,
		const int &	iy,
		const int &	iz,
		const int &	it
	)		const

protected

Return 4D pixel offset.

Parameters

[in]	ix	Pixel index in first dimension (starting from 0).
[in]	iy	Pixel index in second dimension (starting from 0).
[in]	iz	Pixel index in third dimension (starting from 0).
[in]	it	Pixel index in forth dimension (starting from 0).

Exceptions

GException::invalid_argument	Pixel array has less than 4 dimensions.
GException::out_of_range	Image axis not valid.

Computes of offset in the pixel array of a 4D coordinate. This method is only applicable to pixels arrays that have at least 4 dimenions.

Definition at line 969 of file GFitsImage.cpp.

References G_OFFSET_4D, m_naxes, m_naxis, and gammalib::str().

void GFitsImage::open_image ( void * vptr )

protected

Open Image.

Parameters

[in] vptr FITS file void pointer.

Exceptions

GException::fits_error FITS error.

Open FITS image in FITS file. Opening means connecting the FITS file pointer to the image and reading the image and axes dimensions.

Definition at line 616 of file GFitsImage.cpp.

References __ffgidm, __ffgisz, gammalib::fits_move_to_hdu(), FPTR, FPTR_COPY, G_OPEN_IMAGE, GFitsHDU::m_fitsfile, GFitsHDU::m_hdunum, m_naxes, m_naxis, and m_num_pixels.

Referenced by data_open().

GFitsImage & GFitsImage::operator= ( const GFitsImage & image )

Assignment operator.

Parameters

[in] image FITS image.

Returns: FITS image.

Definition at line 306 of file GFitsImage.cpp.

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

Referenced by GFitsImageByte::operator=(), GFitsImageUShort::operator=(), GFitsImageULong::operator=(), GFitsImageShort::operator=(), GFitsImageSByte::operator=(), GFitsImageLongLong::operator=(), GFitsImageLong::operator=(), GFitsImageFloat::operator=(), and GFitsImageDouble::operator=().

virtual double GFitsImage::pixel ( const int & ix ) const

pure virtual

virtual double GFitsImage::pixel	(	const int &	ix,
		const int &	iy
	)		const

pure virtual

Implemented in GFitsImageByte, GFitsImageDouble, GFitsImageFloat, GFitsImageLong, GFitsImageLongLong, GFitsImageSByte, GFitsImageShort, GFitsImageULong, and GFitsImageUShort.

virtual double GFitsImage::pixel	(	const int &	ix,
		const int &	iy,
		const int &	iz
	)		const

pure virtual

Implemented in GFitsImageByte, GFitsImageDouble, GFitsImageFloat, GFitsImageLong, GFitsImageLongLong, GFitsImageSByte, GFitsImageShort, GFitsImageULong, and GFitsImageUShort.

virtual double GFitsImage::pixel	(	const int &	ix,
		const int &	iy,
		const int &	iz,
		const int &	it
	)		const

pure virtual

Implemented in GFitsImageByte, GFitsImageDouble, GFitsImageFloat, GFitsImageLong, GFitsImageLongLong, GFitsImageSByte, GFitsImageShort, GFitsImageULong, and GFitsImageUShort.

virtual void* GFitsImage::pixels ( void )

pure virtual

Implemented in GFitsImageByte, GFitsImageDouble, GFitsImageFloat, GFitsImageLong, GFitsImageLongLong, GFitsImageSByte, GFitsImageShort, GFitsImageULong, and GFitsImageUShort.

Referenced by data_save().

std::string GFitsImage::print ( const GChatter & chatter = NORMAL ) const

virtual

Print column information.

Parameters

[in] chatter Chattiness.

Returns: String containing column information.

Todo:: Format and cfitsio information is mainly for debugging. This could be vanish in a more stable version of the code, or it could be compiled in conditionally using a debug option.

Implements GFitsHDU.

Definition at line 395 of file GFitsImage.cpp.

References GFitsHDU::m_header, naxes(), naxis(), NORMAL, npix(), gammalib::parformat(), GFitsHeader::print(), GFitsHDU::print_hdu(), gammalib::reduce(), SILENT, gammalib::str(), type(), and GFitsHDU::typecode().

virtual void* GFitsImage::ptr_data ( void )

protectedpure virtual

Implemented in GFitsImageByte, GFitsImageDouble, GFitsImageFloat, GFitsImageLong, GFitsImageLongLong, GFitsImageSByte, GFitsImageShort, GFitsImageULong, and GFitsImageUShort.

Referenced by fetch_data().

virtual void* GFitsImage::ptr_nulval ( void )

protectedpure virtual

Implemented in GFitsImageByte, GFitsImageDouble, GFitsImageFloat, GFitsImageLong, GFitsImageLongLong, GFitsImageSByte, GFitsImageShort, GFitsImageULong, and GFitsImageUShort.

Referenced by fetch_data(), and nulval().

virtual void GFitsImage::release_data ( void )

protectedpure virtual

Implemented in GFitsImageByte, GFitsImageDouble, GFitsImageFloat, GFitsImageLong, GFitsImageLongLong, GFitsImageSByte, GFitsImageShort, GFitsImageULong, and GFitsImageUShort.

void GFitsImage::save_image	(	int	datatype,
		const void *	pixels
	)

protected

Save FITS image.

Parameters

[in]	datatype	Datatype of pixels to be saved
[in]	pixels	Pixel array to be saved

Exceptions

GException::runtime_error	No FITS file has been opened.
GException::fits_error	FITS error.

Save image pixels into FITS file. In case that the HDU does not exist it is created. In case that the pixel array is empty no data are saved; all image pixels will be empty in this case.

Definition at line 721 of file GFitsImage.cpp.

References __ffcrim, __ffdhdu, __ffghsp, __ffiimg, __ffmahd, __ffpss, __ffrsim, exttype(), FPTR, G_SAVE_IMAGE, m_bitpix, GFitsHDU::m_fitsfile, GFitsHDU::m_hdunum, m_naxes, m_naxis, and type().