This class implements an image histogram. More...

Data Structures
class	Histogram8BitPerChannel
	This class implements a standard histogram object storing 8 bit per channel. More...

class	HistogramBase8BitPerChannel
	This class implements the base class for all histogram objects holding 8 bit per data channel. More...

class	IntegralHistogram8BitPerChannel
	This class implements an integral histogram object. More...

class	LookupTable8BitPerChannel
	This class implements a simple lookup table. More...

Static Public Member Functions
template<unsigned int tChannels>
static Histogram8BitPerChannel< tChannels >	determineHistogram8BitPerChannel (const uint8_t frame, const unsigned int width, const unsigned int height, const unsigned int framePaddingElements, Worker worker=nullptr)
	Determines the standard histogram for a given frame. More...

template<unsigned int tChannels>
static Histogram8BitPerChannel< tChannels >	determineHistogram8BitPerChannel (const uint8_t frame, const unsigned int width, const unsigned int height, const unsigned int subframeLeft, const unsigned int subframeTop, const unsigned int subframeWidth, const unsigned int subframeHeight, const unsigned int framePaddingElements, Worker worker=nullptr)
	Determines the standard histogram in a sub region of a given frame. More...

static bool	equalization (Frame &frame, const Scalar factor=1, Worker *worker=nullptr)
	Applies a histogram equalization for a given frame. More...

static bool	equalization (const Frame &source, Frame &target, const Scalar factor=1, Worker *worker=nullptr)
	Applies a histogram equalization for a given frame. More...

static bool	adjustColorToReference (Frame &frame, const Frame &reference, Worker *worker=nullptr)
	Adjusts the color of a frame according to a given reference frame. More...

static bool	adjustColorToReference (Frame &frame, const Frame &reference, const unsigned int horizontalBins, const unsigned int verticalBins, Worker *worker=nullptr)
	Adjusts the color of a frame according to a given reference frame while using corresponding bins for the adjustments only (not the entire frame information). More...

template<unsigned int tChannels>
static bool	adjustColorToReference (uint8_t frame, const unsigned int frameWidth, const unsigned int frameHeight, const uint8_t reference, const unsigned int referenceWidth, const unsigned int referenceHeight, const unsigned int horizontalBins, const unsigned int verticalBins, const unsigned int framePaddingElements, const unsigned int referencePaddingElements, Worker *worker=nullptr)
	Adjusts the color of a frame according to a given reference frame while using corresponding bins for the adjustments only (not the entire frame information). More...

static bool	adjustColorToReference (const Frame &source, Frame &target, const Frame &reference, Worker *worker=nullptr)
	Adjusts the color of a frame according to a given reference frame. More...

template<unsigned int tChannels>
static bool	equalization (uint8_t frame, const unsigned int width, const unsigned int height, const Scalar factor, const unsigned int framePaddingElements, Worker worker=nullptr)
	Applies a histogram equalization for a given frame. More...

template<unsigned int tChannels>
static bool	equalization (const uint8_t source, uint8_t target, const unsigned int width, const unsigned int height, const Scalar factor, const unsigned int sourcePaddingElements, const unsigned int targetPaddingElements, Worker *worker=nullptr)
	Applies a histogram equalization for a given frame. More...

template<unsigned int tChannels>
static bool	equalization (uint8_t frame, const unsigned int width, const unsigned int height, const IntegralHistogram8BitPerChannel< tChannels > &normalizedIntegral, const Scalar factor, const unsigned int framePaddingElements, Worker worker=nullptr)
	Applies a histogram equalization for a given frame. More...

template<unsigned int tChannels>
static bool	equalization (uint8_t frame, const unsigned int width, const unsigned int height, const unsigned int subframeLeft, const unsigned int subframeTop, const unsigned int subframeWidth, const unsigned int subframeHeight, const IntegralHistogram8BitPerChannel< tChannels > &normalizedIntegral, const Scalar factor, const unsigned int framePaddingElements, Worker worker=nullptr)
	Applies a histogram equalization in a sub region of a given frame. More...

template<unsigned int tChannels>
static bool	equalization (const uint8_t source, uint8_t target, const unsigned int width, const unsigned int height, const IntegralHistogram8BitPerChannel< tChannels > &normalizedIntegral, const Scalar factor, const unsigned int sourcePaddingElements, const unsigned int targetPaddingElements, Worker *worker=nullptr)
	Applies a histogram equalization for a given frame. More...

template<unsigned int tChannels>
static bool	equalization (const uint8_t source, uint8_t target, const unsigned int width, const unsigned int height, const unsigned int subframeLeft, const unsigned int subframeTop, const unsigned int subframeWidth, const unsigned int subframeHeight, const IntegralHistogram8BitPerChannel< tChannels > &normalizedIntegral, const Scalar factor, const unsigned int sourcePaddingElements, const unsigned int targetPaddingElements, Worker *worker=nullptr)
	Applies a histogram equalization for a given frame. More...

template<unsigned int tChannels>
static bool	adjustColorToReference (uint8_t frame, const unsigned int frameWidth, const unsigned int frameHeight, const uint8_t reference, const unsigned int referenceWidth, const unsigned int referenceHeight, const unsigned int framePaddingElements, const unsigned int referencePaddingElements, Worker *worker=nullptr)
	Adjusts the color of a frame according to a given reference frame. More...

template<unsigned int tChannels>
static bool	adjustColorToReference (const uint8_t source, uint8_t target, const unsigned int sourceWidth, const unsigned int sourceHeight, const uint8_t reference, const unsigned int referenceWidth, const unsigned int referenceHeight, const unsigned int sourcePaddingElements, const unsigned int targetPaddingElements, const unsigned int referencePaddingElements, Worker worker=nullptr)
	Adjusts the color of a frame according to a given reference frame. More...

template<unsigned int tChannels>
static bool	adjustColorToReference (uint8_t frame, const unsigned int width, const unsigned int height, const IntegralHistogram8BitPerChannel< tChannels > &invertedNormalizedReferenceIntegral, const unsigned int framePaddingElements, Worker worker=nullptr)
	Adjusts the color of a frame according to a given reference frame. More...

template<unsigned int tChannels>
static bool	adjustColorToReference (uint8_t frame, const unsigned int width, const unsigned int height, const unsigned int subframeLeft, const unsigned int subframeTop, const unsigned int subframeWidth, const unsigned int subframeHeight, const IntegralHistogram8BitPerChannel< tChannels > &invertedNormalizedReferenceIntegral, const unsigned int framePaddingElements, Worker worker=nullptr)
	Adjusts the color of a frame according to a given reference frame. More...

template<unsigned int tChannels>
static bool	adjustColorToReference (const uint8_t source, uint8_t target, const unsigned int width, const unsigned int height, const IntegralHistogram8BitPerChannel< tChannels > &invertedNormalizedReferenceIntegral, const unsigned int sourcePaddingElements, const unsigned int targetPaddingElements, Worker *worker=nullptr)
	Adjusts the color of a frame according to a given reference frame. More...

template<unsigned int tChannels>
static bool	adjustColorToReference (const uint8_t source, uint8_t target, const unsigned int width, const unsigned int height, const unsigned int subframeLeft, const unsigned int subframeTop, const unsigned int subframeWidth, const unsigned int subframeHeight, const IntegralHistogram8BitPerChannel< tChannels > &invertedNormalizedReferenceIntegral, const unsigned int sourcePaddingElements, const unsigned int targetPaddingElements, Worker *worker=nullptr)
	Adjusts the color of a frame according to a given reference frame. More...

Static Private Member Functions
template<unsigned int tChannels>
static void	determineHistogram8BitPerChannelSubset (const uint8_t frame, const unsigned int width, const unsigned int height, Histogram8BitPerChannel< tChannels > histogram, Lock *lock, const unsigned int firstColumn, const unsigned int numberColumns, const unsigned int framePaddingElements, const unsigned int firstRow, const unsigned int numberRows)
	Determines the standard histogram in a subset of a given frame. More...

template<unsigned int tChannels>
static void	equalizationSubset (uint8_t frame, const unsigned int width, const unsigned int height, const IntegralHistogram8BitPerChannel< tChannels > normalizedIntegral, const unsigned int factor, const unsigned int firstColumn, const unsigned int numberColumns, const unsigned int framePaddingElements, const unsigned int firstRow, const unsigned int numberRows)
	Applies a histogram equalization in a subset of a given frame. More...

template<unsigned int tChannels>
static void	equalizationOfTargetSubset (const uint8_t source, uint8_t target, const unsigned int width, const unsigned int height, const IntegralHistogram8BitPerChannel< tChannels > *normalizedIntegral, const unsigned int factor, const unsigned int firstColumn, const unsigned int numberColumns, const unsigned int sourcePaddingElements, const unsigned int targetPaddingElements, const unsigned int firstRow, const unsigned int numberRows)
	Applies a histogram equalization in a subset of a given frame. More...

template<unsigned int tChannels>
static void	adjustColorToReferenceSubset (uint8_t frame, const unsigned int width, const unsigned int height, const LookupTable8BitPerChannel< tChannels > lookupTable, const unsigned int firstColumn, const unsigned int numberColumns, const unsigned int framePaddingElements, const unsigned int firstRow, const unsigned int numberRows)
	Adjusts the color in a subset of a frame according to a given reference frame. More...

template<unsigned int tChannels>
static void	adjustColorToReferenceOfTargetSubset (const uint8_t source, uint8_t target, const unsigned int width, const unsigned int height, const LookupTable8BitPerChannel< tChannels > *lookupTable, const unsigned int firstColumn, const unsigned int numberColumns, const unsigned int sourcePaddingElements, const unsigned int targetPaddingElements, const unsigned int firstRow, const unsigned int numberRows)
	Adjusts the color of a frame according to a given reference frame. More...

Detailed Description

This class implements an image histogram.

Member Function Documentation

◆ adjustColorToReference() [1/10]

static bool Ocean::CV::Histogram::adjustColorToReference	(	const Frame &	source,
		Frame &	target,
		const Frame &	reference,
		Worker *	worker = `nullptr`
	)

static

Adjusts the color of a frame according to a given reference frame.

The function applies a forward and backward mapping of the normalized integral histograms of both frames. The frame types of the source frame and the given reference frame must be identical.

Parameters

source	The source frame that is used to create the target frame
target	The target frame with adjusted color information
reference	Reference frame providing the color statistics for the new frame
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

◆ adjustColorToReference() [2/10]

template<unsigned int tChannels>

bool Ocean::CV::Histogram::adjustColorToReference	(	const uint8_t *	source,
		uint8_t *	target,
		const unsigned int	sourceWidth,
		const unsigned int	sourceHeight,
		const uint8_t *	reference,
		const unsigned int	referenceWidth,
		const unsigned int	referenceHeight,
		const unsigned int	sourcePaddingElements,
		const unsigned int	targetPaddingElements,
		const unsigned int	referencePaddingElements,
		Worker *	worker = `nullptr`
	)

static

Adjusts the color of a frame according to a given reference frame.

The function applies a forward and backward mapping of the normalized integral histograms of both frames. The frame types of the source frame and the given reference frame must be identical.

Parameters

source	The source frame that is used to create the target frame
target	The target frame with adjusted color information
sourceWidth	The width of the source and target frame in pixel
sourceHeight	The height of the source and target frame in pixel
reference	Reference frame providing the color statistics for the new frame
referenceWidth	The width of the reference frame in pixel
referenceHeight	The height of the reference frame in pixel
sourcePaddingElements	The number of padding elements at the end of each source row, in elements, with range [0, infinity)
targetPaddingElements	The number of padding elements at the end of each target row, in elements, with range [0, infinity)
referencePaddingElements	The number of padding elements at the end of each reference row, in elements, with range [0, infinity)
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

Template Parameters

tChannels Number of channels of the frame, with range [1, infinity)

◆ adjustColorToReference() [3/10]

template<unsigned int tChannels>

bool Ocean::CV::Histogram::adjustColorToReference	(	const uint8_t *	source,
		uint8_t *	target,
		const unsigned int	width,
		const unsigned int	height,
		const IntegralHistogram8BitPerChannel< tChannels > &	invertedNormalizedReferenceIntegral,
		const unsigned int	sourcePaddingElements,
		const unsigned int	targetPaddingElements,
		Worker *	worker = `nullptr`
	)

inlinestatic

Adjusts the color of a frame according to a given reference frame.

The function applies a forward and backward mapping of the normalized integral histograms of both frames. The frame types of the source frame and the given reference frame must be identical.

Parameters

source	The source frame that is used to create the target frame
target	The target frame with adjusted color information
width	The width of the source and target frame in pixel
height	The height of the source and target frame in pixel
invertedNormalizedReferenceIntegral	Already determined inverted and normalized integral histogram of the reference frame
sourcePaddingElements	The number of padding elements at the end of each source row, in elements, with range [0, infinity)
targetPaddingElements	The number of padding elements at the end of each target row, in elements, with range [0, infinity)
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

Template Parameters

tChannels Number of channels of the frame, with range [1, infinity)

◆ adjustColorToReference() [4/10]

template<unsigned int tChannels>

bool Ocean::CV::Histogram::adjustColorToReference	(	const uint8_t *	source,
		uint8_t *	target,
		const unsigned int	width,
		const unsigned int	height,
		const unsigned int	subframeLeft,
		const unsigned int	subframeTop,
		const unsigned int	subframeWidth,
		const unsigned int	subframeHeight,
		const IntegralHistogram8BitPerChannel< tChannels > &	invertedNormalizedReferenceIntegral,
		const unsigned int	sourcePaddingElements,
		const unsigned int	targetPaddingElements,
		Worker *	worker = `nullptr`
	)

static

Adjusts the color of a frame according to a given reference frame.

The function applies a forward and backward mapping of the normalized integral histograms of both frames. The frame types of the source frame and the given reference frame must be identical.

Parameters

source	The source frame that is used to create the target frame
target	The target frame with adjusted color information
width	The width of the source and target frame in pixel
height	The height of the source and target frame in pixel
subframeLeft	Horizontal start position of the sub region within the frame, in pixel with range [0, width)
subframeTop	Vertical start position of the sub region within the frame, in pixel with range [0, heigh)
subframeWidth	The width of the sub region, in pixel with range [1, width - subframeLeft]
subframeHeight	The height of the sub region, in pixel with range [1, height - subframeTop]
invertedNormalizedReferenceIntegral	Already determined inverted and normalized integral histogram of the reference frame
sourcePaddingElements	The number of padding elements at the end of each source row, in elements, with range [0, infinity)
targetPaddingElements	The number of padding elements at the end of each target row, in elements, with range [0, infinity)
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

Template Parameters

tChannels Number of channels of the frame, with range [1, infinity)

◆ adjustColorToReference() [5/10]

static bool Ocean::CV::Histogram::adjustColorToReference	(	Frame &	frame,
		const Frame &	reference,
		const unsigned int	horizontalBins,
		const unsigned int	verticalBins,
		Worker *	worker = `nullptr`
	)

static

Adjusts the color of a frame according to a given reference frame while using corresponding bins for the adjustments only (not the entire frame information).

The function applies a forward and backward mapping of the normalized integral histograms of both frames.
The frame types of the frame and the given reference frame must be identical.

Parameters

frame	The frame for that the color values will be adjusted
reference	Reference frame providing the color statistics for the new frame
horizontalBins	The number of horizontal bins to use, with range [1, min(frame.width(), reference.with())]
verticalBins	The number of vertical bins to use, with range [1, min(frame.height(), reference.height())]
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

◆ adjustColorToReference() [6/10]

static bool Ocean::CV::Histogram::adjustColorToReference	(	Frame &	frame,
		const Frame &	reference,
		Worker *	worker = `nullptr`
	)

static

Adjusts the color of a frame according to a given reference frame.

The function applies a forward and backward mapping of the normalized integral histograms of both frames.
The frame types of the frame and the given reference frame must be identical.

Parameters

frame	The frame for that the color values will be adjusted
reference	Reference frame providing the color statistics for the new frame
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

◆ adjustColorToReference() [7/10]

template<unsigned int tChannels>

bool Ocean::CV::Histogram::adjustColorToReference	(	uint8_t *	frame,
		const unsigned int	frameWidth,
		const unsigned int	frameHeight,
		const uint8_t *	reference,
		const unsigned int	referenceWidth,
		const unsigned int	referenceHeight,
		const unsigned int	framePaddingElements,
		const unsigned int	referencePaddingElements,
		Worker *	worker = `nullptr`
	)

static

Adjusts the color of a frame according to a given reference frame.

The function applies a forward and backward mapping of the normalized integral histograms of both frames.

Parameters

frame	The frame for that the color values will be adjusted
frameWidth	The width of the frame in pixel
frameHeight	The height of the frame in pixel
reference	Reference frame providing the color statistics for the new frame
referenceWidth	The width of the reference frame in pixel
referenceHeight	The height of the reference frame in pixel
framePaddingElements	The number of padding elements at the end of each frame row, in elements, with range [0, infinity)
referencePaddingElements	The number of padding elements at the end of each reference row, in elements, with range [0, infinity)
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

Template Parameters

tChannels Number of channels of the frame, with range [1, infinity)

◆ adjustColorToReference() [8/10]

template<unsigned int tChannels>

bool Ocean::CV::Histogram::adjustColorToReference	(	uint8_t *	frame,
		const unsigned int	frameWidth,
		const unsigned int	frameHeight,
		const uint8_t *	reference,
		const unsigned int	referenceWidth,
		const unsigned int	referenceHeight,
		const unsigned int	horizontalBins,
		const unsigned int	verticalBins,
		const unsigned int	framePaddingElements,
		const unsigned int	referencePaddingElements,
		Worker *	worker = `nullptr`
	)

static

Adjusts the color of a frame according to a given reference frame while using corresponding bins for the adjustments only (not the entire frame information).

The function applies a forward and backward mapping of the normalized integral histograms of both frames.
The frame types of the frame and the given reference frame must be identical.

Parameters

frame	The frame for that the color values will be adjusted
frameWidth	The width of the frame in pixel, with range [1, infinity)
frameHeight	The height of the frame in pixel, with range [1, infinity)
reference	Reference frame providing the color statistics for the new frame
referenceWidth	The width of the reference frame in pixel, with range [1, infinity)
referenceHeight	The height of the reference frame in pixel, with range [1, infinity)
horizontalBins	The number of horizontal bins to use, with range [1, min(frameWidth, referenceWidth)]
verticalBins	The number of vertical bins to use, with range [1, min(frameHeight, referenceHeight)]
framePaddingElements	The number of padding elements at the end of each frame row, in elements, with range [0, infinity)
referencePaddingElements	The number of padding elements at the end of each reference row, in elements, with range [0, infinity)
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

Template Parameters

tChannels Number of channels of the frame, with range [1, infinity)

◆ adjustColorToReference() [9/10]

template<unsigned int tChannels>

bool Ocean::CV::Histogram::adjustColorToReference	(	uint8_t *	frame,
		const unsigned int	width,
		const unsigned int	height,
		const IntegralHistogram8BitPerChannel< tChannels > &	invertedNormalizedReferenceIntegral,
		const unsigned int	framePaddingElements,
		Worker *	worker = `nullptr`
	)

inlinestatic

Adjusts the color of a frame according to a given reference frame.

The function applies a forward and backward mapping of the normalized integral histograms of both frames.

Parameters

frame	The frame for that the color values will be adjusted
width	The width of the frame in pixel
height	The height of the frame in pixel
invertedNormalizedReferenceIntegral	Already determined inverted and normalized integral histogram of the reference frame
framePaddingElements	The number of padding elements at the end of each frame row, in elements, with range [0, infinity)
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

Template Parameters

tChannels Number of channels of the frame, with range [1, infinity)

◆ adjustColorToReference() [10/10]

template<unsigned int tChannels>

bool Ocean::CV::Histogram::adjustColorToReference	(	uint8_t *	frame,
		const unsigned int	width,
		const unsigned int	height,
		const unsigned int	subframeLeft,
		const unsigned int	subframeTop,
		const unsigned int	subframeWidth,
		const unsigned int	subframeHeight,
		const IntegralHistogram8BitPerChannel< tChannels > &	invertedNormalizedReferenceIntegral,
		const unsigned int	framePaddingElements,
		Worker *	worker = `nullptr`
	)

static

Adjusts the color of a frame according to a given reference frame.

The function applies a forward and backward mapping of the normalized integral histograms of both frames.

Parameters

frame	The frame for that the color values will be adjusted
width	The width of the frame in pixel
height	The height of the frame in pixel
subframeLeft	Horizontal start position of the sub region within the frame, in pixel with range [0, width)
subframeTop	Vertical start position of the sub region within the frame, in pixel with range [0, heigh)
subframeWidth	The width of the sub region, in pixel with range [1, width - subframeLeft]
subframeHeight	The height of the sub region, in pixel with range [1, height - subframeTop]
invertedNormalizedReferenceIntegral	Already determined inverted and normalized integral histogram of the reference frame
framePaddingElements	The number of padding elements at the end of each frame row, in elements, with range [0, infinity)
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

Template Parameters

tChannels Number of channels of the frame, with range [1, infinity)

◆ adjustColorToReferenceOfTargetSubset()

template<unsigned int tChannels>

void Ocean::CV::Histogram::adjustColorToReferenceOfTargetSubset	(	const uint8_t *	source,
		uint8_t *	target,
		const unsigned int	width,
		const unsigned int	height,
		const LookupTable8BitPerChannel< tChannels > *	lookupTable,
		const unsigned int	firstColumn,
		const unsigned int	numberColumns,
		const unsigned int	sourcePaddingElements,
		const unsigned int	targetPaddingElements,
		const unsigned int	firstRow,
		const unsigned int	numberRows
	)

staticprivate

Adjusts the color of a frame according to a given reference frame.

The function applies a forward and backward mapping of the normalized integral histograms of both frames. The frame types of the source frame and the given reference frame must be identical.

Parameters

source	The source frame that is used to create the target frame
target	The target frame with adjusted color information
width	The width of the source and target frame in pixel
height	The height of the source and target frame in pixel
lookupTable	Lookup table defining the adjustment of the color
firstColumn	First column to be handled
numberColumns	Number of columns to be handled
sourcePaddingElements	Optional number of padding elements of the source frame, range: [0, infinity)
targetPaddingElements	Optional number of padding elements of the target frame, range: [0, infinity)
firstRow	First row to be handled
numberRows	Number of rows to be handled

Template Parameters

tChannels Number of channels of the frame, with range [1, infinity)

◆ adjustColorToReferenceSubset()

template<unsigned int tChannels>

void Ocean::CV::Histogram::adjustColorToReferenceSubset	(	uint8_t *	frame,
		const unsigned int	width,
		const unsigned int	height,
		const LookupTable8BitPerChannel< tChannels > *	lookupTable,
		const unsigned int	firstColumn,
		const unsigned int	numberColumns,
		const unsigned int	framePaddingElements,
		const unsigned int	firstRow,
		const unsigned int	numberRows
	)

staticprivate

Adjusts the color in a subset of a frame according to a given reference frame.

The function applies a forward and backward mapping of the normalized integral histograms of both frames.

Parameters

frame	The frame for that the color values will be adjusted
width	The width of the frame in pixel
height	The height of the frame in pixel
lookupTable	Lookup table defining the adjustment of the color
firstColumn	First column to be handled
numberColumns	Number of columns to be handled
framePaddingElements	Optional number of padding elements of the input frame, range: [0, infinity)
firstRow	First row to be handled
numberRows	Number of rows to be handled

Template Parameters

tChannels Number of channels of the frame, with range [1, infinity)

◆ determineHistogram8BitPerChannel() [1/2]

template<unsigned int tChannels>

Histogram::Histogram8BitPerChannel< tChannels > Ocean::CV::Histogram::determineHistogram8BitPerChannel	(	const uint8_t *	frame,
		const unsigned int	width,
		const unsigned int	height,
		const unsigned int	framePaddingElements,
		Worker *	worker = `nullptr`
	)

static

Determines the standard histogram for a given frame.

Parameters

frame	The frame for that the histogram has to be determined
width	The width of the given frame in pixel
height	The height of the given frame in pixel
framePaddingElements	Optional number of padding elements of the input frame, range: [0, infinity)
worker	Optional worker object to distributed the computation

Returns: Resulting standard histogram object

Template Parameters

tChannels Number of channels of the given frame, with range [1, infinity)

◆ determineHistogram8BitPerChannel() [2/2]

template<unsigned int tChannels>

Histogram::Histogram8BitPerChannel< tChannels > Ocean::CV::Histogram::determineHistogram8BitPerChannel	(	const uint8_t *	frame,
		const unsigned int	width,
		const unsigned int	height,
		const unsigned int	subframeLeft,
		const unsigned int	subframeTop,
		const unsigned int	subframeWidth,
		const unsigned int	subframeHeight,
		const unsigned int	framePaddingElements,
		Worker *	worker = `nullptr`
	)

static

Determines the standard histogram in a sub region of a given frame.

Parameters

frame	The frame for that the histogram has to be determined
width	The width of the given frame in pixel
height	The height of the given frame in pixel
subframeLeft	Horizontal start position of the sub region within the frame, in pixel with range [0, width)
subframeTop	Vertical start position of the sub region within the frame, in pixel with range [0, height)
subframeWidth	The width of the sub region, in pixel with range [1, width - subframeLeft]
subframeHeight	The height of the sub region, in pixel with range [1, height - subframeTop]
worker	Optional worker object to distributed the computation
framePaddingElements	Optional number of padding elements of the input frame, range: [0, infinity), default: 0

Returns: Resulting standard histogram object

Template Parameters

tChannels Number of channels of the given frame, with range [1, infinity)

◆ determineHistogram8BitPerChannelSubset()

template<unsigned int tChannels>

void Ocean::CV::Histogram::determineHistogram8BitPerChannelSubset	(	const uint8_t *	frame,
		const unsigned int	width,
		const unsigned int	height,
		Histogram8BitPerChannel< tChannels > *	histogram,
		Lock *	lock,
		const unsigned int	firstColumn,
		const unsigned int	numberColumns,
		const unsigned int	framePaddingElements,
		const unsigned int	firstRow,
		const unsigned int	numberRows
	)

staticprivate

Determines the standard histogram in a subset of a given frame.

Parameters

frame	The frame for that the histogram has to be determined, must be valid
width	The width of the given frame in pixel, with range [1, infinity)
height	The height of the given frame in pixel, with range [1, infinity)
histogram	Resulting histogram
lock	Optional lock object that needs to be defined if this function is executed in parallel
firstColumn	First column to be handled
numberColumns	Number of columns to be handled
framePaddingElements	Optional number of padding elements of the input frame, range: [0, infinity)
firstRow	First row to be handled, with range [0, infinity)
numberRows	Number of rows to be handled, with range [1, height - firstRow]

Template Parameters

tChannels Number of channels of the given frame, with range [1, infinity)

◆ equalization() [1/8]

static bool Ocean::CV::Histogram::equalization	(	const Frame &	source,
		Frame &	target,
		const Scalar	factor = `1`,
		Worker *	worker = `nullptr`
	)

static

Applies a histogram equalization for a given frame.

The frame is equalized by application of the integral histogram of the original frame.

Parameters

source	The source frame for that an equalized target frame will be created
target	The target frame receiving the equalization result
factor	Interpolation factor between the original and the fully equalized frame, with range [0, 1]: 0 means the original frame is taken by 100 percent while 1 means that the equalized frame is taken by 100 percent
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

◆ equalization() [2/8]

template<unsigned int tChannels>

bool Ocean::CV::Histogram::equalization	(	const uint8_t *	source,
		uint8_t *	target,
		const unsigned int	width,
		const unsigned int	height,
		const IntegralHistogram8BitPerChannel< tChannels > &	normalizedIntegral,
		const Scalar	factor,
		const unsigned int	sourcePaddingElements,
		const unsigned int	targetPaddingElements,
		Worker *	worker = `nullptr`
	)

inlinestatic

Applies a histogram equalization for a given frame.

The frame is equalized by application of the integral histogram of the original frame.

Parameters

source	The source frame for that an equalized target frame will be created
target	The target frame receiving the equalization result
width	The width of the source and target frame in pixel
height	The height of the source and target frame in pixel
normalizedIntegral	Already determined normalized integral histogram of the given source frame
factor	Interpolation factor between the original and the fully equalized frame, with range [0, 1]: 0 means the original frame is taken by 100 percent while 1 means that the equalized frame is taken by 100 percent
sourcePaddingElements	The number of padding elements at the end of each source row, in elements, with range [0, infinity)
targetPaddingElements	The number of padding elements at the end of each target row, in elements, with range [0, infinity)
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

Template Parameters

tChannels Number of channels of the source and target frame, with range [1, infinity)

◆ equalization() [3/8]

template<unsigned int tChannels>

bool Ocean::CV::Histogram::equalization	(	const uint8_t *	source,
		uint8_t *	target,
		const unsigned int	width,
		const unsigned int	height,
		const Scalar	factor,
		const unsigned int	sourcePaddingElements,
		const unsigned int	targetPaddingElements,
		Worker *	worker = `nullptr`
	)

inlinestatic

Applies a histogram equalization for a given frame.

The frame is equalized by application of the integral histogram of the original frame.

Parameters

source	The source frame for that an equalized target frame will be created
target	The target frame receiving the equalization result
width	The width of the source and target frame in pixel
height	The height of the source and target frame in pixel
factor	Interpolation factor between the original and the fully equalized frame, with range [0, 1]: 0 means the original frame is taken by 100 percent while 1 means that the equalized frame is taken by 100 percent
sourcePaddingElements	The number of padding elements at the end of each source row, in elements, with range [0, infinity)
targetPaddingElements	The number of padding elements at the end of each target row, in elements, with range [0, infinity)
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

Template Parameters

tChannels Number of channels of the source and target frame, with range [1, infinity)

◆ equalization() [4/8]

template<unsigned int tChannels>

bool Ocean::CV::Histogram::equalization	(	const uint8_t *	source,
		uint8_t *	target,
		const unsigned int	width,
		const unsigned int	height,
		const unsigned int	subframeLeft,
		const unsigned int	subframeTop,
		const unsigned int	subframeWidth,
		const unsigned int	subframeHeight,
		const IntegralHistogram8BitPerChannel< tChannels > &	normalizedIntegral,
		const Scalar	factor,
		const unsigned int	sourcePaddingElements,
		const unsigned int	targetPaddingElements,
		Worker *	worker = `nullptr`
	)

static

Applies a histogram equalization for a given frame.

The frame is equalized by application of the integral histogram of the original frame.

Parameters

source	The source frame for that an equalized target frame will be created
target	The target frame receiving the equalization result
width	The width of the source and target frame in pixel
height	The height of the source and target frame in pixel
subframeLeft	Horizontal start position of the sub region within the frame, in pixel with range [0, width)
subframeTop	Vertical start position of the sub region within the frame, in pixel with range [0, heigh)
subframeWidth	The width of the sub region, in pixel with range [1, width - subframeLeft]
subframeHeight	The height of the sub region, in pixel with range [1, height - subframeTop]
normalizedIntegral	Already determined normalized integral histogram of the given source frame
factor	Interpolation factor between the original and the fully equalized frame, with range [0, 1]: 0 means the original frame is taken by 100 percent while 1 means that the equalized frame is taken by 100 percent
sourcePaddingElements	The number of padding elements at the end of each source row, in elements, with range [0, infinity)
targetPaddingElements	The number of padding elements at the end of each target row, in elements, with range [0, infinity)
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

Template Parameters

tChannels Number of channels of the source and target frame, with range [1, infinity)

◆ equalization() [5/8]

static bool Ocean::CV::Histogram::equalization	(	Frame &	frame,
		const Scalar	factor = `1`,
		Worker *	worker = `nullptr`
	)

static

Applies a histogram equalization for a given frame.

The frame is equalized by application of the integral histogram of the original frame.

Parameters

frame	The frame that will be equalized according the histogram
factor	Interpolation factor between the original and the fully equalized frame, with range [0, 1]: 0 means the original frame is taken by 100 percent while 1 means that the equalized frame is taken by 100 percent
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

◆ equalization() [6/8]

template<unsigned int tChannels>

bool Ocean::CV::Histogram::equalization	(	uint8_t *	frame,
		const unsigned int	width,
		const unsigned int	height,
		const IntegralHistogram8BitPerChannel< tChannels > &	normalizedIntegral,
		const Scalar	factor,
		const unsigned int	framePaddingElements,
		Worker *	worker = `nullptr`
	)

inlinestatic

Applies a histogram equalization for a given frame.

The frame is equalized by application of the integral histogram of the original frame.

Parameters

frame	The frame that will be equalized according the histogram
width	The width of the frame in pixel
height	The height of the frame in pixel
normalizedIntegral	Already determined normalized integral histogram of the given frame
factor	Interpolation factor between the original and the fully equalized frame, with range [0, 1]: 0 means the original frame is taken by 100 percent while 1 means that the equalized frame is taken by 100 percent
framePaddingElements	The number of padding elements at the end of each frame row, in elements, with range [0, infinity)
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

Template Parameters

tChannels Number of channels of the frame, with range [1, infinity)

◆ equalization() [7/8]

template<unsigned int tChannels>

bool Ocean::CV::Histogram::equalization	(	uint8_t *	frame,
		const unsigned int	width,
		const unsigned int	height,
		const Scalar	factor,
		const unsigned int	framePaddingElements,
		Worker *	worker = `nullptr`
	)

inlinestatic

Applies a histogram equalization for a given frame.

The frame is equalized by application of the integral histogram of the original frame.

Parameters

frame	The frame that will be equalized according the histogram
width	The width of the frame in pixel, with range [1, infinity)
height	The height of the frame in pixel, with range [1, infinity)
factor	Interpolation factor between the original and the fully equalized frame, with range [0, 1]: 0 means the original frame is taken by 100 percent while 1 means that the equalized frame is taken by 100 percent
framePaddingElements	The number of padding elements at the end of each frame row, in elements, with range [0, infinity)
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

Template Parameters

tChannels Number of channels of the frame, with range [1, infinity)

◆ equalization() [8/8]

template<unsigned int tChannels>

bool Ocean::CV::Histogram::equalization	(	uint8_t *	frame,
		const unsigned int	width,
		const unsigned int	height,
		const unsigned int	subframeLeft,
		const unsigned int	subframeTop,
		const unsigned int	subframeWidth,
		const unsigned int	subframeHeight,
		const IntegralHistogram8BitPerChannel< tChannels > &	normalizedIntegral,
		const Scalar	factor,
		const unsigned int	framePaddingElements,
		Worker *	worker = `nullptr`
	)

static

Applies a histogram equalization in a sub region of a given frame.

The frame is equalized by application of the integral histogram of the original frame.

Parameters

frame	The frame that will be equalized according the histogram
width	The width of the frame in pixel
height	The height of the frame in pixel
subframeLeft	Horizontal start position of the sub region within the frame, in pixel with range [0, width)
subframeTop	Vertical start position of the sub region within the frame, in pixel with range [0, heigh)
subframeWidth	The width of the sub region, in pixel with range [1, width - subframeLeft]
subframeHeight	The height of the sub region, in pixel with range [1, height - subframeTop]
normalizedIntegral	Already determined normalized integral histogram of the given frame
factor	Interpolation factor between the original and the fully equalized frame, with range [0, 1]: 0 means the original frame is taken by 100 percent while 1 means that the equalized frame is taken by 100 percent
framePaddingElements	The number of padding elements at the end of each frame row, in elements, with range [0, infinity)
worker	Optional worker object to distribute the computation

Returns: True, if succeeded

Template Parameters

tChannels Number of channels of the frame, with range [1, infinity)

◆ equalizationOfTargetSubset()

template<unsigned int tChannels>

void Ocean::CV::Histogram::equalizationOfTargetSubset	(	const uint8_t *	source,
		uint8_t *	target,
		const unsigned int	width,
		const unsigned int	height,
		const IntegralHistogram8BitPerChannel< tChannels > *	normalizedIntegral,
		const unsigned int	factor,
		const unsigned int	firstColumn,
		const unsigned int	numberColumns,
		const unsigned int	sourcePaddingElements,
		const unsigned int	targetPaddingElements,
		const unsigned int	firstRow,
		const unsigned int	numberRows
	)

staticprivate

Applies a histogram equalization in a subset of a given frame.

The frame is equalized by application of the integral histogram of the original frame.

Parameters

source	The source frame for that an equalized target frame will be created
target	The target frame receiving the equalization result
width	The width of the source and target frame in pixel
height	The height of the source and target frame in pixel
normalizedIntegral	Already determined normalized integral histogram of the given frame
factor	Interpolation factor, with range [0, 256]
firstColumn	First column to be handled
numberColumns	Number of columns to be handled
sourcePaddingElements	Optional number of padding elements of the source frame, range: [0, infinity)
targetPaddingElements	Optional number of padding elements of the target frame, range: [0, infinity)
firstRow	First row to be handled
numberRows	Number of rows to be handled

Template Parameters

tChannels Number of channels of the source and target frame, with range [1, infinity)

◆ equalizationSubset()

template<unsigned int tChannels>

void Ocean::CV::Histogram::equalizationSubset	(	uint8_t *	frame,
		const unsigned int	width,
		const unsigned int	height,
		const IntegralHistogram8BitPerChannel< tChannels > *	normalizedIntegral,
		const unsigned int	factor,
		const unsigned int	firstColumn,
		const unsigned int	numberColumns,
		const unsigned int	framePaddingElements,
		const unsigned int	firstRow,
		const unsigned int	numberRows
	)

staticprivate

Applies a histogram equalization in a subset of a given frame.

The frame is equalized by application of the integral histogram of the original frame.

Parameters

frame	The frame that will be equalized according the histogram
width	The width of the frame in pixel
height	The height of the frame in pixel
normalizedIntegral	Already determined normalized integral histogram of the given frame
factor	Interpolation factor, with range [0, 256]
firstColumn	First column to be handled
numberColumns	Number of columns to be handled
framePaddingElements	Optional number of padding elements of the input frame, range: [0, infinity)
firstRow	First row to be handled
numberRows	Number of rows to be handled

Template Parameters

tChannels Number of channels of the frame, with range [1, infinity)

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

Histogram.h

Data Structures

Static Public Member Functions

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ adjustColorToReference() [1/10]

◆ adjustColorToReference() [2/10]

◆ adjustColorToReference() [3/10]

◆ adjustColorToReference() [4/10]

◆ adjustColorToReference() [5/10]

◆ adjustColorToReference() [6/10]

◆ adjustColorToReference() [7/10]

◆ adjustColorToReference() [8/10]

◆ adjustColorToReference() [9/10]

◆ adjustColorToReference() [10/10]

◆ adjustColorToReferenceOfTargetSubset()

◆ adjustColorToReferenceSubset()

◆ determineHistogram8BitPerChannel() [1/2]

◆ determineHistogram8BitPerChannel() [2/2]

◆ determineHistogram8BitPerChannelSubset()

◆ equalization() [1/8]

◆ equalization() [2/8]

◆ equalization() [3/8]

◆ equalization() [4/8]

◆ equalization() [5/8]

◆ equalization() [6/8]

◆ equalization() [7/8]

◆ equalization() [8/8]

◆ equalizationOfTargetSubset()

◆ equalizationSubset()