peak::ipl::ColorCorrectionFactors Struct Reference

The Factors of the Color Correction Matrix. More...

#include <peak_ipl/types/peak_ipl_color_correction_factors.hpp>

Public Member Functions
constexpr	ColorCorrectionFactors (float facRR, float facGR, float facBR, float facRG, float facGG, float facBG, float facRB, float facGB, float facBB)
	Constructor for a new ColorCorrectionFactors instance.
constexpr	ColorCorrectionFactors (const std::array< float, 9 > &factors)
	Constructor for a new ColorCorrectionFactors instance.
constexpr	ColorCorrectionFactors ()=default
	Constructor for a new ColorCorrectionFactors instance.
	~ColorCorrectionFactors ()=default
	Destructor for the ColorCorrectionFactors instance.
	ColorCorrectionFactors (ColorCorrectionFactors &&o)=default
	Copy Constructor for a new ColorCorrectionFactors instance.
	ColorCorrectionFactors (const ColorCorrectionFactors &o)=default
	Move constructor for ColorCorrectionFactors instance.
ColorCorrectionFactors &	operator= (const ColorCorrectionFactors &o)=default
	Copy assigment for ColorCorrectionFactors instance.
ColorCorrectionFactors &	operator= (ColorCorrectionFactors &&o)=default
	Move assignment for ColorCorrectionFactors instance.
constexpr bool	operator== (const ColorCorrectionFactors &other) const
	Compare ColorCorrectionFactors.
constexpr std::array< float, 9 >	AsArray () const
	Returns the ColorCorrectionFactors as an array.

Static Public Member Functions
static constexpr ColorCorrectionFactors	Identity ()
	Create an identity matrix.

Public Attributes
float	factorRR {}
	Red-Red Factor.
float	factorGR {}
	Green-Red Factor.
float	factorBR {}
	Blue-Red Factor.
float	factorRG {}
	Red-Green Factor.
float	factorGG {}
	Green-Green Factor.
float	factorBG {}
	Blue-Green Factor.
float	factorRB {}
	Red-Blue Factor.
float	factorGB {}
	Green-Blue Factor.
float	factorBB {}
	Blue-Blue Factor.

Detailed Description

The Factors of the Color Correction Matrix.

Constructor & Destructor Documentation

ColorCorrectionFactors() [1/5]

peak::ipl::ColorCorrectionFactors::ColorCorrectionFactors ( float facRR, float facGR, float facBR, float facRG, float facGG, float facBG, float facRB, float facGB, float facBB )

inlineconstexpr

Constructor for a new ColorCorrectionFactors instance.

Creates a new ColorCorrectionFactors instance.

The matrix is row-wise sorted:

RR	GR	BR
RG	GG	BG
RB	GB	BB

Parameters

[in]	facRR	Red-Red Factor.
[in]	facGR	Green-Red Factor.
[in]	facBR	Blue-Red Factor.
[in]	facRG	Red-Green Factor.
[in]	facGG	Green-Green Factor.
[in]	facBG	Blue-Green Factor.
[in]	facRB	Red-Blue Factor.
[in]	facGB	Green-Blue Factor.
[in]	facBB	Blue-Blue Factor.

Since

1.0

ColorCorrectionFactors() [2/5]

peak::ipl::ColorCorrectionFactors::ColorCorrectionFactors ( const std::array< float, 9 > & factors )

inlineexplicitconstexpr

Constructor for a new ColorCorrectionFactors instance.

Creates a new ColorCorrectionFactors instance with an array. The values are expected left to right and top to bottom.

The matrix is row-wise sorted:

RR (0)	GR (1)	BR (2)
RG (3)	GG (4)	BG (5)
RB (6)	GB (7)	BB (8)

Parameters

[in]

factors

The factors.

Since

1.16

ColorCorrectionFactors() [3/5]

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

constexprdefault

Constructor for a new ColorCorrectionFactors instance.

Creates a new ColorCorrectionFactors instance. The Factors are initialized to zero.

Since

1.0

~ColorCorrectionFactors()

peak::ipl::ColorCorrectionFactors::~ColorCorrectionFactors ( )

default

Destructor for the ColorCorrectionFactors instance.

Destroys a ColorCorrectionFactors instance.

Since

1.0

ColorCorrectionFactors() [4/5]

peak::ipl::ColorCorrectionFactors::ColorCorrectionFactors ( ColorCorrectionFactors && o )

default

Copy Constructor for a new ColorCorrectionFactors instance.

Creates a new ColorCorrectionFactors instance. The Factors are copied from other

Parameters

[in]

o

The other instance to copy the factors from.

Since

1.0

ColorCorrectionFactors() [5/5]

peak::ipl::ColorCorrectionFactors::ColorCorrectionFactors ( const ColorCorrectionFactors & o )

default

Move constructor for ColorCorrectionFactors instance.

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

Parameters

[in]

o

The other instance to move the factors from.

Since

1.0

Member Function Documentation

AsArray()

std::array< float, 9 > peak::ipl::ColorCorrectionFactors::AsArray ( ) const

inlineconstexpr

Returns the ColorCorrectionFactors as an array.

Returns

The factors as a std::array.

Since

1.16

Identity()

static constexpr ColorCorrectionFactors peak::ipl::ColorCorrectionFactors::Identity ( )

inlinestaticconstexpr

Create an identity matrix.

This will return a ColorCorrectionFactors matrix with diagonal all 1 and all other 0.

Returns

The identity matrix.

Since

1.16

operator=() [1/2]

ColorCorrectionFactors & peak::ipl::ColorCorrectionFactors::operator= ( ColorCorrectionFactors && o )

default

Move assignment for ColorCorrectionFactors instance.

Moves the factors from other to this.

Parameters

[in]

o

The other instance to move the factors from.

Since

1.0

operator=() [2/2]

ColorCorrectionFactors & peak::ipl::ColorCorrectionFactors::operator= ( const ColorCorrectionFactors & o )

default

Copy assigment for ColorCorrectionFactors instance.

Copies the Factors from other to this instance.

Parameters

[in]

o

The other instance to copy the factors from.

Since

1.0

operator==()

bool peak::ipl::ColorCorrectionFactors::operator== ( const ColorCorrectionFactors & other ) const

inlineconstexpr

Compare ColorCorrectionFactors.

Compares the factors from other to this instance

Parameters

[in]

other

The other instance to compare.

Returns

True if equal, false otherwise.

Since

1.0

Member Data Documentation

factorBB

float peak::ipl::ColorCorrectionFactors::factorBB {}

Blue-Blue Factor.

factorBG

float peak::ipl::ColorCorrectionFactors::factorBG {}

Blue-Green Factor.

factorBR

float peak::ipl::ColorCorrectionFactors::factorBR {}

Blue-Red Factor.

factorGB

float peak::ipl::ColorCorrectionFactors::factorGB {}

Green-Blue Factor.

factorGG

float peak::ipl::ColorCorrectionFactors::factorGG {}

Green-Green Factor.

factorGR

float peak::ipl::ColorCorrectionFactors::factorGR {}

Green-Red Factor.

factorRB

float peak::ipl::ColorCorrectionFactors::factorRB {}

Red-Blue Factor.

factorRG

float peak::ipl::ColorCorrectionFactors::factorRG {}

Red-Green Factor.

factorRR

float peak::ipl::ColorCorrectionFactors::factorRR {}

Red-Red Factor.

---

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

• peak_ipl/types/peak_ipl_color_correction_factors.hpp