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 ()
	Constructor for a new ColorCorrector instance. More...
	~ColorCorrector ()
	Destructor for the ColorCorrector instance. More...
	ColorCorrector (const ColorCorrector &other)
	Copy Constructor for a new ColorCorrector instance. More...
ColorCorrector &	operator= (const ColorCorrector &other)
	Copy assigment for ColorCorrector instance. More...
	ColorCorrector (ColorCorrector &&other) noexcept
	Move constructor for ColorCorrector instance. More...
ColorCorrector &	operator= (ColorCorrector &&other) noexcept
	Move assignment for ColorCorrector instance. More...
void	SetColorCorrectionFactors (peak::ipl::ColorCorrectionFactors colorCorrectorFactors)
	Sets the values of the color correction matrix. More...
void	SetSaturation (float saturation)
	Sets the color saturation value. 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 that is it will change the input image. More...

Public Attributes
	PEAK_IPL_MAYBE_UNUSED = peak::ipl::ColorCorrectionFactors ColorCorrectionFactors()

Detailed Description

Applies a 3x3 color correction matrix to the data.

Constructor & Destructor Documentation

ColorCorrector() [1/3]

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

inline

Constructor for a new ColorCorrector instance.

Creates a new ColorCorrector instance.

Since

1.0

~ColorCorrector()

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

inline

Destructor for the ColorCorrector instance.

Destroys a ColorCorrector instance.

Since

1.0

ColorCorrector() [2/3]

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

inline

Copy Constructor for a new ColorCorrector instance.

Creates a new ColorCorrector instance.

Note

This only creates a shallow copy. See Shallow copy (since 1.8) for a detailed explanation.

Parameters

[in]

other

The other instance to acquire a reference for.

Since

1.0 Deleted.

1.8 Implemented as shallow copy.

ColorCorrector() [3/3]

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

inlinenoexcept

Move constructor for ColorCorrector instance.

Moves the instance from other to this. Afterwards other is invalid.

Parameters

[in]

other

The other instance to move.

Since

1.0

Member Function Documentation

operator=() [1/2]

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

inline

Copy assigment for ColorCorrector instance.

Acquires a reference from other to this instance. If this instance already has a reference, it will be destroyed.

Note

See Shallow copy (since 1.8) for a detailed explanation.

Parameters

[in]

other

The other instance to acquire a reference for.

Since

1.0 Deleted.

1.8 Implemented as shallow copy.

operator=() [2/2]

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

inlinenoexcept

Move assignment for ColorCorrector instance.

Moves the instance from other to this. Afterwards other is invalid.

Parameters

[in]

other

The other instance to move.

Since

1.3.3

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 that is it will change the input image.

Parameters

[in]

image

Image to process.

Exceptions

ImageFormatNotSupportedException

image has unsupported pixel format (for example packed pixel format)

Since

1.0

1.2 Will throw ImageFormatNotSupportedException if image has packed a pixel format

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:

RR	GR	BR
RG	GG	BG
RB	GB	BB

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

Member Data Documentation

PEAK_IPL_MAYBE_UNUSED

peak::ipl::ColorCorrector::PEAK_IPL_MAYBE_UNUSED = peak::ipl::ColorCorrectionFactors ColorCorrectionFactors()

---

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

• peak_ipl/algorithm/peak_ipl_color_corrector.hpp