ifw-odp  2.0.0-alpha
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
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 odp::ImageStatistics:
odp::Error

Public Member Functions

 ImageStatistics (const odp::Image *image)
 Class constructor. More...
 
virtual ~ImageStatistics ()
 Class destructor. More...
 
double GetMin () const
 Get minimum pixel value over an image. More...
 
double GetMax () const
 Get maximum pixel value over an image. More...
 
double GetMean () const
 Get mean pixel value over an image. More...
 
double GetMedian () const
 Get median pixel value over an image. More...
 
double GetStdev () const
 Get standard deviation value over an image. More...
 
double GetFlux () const
 Get the sum of pixel values over an image. More...
 
double GetAbsFlux () const
 Get sum of absolute pixel values over an image. More...
 
double GetSqFlux () const
 Get sum of squared pixel values over an image. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
- Public Member Functions inherited from odp::Error
 Error ()
 Class constructor. More...
 
virtual ~Error ()
 Class destructor. More...
 
void ResetCplError ()
 Reset CPL error and internal error flag. More...
 
bool CheckCplError () const
 Check if there is an error in CPL. More...
 

Additional Inherited Members

- Protected Member Functions inherited from odp::Error
void AddCplError () const
 Add CPL error to the error stack. More...
 
std::string GetErrorMsg () const
 Get CPL error message. More...
 
- Static Protected Member Functions inherited from odp::Error
static void DumpError (unsigned self, unsigned first, unsigned last)
 Dump current CPL error. More...
 

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

odp::ImageStatistics::ImageStatistics ( const odp::Image image)
explicit

Class constructor.

Returns
none
odp::ImageStatistics::~ImageStatistics ( )
virtual

Class destructor.

Returns
none

Member Function Documentation

double odp::ImageStatistics::GetAbsFlux ( ) const

Get sum of absolute pixel values over an image.

Returns
value Sum of absolute pixel value over an image.
double 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]llxLower left X coordinate.
[in]llyLower left Y coordinate.
[in]urxUpper right X coordinate.
[in]uryUpper right Y coordinate.
Returns
Sum of absolute pixel values over a window of an image.
double odp::ImageStatistics::GetFlux ( ) const

Get the sum of pixel values over an image.

Returns
Sum of pixel values over an image.
double 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]llxLower left X coordinate.
[in]llyLower left Y coordinate.
[in]urxUpper right X coordinate.
[in]uryUpper right Y coordinate.
Returns
Sum of pixel values over a window of an image.
double odp::ImageStatistics::GetMax ( ) const

Get maximum pixel value over an image.

Returns
Maximum pixel value over an image.
double 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]llxLower left X coordinate.
[in]llyLower left Y coordinate.
[in]urxUpper right X coordinate.
[in]uryUpper right Y coordinate.
Returns
Maximum pixel value over a window of an image.
double odp::ImageStatistics::GetMean ( ) const

Get mean pixel value over an image.

Returns
Mean pixel value over an image.
double 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]llxLower left X coordinate.
[in]llyLower left Y coordinate.
[in]urxUpper right X coordinate.
[in]uryUpper right Y coordinate.
Returns
Mean pixel value over a window of an image.
double odp::ImageStatistics::GetMedian ( ) const

Get median pixel value over an image.

Returns
value Median pixel value over an image.
double 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]llxLower left X coordinate.
[in]llyLower left Y coordinate.
[in]urxUpper right X coordinate.
[in]uryUpper right Y coordinate.
Returns
Median pixel value over a window of an image.
double odp::ImageStatistics::GetMin ( ) const

Get minimum pixel value over an image.

Returns
Minimum pixel value over an image.
double 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]llxLower left X coordinate.
[in]llyLower left Y coordinate.
[in]urxUpper right X coordinate.
[in]uryUpper right Y coordinate.
Returns
Minimum pixel value over a window of an image.
double odp::ImageStatistics::GetSqFlux ( ) const

Get sum of squared pixel values over an image.

Returns
value Sum of squared pixel values over an image.
double 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]llxLower left X coordinate.
[in]llyLower left Y coordinate.
[in]urxUpper right X coordinate.
[in]uryUpper right Y coordinate.
Returns
Sum of squared pixel values over a window of an image.
double odp::ImageStatistics::GetStdev ( ) const

Get standard deviation value over an image.

Returns
Standard deviation value over an image.
double 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]llxLower left X coordinate.
[in]llyLower left Y coordinate.
[in]urxUpper right X coordinate.
[in]uryUpper right Y coordinate.
Returns
Mean pixel value over a window of an image.

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