peak::ipl::ColorCorrector Class Reference

Applies a 3x3 color correction matrix to the data. More...

#include <peak_ipl/algorithm/peak_ipl_color_corrector.hpp>

Public Member Functions
	ColorCorrector ()
	~ColorCorrector ()
	ColorCorrector (const ColorCorrector &other)=delete
ColorCorrector &	operator= (const ColorCorrector &other)=delete
	ColorCorrector (ColorCorrector &&other)
ColorCorrector &	operator= (ColorCorrector &&other)
void	SetColorCorrectionFactors (peak::ipl::ColorCorrectionFactors colorCorrectorFactors)
	Sets the values of the color correction matrix. More...
peak::ipl::ColorCorrectionFactors	ColorCorrectionFactors ()
	Returns the factors of the color correction matrix. More...
peak::ipl::ColorCorrectionFactors	ColorCorrectionFactors () const
	Returns the factors of the color correction matrix. More...
float	Saturation () const
	Returns the color saturation value. More...
float	SaturationMin () const
	Returns the minimum color saturation value. More...
float	SaturationMax () const
	Returns the maximum color saturation value. More...
void	SetSaturation (float saturation)
	Sets the color saturation value. More...
bool	IsPixelFormatSupported (PixelFormatName pixelFormatName) const
	Returns whether the color corrector supports the given pixel format. More...
void	ProcessInPlace (Image &image) const
	Corrects the colors of the given image by applying a 3x3 color correction matrix to the data in place i.e. it will change the input image. More...
Image	Process (const Image &inputImage) const
	Corrects the colors of the given image by applying a 3x3 color correction matrix to the data. More...

Detailed Description

Applies a 3x3 color correction matrix to the data.

Constructor & Destructor Documentation

ColorCorrector() [1/3]

peak::ipl::ColorCorrector::ColorCorrector ( )

inline

~ColorCorrector()

peak::ipl::ColorCorrector::~ColorCorrector ( )

inline

ColorCorrector() [2/3]

peak::ipl::ColorCorrector::ColorCorrector ( const ColorCorrector &  other )

delete

ColorCorrector() [3/3]

peak::ipl::ColorCorrector::ColorCorrector ( ColorCorrector &&  other )

inline

Member Function Documentation

ColorCorrectionFactors() [1/2]

peak::ipl::ColorCorrectionFactors peak::ipl::ColorCorrector::ColorCorrectionFactors ( )

inline

Returns the factors of the color correction matrix.

Returns

colorCorrectorFactors The factors of the color correction matrix

Since

1.0

ColorCorrectionFactors() [2/2]

peak::ipl::ColorCorrectionFactors peak::ipl::ColorCorrector::ColorCorrectionFactors ( ) const

inline

Returns the factors of the color correction matrix.

Returns

colorCorrectorFactors The factors of the color correction matrix

Since

1.3.2

IsPixelFormatSupported()

bool peak::ipl::ColorCorrector::IsPixelFormatSupported ( PixelFormatName  pixelFormatName ) const

inline

Returns whether the color corrector supports the given pixel format.

Returns

Flag whether the given pixel format is supported.

Parameters

[in]

pixelFormatName

The pixel format of interest.

Since

1.0

operator=() [1/2]

ColorCorrector& peak::ipl::ColorCorrector::operator= ( const ColorCorrector &  other )

delete

operator=() [2/2]

ColorCorrector & peak::ipl::ColorCorrector::operator= ( ColorCorrector &&  other )

inline

Process()

Image peak::ipl::ColorCorrector::Process ( const Image &  inputImage ) const

inline

Corrects the colors of the given image by applying a 3x3 color correction matrix to the data.

Parameters

[in]

inputImage

Image to process.

Returns

A new created image containing the color corrected pixels

Exceptions

ImageFormatNotSupportedException

image has unsupported pixel format (e.g. packed pixel format)

Since

1.0

1.2 Will throw ImageFormatNotSupportedException if inputImage has packed pixel format

ProcessInPlace()

void peak::ipl::ColorCorrector::ProcessInPlace ( Image &  image ) const

inline

Corrects the colors of the given image by applying a 3x3 color correction matrix to the data in place i.e. it will change the input image.

Parameters

[in]

image

Image to process.

Exceptions

ImageFormatNotSupportedException

image has unsupported pixel format (e.g. packed pixel format)

Since

1.0

1.2 Will throw ImageFormatNotSupportedException if image has packed pixel format

Saturation()

float peak::ipl::ColorCorrector::Saturation ( ) const

inline

Returns the color saturation value.

Returns

The color saturation value

Since

1.6

SaturationMax()

float peak::ipl::ColorCorrector::SaturationMax ( ) const

inline

Returns the maximum color saturation value.

Returns

The maximum color saturation value

Since

1.6

SaturationMin()

float peak::ipl::ColorCorrector::SaturationMin ( ) const

inline

Returns the minimum color saturation value.

Returns

The minimum color saturation value

Since

1.6

SetColorCorrectionFactors()

void peak::ipl::ColorCorrector::SetColorCorrectionFactors ( peak::ipl::ColorCorrectionFactors  colorCorrectorFactors )

inline

Sets the values of the color correction matrix.

The matrix is row-wise sorted:

factorRR	factorGR	factorBR
factorRG	factorGG	factorBG
factorRB	factorGB	factorBB

Parameters

[in]

colorCorrectorFactors

The factors of the color correction matrix.

Since

1.0

SetSaturation()

void peak::ipl::ColorCorrector::SetSaturation ( float  saturation )

inline

Sets the color saturation value.

Parameters

[in]

saturation

The color saturation value.

Since

1.6

---

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

• peak_ipl/algorithm/peak_ipl_color_corrector.hpp