Skip to content

Class Spinnaker::ImageStatistics

ClassList > Spinnaker > ImageStatistics

Represents image statistics for an image.

  • #include <ImageStatistics.h>

Inherits the following classes: Spinnaker::IImageStatistics

Public Functions

Type Name
virtual void DisableAll ()
virtual void EnableAll ()
virtual void EnableGreyOnly ()
virtual void EnableHSLOnly ()
virtual void EnableRGBOnly ()
virtual void GetChannelStatus (StatisticsChannel channel, bool * pEnabled) const
virtual void GetHistogram (StatisticsChannel channel, int ** ppHistogram) const
virtual void GetMean (StatisticsChannel channel, float * pPixelValueMean) const
virtual void GetNumPixelValues (StatisticsChannel channel, unsigned int * pNumPixelValues) const
virtual void GetPixelValueRange (StatisticsChannel channel, unsigned int * pPixelValueMin, unsigned int * pPixelValueMax) const
virtual void GetRange (StatisticsChannel channel, unsigned int * pMin, unsigned int * pMax) const
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
ImageStatistics ()
ImageStatistics (const ImageStatistics & other)
virtual void SetChannelStatus (StatisticsChannel channel, bool enabled)
ImageStatistics & operator= (const ImageStatistics & other)
virtual ~ImageStatistics ()

Public Functions inherited from Spinnaker::IImageStatistics

See Spinnaker::IImageStatistics

Type Name
virtual void DisableAll () = 0
virtual void EnableAll () = 0
virtual void EnableGreyOnly () = 0
virtual void EnableHSLOnly () = 0
virtual void EnableRGBOnly () = 0
virtual void GetChannelStatus (StatisticsChannel channel, bool * pEnabled) const = 0
virtual void GetHistogram (StatisticsChannel channel, int ** ppHistogram) const = 0
virtual void GetMean (StatisticsChannel channel, float * pPixelValueMean) const = 0
virtual void GetNumPixelValues (StatisticsChannel channel, unsigned int * pNumPixelValues) const = 0
virtual void GetPixelValueRange (StatisticsChannel channel, unsigned int * pPixelValueMin, unsigned int * pPixelValueMax) const = 0
virtual void GetRange (StatisticsChannel channel, unsigned int * pMin, unsigned int * pMax) const = 0
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 = 0
virtual void SetChannelStatus (StatisticsChannel channel, bool enabled) = 0
virtual ~IImageStatistics ()

Protected Functions inherited from Spinnaker::IImageStatistics

See Spinnaker::IImageStatistics

Type Name
IImageStatistics ()
IImageStatistics (const IImageStatistics &)

Public Functions Documentation

function DisableAll

virtual void Spinnaker::ImageStatistics::DisableAll ()

Disable all channels.

Implements Spinnaker::IImageStatistics::DisableAll

function EnableAll

virtual void Spinnaker::ImageStatistics::EnableAll ()

Enable all channels.

Implements Spinnaker::IImageStatistics::EnableAll

function EnableGreyOnly

virtual void Spinnaker::ImageStatistics::EnableGreyOnly ()

Enable only the grey channel.

Implements Spinnaker::IImageStatistics::EnableGreyOnly

function EnableHSLOnly

virtual void Spinnaker::ImageStatistics::EnableHSLOnly ()

Enable only the HSL channels.

Implements Spinnaker::IImageStatistics::EnableHSLOnly

function EnableRGBOnly

virtual void Spinnaker::ImageStatistics::EnableRGBOnly ()

Enable only the RGB channels.

Implements Spinnaker::IImageStatistics::EnableRGBOnly

function GetChannelStatus

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

Gets the status of a statistics channel.

Parameters:

  • channel The statistics channel.
  • pEnabled Whether the channel is enabled.

See also: SetChannelStatus()

Implements Spinnaker::IImageStatistics::GetChannelStatus

function GetHistogram

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

Gets the histogram for the image.

Parameters:

  • channel The statistics channel.
  • ppHistogram Pointer to an array containing the histogram.

Implements Spinnaker::IImageStatistics::GetHistogram

function GetMean

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

Gets the mean of the image.

Parameters:

  • channel The statistics channel.
  • pPixelValueMean The mean of the image.

Implements Spinnaker::IImageStatistics::GetMean

function GetNumPixelValues

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

Gets the number of unique pixel values in the image.

Parameters:

  • channel The statistics channel.
  • pNumPixelValues The number of unique pixel values.

Implements Spinnaker::IImageStatistics::GetNumPixelValues

function GetPixelValueRange

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

Gets the range of a statistics channel. The values returned are the maximum values recorded for all pixels in the image.

Parameters:

  • channel The statistics channel.
  • pPixelValueMin The minimum pixel value.
  • pPixelValueMax The maximum pixel value.

Implements Spinnaker::IImageStatistics::GetPixelValueRange

function GetRange

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

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:

  • channel The statistics channel.
  • pMin The minimum possible value.
  • pMax The maximum possible value.

Implements Spinnaker::IImageStatistics::GetRange

function GetStatistics

virtual void Spinnaker::ImageStatistics::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.

Parameters:

  • channel The statistics channel.
  • pRangeMin The minimum possible value.
  • pRangeMax The maximum possible value.
  • pPixelValueMin The minimum pixel value.
  • pPixelValueMax The maximum pixel value.
  • pNumPixelValues The number of unique pixel values.
  • pPixelValueMean The mean of the image.
  • ppHistogram Pointer to an array containing the histogram.

Implements Spinnaker::IImageStatistics::GetStatistics

function ImageStatistics [1/2]

Spinnaker::ImageStatistics::ImageStatistics ()

Default constructor.

function ImageStatistics [2/2]

Spinnaker::ImageStatistics::ImageStatistics (
    const ImageStatistics & other
)

Copy constructor.

function SetChannelStatus

virtual void Spinnaker::ImageStatistics::SetChannelStatus (
    StatisticsChannel channel,
    bool enabled
)

Sets the status of a statistics channel.

Parameters:

  • channel The statistics channel.
  • enabled Whether the channel should be enabled.

See also: GetChannelStatus()

Implements Spinnaker::IImageStatistics::SetChannelStatus

function operator=

ImageStatistics & Spinnaker::ImageStatistics::operator= (
    const ImageStatistics & other
)

Assignment operator.

Parameters:

function ~ImageStatistics

virtual Spinnaker::ImageStatistics::~ImageStatistics ()

Default destructor.

The documentation for this class was generated from the following file C:/workspace/include/ImageStatistics.h