Class cv::xphoto::GrayworldWB#

Gray-world white balance algorithm. View details

#include <opencv2/xphoto/white_balance.hpp>

Collaboration diagram for cv::xphoto::GrayworldWB:

Public Member Functions#

Public Member Functions inherited from cv::xphoto::WhiteBalancer

Return	Name	Description
`void`	`balanceWhite(` `InputArray src,` `OutputArray dst )`	Applies white balancing to the input image.

Public Member Functions inherited from cv::Algorithm

Return	Name	Description
	`Algorithm()`
	`~Algorithm()`
`void`	`clear()`	Clears the algorithm state.
`bool`	`empty()`	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.
`String`	`getDefaultName()`
`void`	`read(const FileNode & fn)`	Reads algorithm parameters from a file storage.
`void`	`save(const String & filename)`
`void`	`write(` `const Ptr< FileStorage > & fs,` `const String & name = String() )`
`void`	`write(FileStorage & fs)`	Stores algorithm parameters in a file storage.
`void`	`write(` `FileStorage & fs,` `const String & name )`

Static Public Member Functions#

Static Public Member Functions inherited from cv::Algorithm

Return	Name	Description
`static Ptr< _Tp >`	`load(` `const String & filename,` `const String & objname = String() )`	Loads algorithm from the file.
`static Ptr< _Tp >`	`loadFromString(` `const String & strModel,` `const String & objname = String() )`	Loads algorithm from a String.
`static Ptr< _Tp >`	`read(const FileNode & fn)`	Reads algorithm from the file node.

Additional Inherited Members#

Detailed Description#

Gray-world white balance algorithm.

This algorithm scales the values of pixels based on a gray-world assumption which states that the average of all channels should result in a gray image.

It adds a modification which thresholds pixels based on their saturation value and only uses pixels below the provided threshold in finding average pixel values.

Saturation is calculated using the following for a 3-channel RGB image per pixel I and is in the range [0, 1]:

\[ \texttt{Saturation} [I] = \frac{\textrm{max}(R,G,B) - \textrm{min}(R,G,B) }{\textrm{max}(R,G,B)} \]

A threshold of 1 means that all pixels are used to white-balance, while a threshold of 0 means no pixels are used. Lower thresholds are useful in white-balancing saturated images.

Currently supports images of type CV_8UC3 and CV_16UC3.

Member Function Documentation#

getSaturationThreshold()#

float cv::xphoto::GrayworldWB::getSaturationThreshold()

Python:

cv.xphoto.GrayworldWB.getSaturationThreshold() -> retval

Maximum saturation for a pixel to be included in the gray-world assumption.

setSaturationThreshold()#

void cv::xphoto::GrayworldWB::setSaturationThreshold(float val)

Python:

cv.xphoto.GrayworldWB.setSaturationThreshold(val)

Maximum saturation for a pixel to be included in the gray-world assumption.

Source file#

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

opencv2/xphoto/white_balance.hpp