Class which stores a image histogram from a camera image. More...

#include <MultiSenseTypes.hh>

Public Member Functions
	Histogram ()
	Default constructor. More...

Public Attributes
uint32_t	channels
	The number of color channels in the given histogram. More...

uint32_t	bins
	The number of possible pixel values for each color channel. More...

std::vector< uint32_t >	data
	The histogram data concatinated serially in GRBG order. More...

Detailed Description

Class which stores a image histogram from a camera image.

This is used as an input when querying a image histogram.

Example code to query a image histogram for a left image corresponding to frameId 100

//
// Instantiate a channel connecting to a sensor at the factory default
// IP address
crl::multisense::Channel* channel;
channel = crl::multisense::Channel::Create("10.66.171.21");
 
channel->setMtu(1500);
 
//
// Create a histogram instance to store histogram data
crl::multisense::image::Histogram histogram;
 
uint64_t frameId = 100;
 
//
// Query the histogram from the image with the frameId == 100.
// Note histograms can only be queried for images whose frameIds are
// less than 20 frameIds away from the most recent received frameId
crl::multisense::Status status = channel->getImageHistogram(frameId, histogram);
 
//
// Check to see if the histogram query succeeded
if(crl::multisense::Status_Ok != status) {
     throw std::runtime_error("Unable to query image histogram for frameId %d", frameId);
}
 
//
// Destroy the channel instance
crl::multisense::Channel::Destroy(channel);

Definition at line 1992 of file MultiSenseTypes.hh.

Constructor & Destructor Documentation

◆ Histogram()

crl::multisense::image::Histogram::Histogram ( )

inline

Default constructor.

Definition at line 1998 of file MultiSenseTypes.hh.

Member Data Documentation

◆ bins

uint32_t crl::multisense::image::Histogram::bins

The number of possible pixel values for each color channel.

Definition at line 2005 of file MultiSenseTypes.hh.

◆ channels

uint32_t crl::multisense::image::Histogram::channels

The number of color channels in the given histogram.

For color images this is 4 corresponding to the GRBG Bayer channels

Definition at line 2000 of file MultiSenseTypes.hh.

◆ data

std::vector<uint32_t> crl::multisense::image::Histogram::data

The histogram data concatinated serially in GRBG order.

The length of data is equal to channels * bins

Definition at line 2008 of file MultiSenseTypes.hh.

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

/home/malvarado/crl/LibMultiSense/source/Legacy/include/MultiSense/MultiSenseTypes.hh

Public Member Functions