peak::ipl::ColorCorrectionFactors Struct Reference

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

#include <peak_ipl/algorithm/peak_ipl_color_corrector.hpp>

Public Member Functions
	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. More...
	ColorCorrectionFactors ()=default
	Constructor for a new ColorCorrectionFactors instance. More...
	~ColorCorrectionFactors ()=default
	Destructor for the ColorCorrectionFactors instance. More...
	ColorCorrectionFactors (ColorCorrectionFactors &&o)=default
	Copy Constructor for a new ColorCorrectionFactors instance. More...
	ColorCorrectionFactors (const ColorCorrectionFactors &o)=default
	Move constructor for ColorCorrectionFactors instance. More...
ColorCorrectionFactors &	operator= (const ColorCorrectionFactors &o)=default
	Copy assigment for ColorCorrectionFactors instance. More...
ColorCorrectionFactors &	operator= (ColorCorrectionFactors &&o)=default
	Move assignment for ColorCorrectionFactors instance. More...

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

Detailed Description

The Factors of the Color Correction Matrix.

Constructor & Destructor Documentation

ColorCorrectionFactors() [1/4]

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

inline

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/4]

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

default

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() [3/4]

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() [4/4]

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

default

Move constructor for ColorCorrectionFactors instance.

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

Parameters

[in]

o

The other instance to move the factors from.

Since

1.0

Member Function Documentation

operator=() [1/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=() [2/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

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.

PEAK_IPL_MAYBE_UNUSED

peak::ipl::ColorCorrectionFactors::PEAK_IPL_MAYBE_UNUSED

Initial value:

= bool operator==(const ColorCorrectionFactors& other) const
    {
        return (isEqual(factorRR, other.factorRR) && isEqual(factorGR, other.factorGR)
            && isEqual(factorBR, other.factorBR) && isEqual(factorRG, other.factorRG)
            && isEqual(factorGG, other.factorGG) && isEqual(factorBG, other.factorBG)
            && isEqual(factorRB, other.factorRB) && isEqual(factorGB, other.factorGB)
            && isEqual(factorBB, other.factorBB));
    }

    float factorRR{}

Red-Red Factor.

---

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

• peak_ipl/algorithm/peak_ipl_color_corrector.hpp