Spinnaker C++
2.6.0.0
Public Member Functions | Friends | List of all members
ImageStatistics Class Reference

Represents image statistics for an image. More...

Inheritance diagram for ImageStatistics:
IImageStatistics

Public Member Functions

 ImageStatistics ()
 Default constructor. More...
 
virtual ~ImageStatistics ()
 Default destructor. More...
 
 ImageStatistics (const ImageStatistics &other)
 Copy constructor. More...
 
ImageStatisticsoperator= (const ImageStatistics &other)
 Assignment operator. More...
 
virtual void EnableAll ()
 Enable all channels. More...
 
virtual void DisableAll ()
 Disable all channels. More...
 
virtual void EnableGreyOnly ()
 Enable only the grey channel. More...
 
virtual void EnableRGBOnly ()
 Enable only the RGB channels. More...
 
virtual void EnableHSLOnly ()
 Enable only the HSL channels. More...
 
virtual void GetChannelStatus (StatisticsChannel channel, bool *pEnabled) const
 Gets the status of a statistics channel. More...
 
virtual void SetChannelStatus (StatisticsChannel channel, bool enabled)
 Sets the status of a statistics channel. More...
 
virtual void GetRange (StatisticsChannel channel, unsigned int *pMin, unsigned int *pMax) const
 Gets the range of a statistics channel. More...
 
virtual void GetPixelValueRange (StatisticsChannel channel, unsigned int *pPixelValueMin, unsigned int *pPixelValueMax) const
 Gets the range of a statistics channel. More...
 
virtual void GetNumPixelValues (StatisticsChannel channel, unsigned int *pNumPixelValues) const
 Gets the number of unique pixel values in the image. More...
 
virtual void GetMean (StatisticsChannel channel, float *pPixelValueMean) const
 Gets the mean of the image. More...
 
virtual void GetHistogram (StatisticsChannel channel, int **ppHistogram) const
 Gets the histogram for the image. More...
 
virtual void GetStatistics (StatisticsChannel channel, unsigned int *pRangeMin=NULL, unsigned int *pRangeMax=NULL, unsigned int *pPixelValueMin=NULL, unsigned int *pPixelValueMax=NULL, unsigned int *pNumPixelValues=NULL, float *pPixelValueMean=NULL, int **ppHistogram=NULL) const
 Gets all statistics for the image. More...
 
- Public Member Functions inherited from IImageStatistics
virtual ~IImageStatistics ()
 

Friends

class ImageStatsCalculator
 

Additional Inherited Members

- Protected Member Functions inherited from IImageStatistics
 IImageStatistics ()
 
 IImageStatistics (const IImageStatistics &)
 

Detailed Description

Represents image statistics for an image.

Constructor & Destructor Documentation

Default constructor.

virtual ~ImageStatistics ( )
virtual

Default destructor.

ImageStatistics ( const ImageStatistics other)

Copy constructor.

Member Function Documentation

virtual void DisableAll ( )
virtual

Disable all channels.

Implements IImageStatistics.

virtual void EnableAll ( )
virtual

Enable all channels.

Implements IImageStatistics.

virtual void EnableGreyOnly ( )
virtual

Enable only the grey channel.

Implements IImageStatistics.

virtual void EnableHSLOnly ( )
virtual

Enable only the HSL channels.

Implements IImageStatistics.

virtual void EnableRGBOnly ( )
virtual

Enable only the RGB channels.

Implements IImageStatistics.

virtual void GetChannelStatus ( StatisticsChannel  channel,
bool *  pEnabled 
) const
virtual

Gets the status of a statistics channel.

Parameters
channelThe statistics channel.
pEnabledWhether the channel is enabled.
See Also
SetChannelStatus()

Implements IImageStatistics.

virtual void GetHistogram ( StatisticsChannel  channel,
int **  ppHistogram 
) const
virtual

Gets the histogram for the image.

Parameters
channelThe statistics channel.
ppHistogramPointer to an array containing the histogram.

Implements IImageStatistics.

virtual void GetMean ( StatisticsChannel  channel,
float *  pPixelValueMean 
) const
virtual

Gets the mean of the image.

Parameters
channelThe statistics channel.
pPixelValueMeanThe mean of the image.

Implements IImageStatistics.

virtual void GetNumPixelValues ( StatisticsChannel  channel,
unsigned int *  pNumPixelValues 
) const
virtual

Gets the number of unique pixel values in the image.

Parameters
channelThe statistics channel.
pNumPixelValuesThe number of unique pixel values.

Implements IImageStatistics.

virtual void GetPixelValueRange ( StatisticsChannel  channel,
unsigned int *  pPixelValueMin,
unsigned int *  pPixelValueMax 
) const
virtual

Gets the range of a statistics channel.

The values returned are the maximum values recorded for all pixels in the image.

Parameters
channelThe statistics channel.
pPixelValueMinThe minimum pixel value.
pPixelValueMaxThe maximum pixel value.

Implements IImageStatistics.

virtual void GetRange ( StatisticsChannel  channel,
unsigned int *  pMin,
unsigned int *  pMax 
) const
virtual

Gets the range of a statistics channel.

The values returned are the maximum possible values for any given pixel in the image. This is generally 0-255 for 8 bit images, and 0-65535 for 16 bit images.

Parameters
channelThe statistics channel.
pMinThe minimum possible value.
pMaxThe maximum possible value.

Implements IImageStatistics.

virtual void GetStatistics ( StatisticsChannel  channel,
unsigned int *  pRangeMin = NULL,
unsigned int *  pRangeMax = NULL,
unsigned int *  pPixelValueMin = NULL,
unsigned int *  pPixelValueMax = NULL,
unsigned int *  pNumPixelValues = NULL,
float *  pPixelValueMean = NULL,
int **  ppHistogram = NULL 
) const
virtual

Gets all statistics for the image.

Parameters
channelThe statistics channel.
pRangeMinThe minimum possible value.
pRangeMaxThe maximum possible value.
pPixelValueMinThe minimum pixel value.
pPixelValueMaxThe maximum pixel value.
pNumPixelValuesThe number of unique pixel values.
pPixelValueMeanThe mean of the image.
ppHistogramPointer to an array containing the histogram.

Implements IImageStatistics.

ImageStatistics& operator= ( const ImageStatistics other)

Assignment operator.

Parameters
otherThe ImageStatistics object to copy from.
virtual void SetChannelStatus ( StatisticsChannel  channel,
bool  enabled 
)
virtual

Sets the status of a statistics channel.

Parameters
channelThe statistics channel.
enabledWhether the channel should be enabled.
See Also
GetChannelStatus()

Implements IImageStatistics.

Friends And Related Function Documentation

friend class ImageStatsCalculator
friend

The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference