ifw::odp::ImageProperties Class Reference

This class is C++ wrapper for a CPL properties list object. It provides a simplified interface that allows to call CPL routines from INS application. More...

#include <imageProperties.hpp>

Inheritance diagram for ifw::odp::ImageProperties:

Public Member Functions
	ImageProperties ()
	Class constructor.
virtual	~ImageProperties ()
	Class destructor.
constexpr bool	IsPropertyList () const
	Check is CPL image list is valid.
cpl_propertylist *	GetCplPropertyList () const
	Get CPL image list.
int	GetPixelDepth () const
int	GetWidth () const
int	GetHeight () const
int	GetNumAxes () const
int	GetPlanes () const
bool	IsCube () const
void	SetCplPropertyList (cpl_propertylist *propertyList)
	Set CPL image list.
virtual void	Load (const std::string filename, const cpl_size extension=0)
	Load CPL image from a FITS file.
virtual void	Unload ()
	Release CPL image list.
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
cpl_propertylist *	m_cpl_property_list

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

Detailed Description

This class is C++ wrapper for a CPL properties list object. It provides a simplified interface that allows to call CPL routines from INS application.

ImageProperties - CPL property list wrapper class

See also

CPL Reference: http://www.eso.org/observing/cpl/reference_3.0/ or above

Constructor & Destructor Documentation

ImageProperties()

ifw::odp::ImageProperties::ImageProperties

(

)

Class constructor.

Returns

none

~ImageProperties()

ifw::odp::ImageProperties::~ImageProperties ( )

virtual

Class destructor.

Returns

none

See also

CPL function: cpl_imagelist_delete

Member Function Documentation

GetCplPropertyList()

cpl_propertylist * ifw::odp::ImageProperties::GetCplPropertyList ( ) const

inline

Get CPL image list.

Returns

CPL image listODP_IMAGE_PROPERTIES_HPP

GetHeight()

int ifw::odp::ImageProperties::GetHeight

(

)

const

GetNumAxes()

int ifw::odp::ImageProperties::GetNumAxes

(

)

const

GetPixelDepth()

int ifw::odp::ImageProperties::GetPixelDepth

(

)

const

GetPlanes()

int ifw::odp::ImageProperties::GetPlanes

(

)

const

GetWidth()

int ifw::odp::ImageProperties::GetWidth

(

)

const

IsCube()

bool ifw::odp::ImageProperties::IsCube

(

)

const

IsPropertyList()

constexpr bool ifw::odp::ImageProperties::IsPropertyList ( ) const

inlineconstexpr

Check is CPL image list is valid.

Returns

TRUE is CPL image list is not nullptr, FALSE otherwise.

Load()

void ifw::odp::ImageProperties::Load ( const std::string filename, const cpl_size extension = 0 )

virtual

Load CPL image from a FITS file.

Parameters

[in]	filename	Absolute or relative path name of the file to be loaded.
[in]	extension	Extension id to be loaded, default is zero.
[in]	type	CPL type used to store the input image, default is FLOAT.

Returns

none

See also

CPL function: cpl_imagelist_load

SetCplPropertyList()

void ifw::odp::ImageProperties::SetCplPropertyList

(

cpl_propertylist *

propertyList

)

Set CPL image list.

Parameters

[in]

imageList

CPL image list

Returns

none

Unload()

void ifw::odp::ImageProperties::Unload ( )

virtual

Release CPL image list.

Returns

none

    Delete image list object from memory.

See also

CPL function: cpl_imagelist_delete

Member Data Documentation

m_cpl_property_list

cpl_propertylist* ifw::odp::ImageProperties::m_cpl_property_list

protected

---

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

• cppcpl/src/include/ifw/odp/cppcpl/imageProperties.hpp
• cppcpl/src/imageProperties.cpp