ifw::odp::ImageWrapper< T > Class Template Reference

This is the base class that provides the interface to wrap images from shared memory areas. Currently it provides the only method which is common for its children classes. More...

#include <imageWrapper.hpp>

Inheritance diagram for ifw::odp::ImageWrapper< T >:

Public Member Functions
	ImageWrapper ()
	Class constructor.
	ImageWrapper (const ImageWrapper &image)
	Copy constructor.
	ImageWrapper (const cpl_size xsize, const cpl_size ysize)
	Class constructor.
	ImageWrapper (const ImageWrapper &image, const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury)
	Copy constructor.
virtual	~ImageWrapper ()
	Class destructor.
virtual void	Unload ()
	Unwrap CPL image.
virtual bool	IsWrapped () const
	Check if image was created around a pixel buffer.
virtual void	SetWrap (bool status)
	Set wrapped flag.
virtual void	Save (const char *filename)
	Saves image into a FITS file.
virtual void	Save (const char *filename, cpl_type_bpp type_bpp)
	Saves image into a FITS file of a specific data type.
virtual void	Read (T *data_ptr, cpl_size width, cpl_size height)
	Wrap data from a data buffer.
Public Member Functions inherited from ifw::odp::Image
	Image ()
	Class constructor.
	Image (const cpl_size size_x, const cpl_size size_y, const cpl_type type)
	Class constructor.
	Image (const Image &image)
	Copy constructor.
	Image (const Mask &mask)
	Copy constructor.
	Image (const Image &image, cpl_type type)
	Copy constructor.
	Image (const Image &image, const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury)
	Copy constructor.
	Image (const Mask &mask, const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury)
	Copy constructor.
	Image (const Image *image, const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury)
	Copy constructor.
	Image (const Image *image, const cpl_size startx, const cpl_size starty, const cpl_size size_single_det_x, const cpl_size size_single_det_y, const cpl_size size_gap_x, const cpl_size size_gap_y)
	Copy constructor.
virtual	~Image ()
	Class destructor.
void	GetImagePtr (void **data_ptr) const
	Get pointer to image data.
cpl_size	GetTypeSize () const
	Get size of the image built-in type.
void *	GetImagePtr () const
	Get pointer to image data.
cpl_size	GetWidth () const
	Get image width.
cpl_size	GetHeight () const
	Get image height.
cpl_size	GetSize () const
	Get image size.
bool	IsImage () const
	Check is CPL image is valid.
bool	Status () const
	Get image status.
cpl_type	GetCplType () const
	Get CPL image type.
cpl_image *	GetCplImage () const
	Get CPL image.
void	SetCplImage (cpl_image *image)
	Set CPL image.
void	Copy (const Image &, const cpl_size pos_x, const cpl_size pos_y)
	Copy input image object in the coordinates specified.
void	Save (const std::string filename, cpl_type type=CPL_TYPE_FLOAT)
	Save CPL image into a FITS file.
void	Load (const std::string filename, const cpl_size plane=0, const cpl_size extension=0, cpl_type type=CPL_TYPE_UNSPECIFIED)
	Load CPL image from a FITS file.
void	Load (const std::string filename, const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury, const cpl_size plane=0, const cpl_size extension=0, cpl_type type=CPL_TYPE_UNSPECIFIED)
	Load CPL image from a FITS file subwindow.
void	Unload ()
	Release CPL image.
double	Get (cpl_size xpos, cpl_size ypos) const
	Get the value of a pixel at a given position.
void	Get (cpl_size xpos, cpl_size ypos, double *value)
	Get the value of a pixel at a given position.
void	Set (cpl_size xpos, cpl_size ypos, double value)
	Set the value of a pixel at a given position.
void	SetBadPixelMap (const Mask &mask)
	Set the bad pixel map.
cpl_size	CountBadPixelMap ()
	Count the bad pixels.
void	Exponential (const double base)
	Computes the image exponential.
void	Logarithm (const double base)
	Computes the image logarithm.
void	Power (const double exponent)
	Computes the image power.
void	Absolute ()
	Computes the image absolute.
void	Normalise (cpl_norm norm=CPL_NORM_SCALE)
	Normalize the CPL image.
void	Turn (int rotation=-1)
	Rotate CPL image.
void	FFT (Image *imaginary, unsigned mode=CPL_FFT_DEFAULT)
	Fast Fourier Transfor of a CPL image.
void	Threshold (double lo_cut, double hi_cut, double assign_lo_cut, double assign_hi_cut)
	Threshold a CPL image to a given interval.
void	Rebin (cpl_size xstart, cpl_size ystart, cpl_size xstep, cpl_size ystep, Image &new_image)
	Image rebin.
void	FillNoise (const double min_pix, const double max_pix)
	It generates a CPL image with uniform random noise distribution.
void	FillGaussian (const double cen_x, const double cen_y, const double norm, const double sigma_x, const double sigma_y)
	It generates an image from a 2d gaussian function.
Image &	operator+ (const double)
	Overload operator+.
Image &	operator+ (const Image &)
	Overload operator+.
Image &	operator- (const double)
	Overload operator-.
Image &	operator- (const Image &)
	Overload operator-.
Image &	operator/ (const double)
	Overload operator/.
Image &	operator/ (const Image &)
	Overload operator/.
Image &	operator* (const double)
	Overload operator*.
Image &	operator* (const Image &)
	Overload operator*.
Image &	operator+= (const double)
	Overload operator+=.
Image &	operator+= (const Image &)
	Overload operator+=.
Image &	operator-= (const double)
	Overload operator-=.
Image &	operator-= (const Image &)
	Overload operator-=.
Image &	operator/= (const double)
	Overload operator/=.
Image &	operator/= (const Image &)
	Overload operator/=.
Image &	operator*= (const double)
	Overload operator*=.
Image &	operator*= (const Image &)
	Overload operator*=.
Image &	operator= (const Image &)
	Overload operator=.
bool	operator== (const Image &) const
	Overload operator==.
bool	operator!= (const Image &) const
	Overload operator!=.
Public Member Functions inherited from ifw::odp::Error
	Error ()
	Class constructor.
virtual	~Error ()
	Class destructor.
void	ResetCplError ()
	Reset CPL error and internal error flag.
bool	CheckCplError () const
	Check if there is an error in CPL.

Protected Attributes
T *	m_data
	Object buffer to store copied or casted shared memory areas.
Protected Attributes inherited from ifw::odp::Image
cpl_type	m_cpl_type
cpl_image *	m_cpl_image

Additional Inherited Members
Protected Member Functions inherited from ifw::odp::Error
std::string	GetErrorMsg () const
	Get CPL error message.

Detailed Description

template<typename T>
class ifw::odp::ImageWrapper< T >

This is the base class that provides the interface to wrap images from shared memory areas. Currently it provides the only method which is common for its children classes.

ImageWrapper - Template class for wrapping images from memory.

See also

odp::Image

Constructor & Destructor Documentation

ImageWrapper() [1/4]

template<typename T >

ifw::odp::ImageWrapper< T >::ImageWrapper

(

)

Class constructor.

Returns

none

ImageWrapper() [2/4]

template<typename T >

ifw::odp::ImageWrapper< T >::ImageWrapper

(

const ImageWrapper< T > &

image

)

Copy constructor.

Parameters

[in]

image

Reference to the image to be copied

Returns

none

ImageWrapper() [3/4]

template<typename T >

ifw::odp::ImageWrapper< T >::ImageWrapper	(	const cpl_size	xsize,
		const cpl_size	ysize )

Class constructor.

Parameters

[in]	xsize	Size in x (the number of columns)
[in]	ysize	Size in y (the number of rows)

Returns

none

ImageWrapper() [4/4]

template<typename T >

ifw::odp::ImageWrapper< T >::ImageWrapper	(	const ImageWrapper< T > &	image,
		const cpl_size	llx,
		const cpl_size	lly,
		const cpl_size	urx,
		const cpl_size	ury )

Copy constructor.

Parameters

[in]	image	Reference to the object to be copied.
[in]	llx	Lower left X coordinate.
[in]	lly	Lower left Y coordinate.
[in]	urx	Upper right X coordinate.
[in]	ury	Upper right Y coordinate.

Returns

none

~ImageWrapper()

template<typename T >

virtual ifw::odp::ImageWrapper< T >::~ImageWrapper ( )

virtual

Class destructor.

Returns

none

Delete memory

Member Function Documentation

IsWrapped()

template<typename T >

virtual bool ifw::odp::ImageWrapper< T >::IsWrapped ( ) const

virtual

Check if image was created around a pixel buffer.

Returns

TRUE or FALSE

Read()

template<typename T >

virtual void ifw::odp::ImageWrapper< T >::Read ( T * data_ptr, cpl_size width, cpl_size height )

virtual

Wrap data from a data buffer.

Parameters

[in]	data_ptr	Pointer to the data buffer.
[in]	width	Width of the image.
[in]	height	Heigth of the image.

It wrap the data directly from a data pointer.

See also

CPL function: cpl_image_wrap_int, cpl_image_wrap_float, cpl_image_wrap_double

Save() [1/2]

template<typename T >

virtual void ifw::odp::ImageWrapper< T >::Save ( const char * filename )

virtual

Saves image into a FITS file.

Parameters

[in]

filename

Name of the FITS file to be saved.

Save() [2/2]

template<typename T >

virtual void ifw::odp::ImageWrapper< T >::Save ( const char * filename, cpl_type_bpp type_bpp )

virtual

Saves image into a FITS file of a specific data type.

Parameters

[in]	filename	Name of the FITS file to be saved.
[in]	type_bpp	Type of the CPL image.

SetWrap()

template<typename T >

virtual void ifw::odp::ImageWrapper< T >::SetWrap ( bool status )

virtual

Set wrapped flag.

Unload()

template<typename T >

virtual void ifw::odp::ImageWrapper< T >::Unload ( )

virtual

Unwrap CPL image.

Member Data Documentation

m_data

template<typename T >

T* ifw::odp::ImageWrapper< T >::m_data

protected

Object buffer to store copied or casted shared memory areas.

---

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

• cppcpl/src/include/ifw/odp/cppcpl/imageWrapper.hpp