ifw::odp::ImageStatistics Class Reference

This class is interface for a CPL image statistics functions. It provides a simplified interface that allows to call CPL routines from INS applications. More...

#include <imageStatistics.hpp>

Inheritance diagram for ifw::odp::ImageStatistics:

Public Member Functions
	ImageStatistics (const odp::Image *image)
	Class constructor.
virtual	~ImageStatistics ()
	Class destructor.
double	GetMin () const
	Get minimum pixel value over an image.
double	GetMax () const
	Get maximum pixel value over an image.
double	GetMean () const
	Get mean pixel value over an image.
double	GetMedian () const
	Get median pixel value over an image.
double	GetStdev () const
	Get standard deviation value over an image.
double	GetFlux () const
	Get the sum of pixel values over an image.
double	GetAbsFlux () const
	Get sum of absolute pixel values over an image.
double	GetSqFlux () const
	Get sum of squared pixel values over an image.
double	GetMin (const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury) const
	Get minimum pixel value over a window of an image.
double	GetMax (const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury) const
	Get maximum pixel value over a window of an image.
double	GetMean (const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury) const
	Get mean pixel value over a window of an image.
double	GetMedian (const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury) const
	Get median pixel value over a window of an image.
double	GetStdev (const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury) const
	Get standard deviation over a window of an image.
double	GetFlux (const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury) const
	Get sum of pixel values over a window of an image.
double	GetAbsFlux (const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury) const
	Get sum of absolute pixel values over a window of an image.
double	GetSqFlux (const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury) const
	Get sum of squared pixel values over a window of an image.
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.

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

Detailed Description

This class is interface for a CPL image statistics functions. It provides a simplified interface that allows to call CPL routines from INS applications.

ImageStatistics - CPL image statistics interface class

See also

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

Constructor & Destructor Documentation

ImageStatistics()

ifw::odp::ImageStatistics::ImageStatistics ( const odp::Image * image )

explicit

Class constructor.

Returns

none

~ImageStatistics()

ifw::odp::ImageStatistics::~ImageStatistics ( )

virtual

Class destructor.

Returns

none

Member Function Documentation

GetAbsFlux() [1/2]

double ifw::odp::ImageStatistics::GetAbsFlux

(

)

const

Get sum of absolute pixel values over an image.

Returns

value Sum of absolute pixel value over an image.

GetAbsFlux() [2/2]

double ifw::odp::ImageStatistics::GetAbsFlux	(	const cpl_size	llx,
		const cpl_size	lly,
		const cpl_size	urx,
		const cpl_size	ury ) const

Get sum of absolute pixel values over a window of an image.

Parameters

[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

Sum of absolute pixel values over a window of an image.

GetFlux() [1/2]

double ifw::odp::ImageStatistics::GetFlux

(

)

const

Get the sum of pixel values over an image.

Returns

Sum of pixel values over an image.

GetFlux() [2/2]

double ifw::odp::ImageStatistics::GetFlux	(	const cpl_size	llx,
		const cpl_size	lly,
		const cpl_size	urx,
		const cpl_size	ury ) const

Get sum of pixel values over a window of an image.

Parameters

[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

Sum of pixel values over a window of an image.

GetMax() [1/2]

double ifw::odp::ImageStatistics::GetMax

(

)

const

Get maximum pixel value over an image.

Returns

Maximum pixel value over an image.

GetMax() [2/2]

double ifw::odp::ImageStatistics::GetMax	(	const cpl_size	llx,
		const cpl_size	lly,
		const cpl_size	urx,
		const cpl_size	ury ) const

Get maximum pixel value over a window of an image.

Parameters

[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

Maximum pixel value over a window of an image.

GetMean() [1/2]

double ifw::odp::ImageStatistics::GetMean

(

)

const

Get mean pixel value over an image.

Returns

Mean pixel value over an image.

GetMean() [2/2]

double ifw::odp::ImageStatistics::GetMean	(	const cpl_size	llx,
		const cpl_size	lly,
		const cpl_size	urx,
		const cpl_size	ury ) const

Get mean pixel value over a window of an image.

Parameters

[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

Mean pixel value over a window of an image.

GetMedian() [1/2]

double ifw::odp::ImageStatistics::GetMedian

(

)

const

Get median pixel value over an image.

Returns

value Median pixel value over an image.

GetMedian() [2/2]

double ifw::odp::ImageStatistics::GetMedian	(	const cpl_size	llx,
		const cpl_size	lly,
		const cpl_size	urx,
		const cpl_size	ury ) const

Get median pixel value over a window of an image.

Parameters

[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

Median pixel value over a window of an image.

GetMin() [1/2]

double ifw::odp::ImageStatistics::GetMin

(

)

const

Get minimum pixel value over an image.

Returns

Minimum pixel value over an image.

GetMin() [2/2]

double ifw::odp::ImageStatistics::GetMin	(	const cpl_size	llx,
		const cpl_size	lly,
		const cpl_size	urx,
		const cpl_size	ury ) const

Get minimum pixel value over a window of an image.

Parameters

[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

Minimum pixel value over a window of an image.

GetSqFlux() [1/2]

double ifw::odp::ImageStatistics::GetSqFlux

(

)

const

Get sum of squared pixel values over an image.

Returns

value Sum of squared pixel values over an image.

GetSqFlux() [2/2]

double ifw::odp::ImageStatistics::GetSqFlux	(	const cpl_size	llx,
		const cpl_size	lly,
		const cpl_size	urx,
		const cpl_size	ury ) const

Get sum of squared pixel values over a window of an image.

Parameters

[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

Sum of squared pixel values over a window of an image.

GetStdev() [1/2]

double ifw::odp::ImageStatistics::GetStdev

(

)

const

Get standard deviation value over an image.

Returns

Standard deviation value over an image.

GetStdev() [2/2]

double ifw::odp::ImageStatistics::GetStdev	(	const cpl_size	llx,
		const cpl_size	lly,
		const cpl_size	urx,
		const cpl_size	ury ) const

Get standard deviation over a window of an image.

Parameters

[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

Mean pixel value over a window of an image.

---

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

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