This class holds the parameters for a levels adjustment. It is modeled after KisCubicCurve and has similar interface and functionality. More...

#include <KisLevelsCurve.h>

Public Member Functions
const QVector< qreal > &	floatTransfer (int size=256) const
	Returns a vector of size.

void	fromString (const QString &text, bool *ok=nullptr)
	Parses the parameters from a given text.

qreal	inputBlackPoint () const
	Get the input black point.

qreal	inputGamma () const
	Get the gamma value.

qreal	inputWhitePoint () const
	Get the input white point.

bool	isIdentity () const
	Check whether the level info maps all values to themselves.

	KisLevelsCurve ()

	KisLevelsCurve (const KisLevelsCurve &rhs)=default

	KisLevelsCurve (const QString &text)

	KisLevelsCurve (qreal inputBlackPoint, qreal inputWhitePoint, qreal inputGamma, qreal outputBlackPoint, qreal outputWhitePoint)

const QString &	name () const
	Get the name associated with this levels info object.

KisLevelsCurve &	operator= (const KisLevelsCurve &rhs)=default

bool	operator== (const KisLevelsCurve &rhs) const

qreal	outputBlackPoint () const
	Get the output black point.

qreal	outputWhitePoint () const
	Get the output white point.

void	resetAll ()
	Resets the input and output levels (and gamma)

void	resetInputLevels ()
	Resets the input levels only (and gamma)

void	resetOutputLevels ()
	Resets the output levels only.

void	setInputBlackPoint (qreal newInputBlackPoint)
	Set the input black point.

void	setInputGamma (qreal newInputGamma)
	Set the gamma value.

void	setInputWhitePoint (qreal newInputWhitePoint)
	Set the input white point.

void	setName (const QString &newName)
	Set the name associated with this levels info object. This allows us to carry around a display name for the level info internally. It could potentially be useful anywhere level info are used in the UI.

void	setOutputBlackPoint (qreal newOutputBlackPoint)
	Set the output black point.

void	setOutputWhitePoint (qreal newOutputWhitePoint)
	Set the output white point.

QString	toString () const
	Get a text representation of the parameters. The format is: "input_black_point;input_white_point;input_gamma;output_black_point;output_white_point". For example: "0;1;0.6;0;1", "0.2;0.8;1.2;0.25;0.75".

const QVector< quint16 > &	uint16Transfer (int size=256) const
	Returns a vector of size.

qreal	value (qreal x) const
	Evaluates the function formed by the levels parameters for a given x. The input and output values are normalized.

Static Public Member Functions
static constexpr qreal	defaultInputBlackPoint ()
	Default value for the input black point.

static constexpr qreal	defaultInputGamma ()
	Default value for the input gamma.

static constexpr qreal	defaultInputWhitePoint ()
	Default value for the input white point.

static constexpr qreal	defaultOutputBlackPoint ()
	Default value for the output black point.

static constexpr qreal	defaultOutputWhitePoint ()
	Default value for the output white point.

Private Member Functions
void	invalidate ()

Private Attributes
QVector< qreal >	m_fTransfer

qreal	m_inputBlackPoint

qreal	m_inputGamma

qreal	m_inputLevelsDelta

qreal	m_inputWhitePoint

qreal	m_inverseInputGamma

bool	m_mustRecomputeFTransfer

bool	m_mustRecomputeU16Transfer

QString	m_name

qreal	m_outputBlackPoint

qreal	m_outputLevelsDelta

qreal	m_outputWhitePoint

QVector< quint16 >	m_u16Transfer

Detailed Description

This class holds the parameters for a levels adjustment. It is modeled after KisCubicCurve and has similar interface and functionality.

Definition at line 21 of file KisLevelsCurve.h.

Constructor & Destructor Documentation

◆ KisLevelsCurve() [1/4]

KisLevelsCurve::KisLevelsCurve ( )

Definition at line 15 of file KisLevelsCurve.cpp.

    : KisLevelsCurve(defaultInputBlackPoint(), defaultInputWhitePoint(), defaultInputGamma(),
                     defaultOutputBlackPoint(), defaultOutputWhitePoint())
{}

◆ KisLevelsCurve() [2/4]

KisLevelsCurve::KisLevelsCurve	(	qreal	inputBlackPoint,
		qreal	inputWhitePoint,
		qreal	inputGamma,
		qreal	outputBlackPoint,
		qreal	outputWhitePoint )

Definition at line 20 of file KisLevelsCurve.cpp.

    : m_inputBlackPoint(inputBlackPoint)
    , m_inputWhitePoint(inputWhitePoint)
    , m_inputGamma(inputGamma)
    , m_outputBlackPoint(outputBlackPoint)
    , m_outputWhitePoint(outputWhitePoint)
    , m_inputLevelsDelta(inputWhitePoint - inputBlackPoint)
    , m_inverseInputGamma(1.0 / m_inputGamma)
    , m_outputLevelsDelta(outputWhitePoint - outputBlackPoint)
    , m_mustRecomputeU16Transfer(true)
    , m_mustRecomputeFTransfer(true)
{}

◆ KisLevelsCurve() [3/4]

KisLevelsCurve::KisLevelsCurve ( const QString & text )

See also: toString(); fromString()

Definition at line 34 of file KisLevelsCurve.cpp.

    : KisLevelsCurve()
{
    fromString(text);
}

References fromString().

◆ KisLevelsCurve() [4/4]

KisLevelsCurve::KisLevelsCurve ( const KisLevelsCurve & rhs )

default

Member Function Documentation

◆ defaultInputBlackPoint()

static constexpr qreal KisLevelsCurve::defaultInputBlackPoint ( )

inlinestaticconstexpr

Default value for the input black point.

Definition at line 27 of file KisLevelsCurve.h.

27{ return 0.0; }

◆ defaultInputGamma()

static constexpr qreal KisLevelsCurve::defaultInputGamma ( )

inlinestaticconstexpr

Default value for the input gamma.

Definition at line 35 of file KisLevelsCurve.h.

35{ return 1.0; }

◆ defaultInputWhitePoint()

static constexpr qreal KisLevelsCurve::defaultInputWhitePoint ( )

inlinestaticconstexpr

Default value for the input white point.

Definition at line 31 of file KisLevelsCurve.h.

31{ return 1.0; }

◆ defaultOutputBlackPoint()

static constexpr qreal KisLevelsCurve::defaultOutputBlackPoint ( )

inlinestaticconstexpr

Default value for the output black point.

Definition at line 39 of file KisLevelsCurve.h.

39{ return 0.0; }

◆ defaultOutputWhitePoint()

static constexpr qreal KisLevelsCurve::defaultOutputWhitePoint ( )

inlinestaticconstexpr

Default value for the output white point.

Definition at line 43 of file KisLevelsCurve.h.

43{ return 1.0; }

◆ floatTransfer()

const QVector< qreal > & KisLevelsCurve::floatTransfer ( int size = 256 ) const

Returns a vector of size.

Parameters

size	with values obtained by evaluating the function formed by the levels parameters from 0.0 to 1.0. The resulting values are in the range [0, 1]
size	The size of the returned vector

Returns: const QVector<qreal>& The vector with the values

See also: value(); uint16Transfer()

Definition at line 193 of file KisLevelsCurve.cpp.

{
    if (!m_mustRecomputeFTransfer && size == m_fTransfer.size()) {
        return m_fTransfer;
    }
 
    m_fTransfer.resize(size);
 
    for (int i = 0; i < size; ++i) {
        m_fTransfer[i] = value(static_cast<qreal>(i) / static_cast<qreal>(size - 1));
    }
 
    m_mustRecomputeFTransfer = false;
    return m_fTransfer;
}

References m_fTransfer, m_mustRecomputeFTransfer, and value().

◆ fromString()

void KisLevelsCurve::fromString	(	const QString &	text,
		bool *	ok = nullptr )

Parses the parameters from a given text.

See also: toString

Definition at line 219 of file KisLevelsCurve.cpp.

{
    KIS_SAFE_ASSERT_RECOVER(!text.isEmpty()) {
        resetAll();
        if (ok) {
            *ok = false;
        }
        return;
    }
    
    const QStringList data = text.split(';');
    KIS_SAFE_ASSERT_RECOVER(data.size() == 5) {
        resetAll();
        if (ok) {
            *ok = false;
        }
        return;
    }
 
    qreal values[5];
    bool ok_;
    for (int i = 0; i < 5; ++i) {
        ok_ = false;
        values[i] = KisDomUtils::toDouble(data.at(i), &ok_);
        KIS_SAFE_ASSERT_RECOVER(ok_) {
            resetAll();
            if (ok) {
                *ok = false;
            }
            return;
        }
    }
 
    m_inputBlackPoint = values[0];
    m_inputWhitePoint = values[1];
    m_inputGamma = values[2];
    m_outputBlackPoint = values[3];
    m_outputWhitePoint = values[4];
    m_inputLevelsDelta = m_inputWhitePoint - m_inputBlackPoint;
    m_inverseInputGamma = 1.0 / m_inputGamma;
    m_outputLevelsDelta = m_outputWhitePoint - m_outputBlackPoint;
    invalidate();
 
    if (ok) {
        *ok = true;
    }
}

References invalidate(), KIS_SAFE_ASSERT_RECOVER, m_inputBlackPoint, m_inputGamma, m_inputLevelsDelta, m_inputWhitePoint, m_inverseInputGamma, m_outputBlackPoint, m_outputLevelsDelta, m_outputWhitePoint, resetAll(), and KisDomUtils::toDouble().

◆ inputBlackPoint()

qreal KisLevelsCurve::inputBlackPoint ( ) const

Get the input black point.

Definition at line 64 of file KisLevelsCurve.cpp.

{
    return m_inputBlackPoint;
}

References m_inputBlackPoint.

◆ inputGamma()

qreal KisLevelsCurve::inputGamma ( ) const

Get the gamma value.

Definition at line 74 of file KisLevelsCurve.cpp.

{
    return m_inputGamma;
}

References m_inputGamma.

◆ inputWhitePoint()

qreal KisLevelsCurve::inputWhitePoint ( ) const

Get the input white point.

Definition at line 69 of file KisLevelsCurve.cpp.

{
    return m_inputWhitePoint;
}

References m_inputWhitePoint.

◆ invalidate()

void KisLevelsCurve::invalidate ( )

private

Definition at line 267 of file KisLevelsCurve.cpp.

{
    m_mustRecomputeU16Transfer = true;
    m_mustRecomputeFTransfer = true;
}

References m_mustRecomputeFTransfer, and m_mustRecomputeU16Transfer.

◆ isIdentity()

bool KisLevelsCurve::isIdentity ( ) const

Check whether the level info maps all values to themselves.

Definition at line 155 of file KisLevelsCurve.cpp.

{
    return 
        m_inputBlackPoint == 0.0 &&
        m_inputWhitePoint == 1.0 &&
        m_inputGamma == 1.0 &&
        m_outputBlackPoint == 0.0 &&
        m_outputWhitePoint == 1.0;
}

References m_inputBlackPoint, m_inputGamma, m_inputWhitePoint, m_outputBlackPoint, and m_outputWhitePoint.

◆ name()

const QString & KisLevelsCurve::name ( ) const

Get the name associated with this levels info object.

Definition at line 165 of file KisLevelsCurve.cpp.

{
    return m_name;
}

References m_name.

◆ operator=()

KisLevelsCurve & KisLevelsCurve::operator= ( const KisLevelsCurve & rhs )

default

◆ operator==()

bool KisLevelsCurve::operator== ( const KisLevelsCurve & rhs ) const

Definition at line 40 of file KisLevelsCurve.cpp.

{
    return
        &rhs == this ||
        (
            m_inputBlackPoint == rhs.m_inputBlackPoint &&
            m_inputWhitePoint == rhs.m_inputWhitePoint &&
            m_inputGamma == rhs.m_inputGamma &&
            m_outputBlackPoint == rhs.m_outputBlackPoint &&
            m_outputWhitePoint == rhs.m_outputWhitePoint
        );
}

References m_inputBlackPoint, m_inputGamma, m_inputWhitePoint, m_outputBlackPoint, and m_outputWhitePoint.

◆ outputBlackPoint()

qreal KisLevelsCurve::outputBlackPoint ( ) const

Get the output black point.

Definition at line 79 of file KisLevelsCurve.cpp.

{
    return m_outputBlackPoint;
}

References m_outputBlackPoint.

◆ outputWhitePoint()

qreal KisLevelsCurve::outputWhitePoint ( ) const

Get the output white point.

Definition at line 84 of file KisLevelsCurve.cpp.

{
    return m_outputWhitePoint;
}

References m_outputWhitePoint.

◆ resetAll()

void KisLevelsCurve::resetAll ( )

Resets the input and output levels (and gamma)

Definition at line 124 of file KisLevelsCurve.cpp.

{
    m_inputBlackPoint = defaultInputBlackPoint();
    m_inputWhitePoint = defaultInputWhitePoint();
    m_inputGamma = defaultInputGamma();
    m_outputBlackPoint = defaultOutputBlackPoint();
    m_outputWhitePoint = defaultOutputWhitePoint();
    m_inputLevelsDelta = m_inputWhitePoint - m_inputBlackPoint;
    m_inverseInputGamma = 1.0 / m_inputGamma;
    m_outputLevelsDelta = m_outputWhitePoint - m_outputBlackPoint;
    invalidate();
}

References defaultInputBlackPoint(), defaultInputGamma(), defaultInputWhitePoint(), defaultOutputBlackPoint(), defaultOutputWhitePoint(), invalidate(), m_inputBlackPoint, m_inputGamma, m_inputLevelsDelta, m_inputWhitePoint, m_inverseInputGamma, m_outputBlackPoint, m_outputLevelsDelta, and m_outputWhitePoint.

◆ resetInputLevels()

void KisLevelsCurve::resetInputLevels ( )

Resets the input levels only (and gamma)

Definition at line 137 of file KisLevelsCurve.cpp.

{
    m_inputBlackPoint = defaultInputBlackPoint();
    m_inputWhitePoint = defaultInputWhitePoint();
    m_inputGamma = defaultInputGamma();
    m_inputLevelsDelta = m_inputWhitePoint - m_inputBlackPoint;
    m_inverseInputGamma = 1.0 / m_inputGamma;
    invalidate();
}

References defaultInputBlackPoint(), defaultInputGamma(), defaultInputWhitePoint(), invalidate(), m_inputBlackPoint, m_inputGamma, m_inputLevelsDelta, m_inputWhitePoint, and m_inverseInputGamma.

◆ resetOutputLevels()

void KisLevelsCurve::resetOutputLevels ( )

Resets the output levels only.

Definition at line 147 of file KisLevelsCurve.cpp.

{
    m_outputBlackPoint = defaultOutputBlackPoint();
    m_outputWhitePoint = defaultOutputWhitePoint();
    m_outputLevelsDelta = m_outputWhitePoint - m_outputBlackPoint;
    invalidate();
}

References defaultOutputBlackPoint(), defaultOutputWhitePoint(), invalidate(), m_outputBlackPoint, m_outputLevelsDelta, and m_outputWhitePoint.

◆ setInputBlackPoint()

void KisLevelsCurve::setInputBlackPoint ( qreal newInputBlackPoint )

Set the input black point.

Definition at line 89 of file KisLevelsCurve.cpp.

{
    m_inputBlackPoint = newInputBlackPoint;
    m_inputLevelsDelta = m_inputWhitePoint - m_inputBlackPoint;
    invalidate();
}

References invalidate(), m_inputBlackPoint, m_inputLevelsDelta, and m_inputWhitePoint.

◆ setInputGamma()

void KisLevelsCurve::setInputGamma ( qreal newInputGamma )

Set the gamma value.

Definition at line 103 of file KisLevelsCurve.cpp.

{
    m_inputGamma = newInputGamma;
    m_inverseInputGamma = 1.0 / m_inputGamma;
    invalidate();
}

References invalidate(), m_inputGamma, and m_inverseInputGamma.

◆ setInputWhitePoint()

void KisLevelsCurve::setInputWhitePoint ( qreal newInputWhitePoint )

Set the input white point.

Definition at line 96 of file KisLevelsCurve.cpp.

{
    m_inputWhitePoint = newInputWhitePoint;
    m_inputLevelsDelta = m_inputWhitePoint - m_inputBlackPoint;
    invalidate();
}

References invalidate(), m_inputBlackPoint, m_inputLevelsDelta, and m_inputWhitePoint.

◆ setName()

void KisLevelsCurve::setName ( const QString & newName )

Set the name associated with this levels info object. This allows us to carry around a display name for the level info internally. It could potentially be useful anywhere level info are used in the UI.

Definition at line 170 of file KisLevelsCurve.cpp.

{
    m_name = newName;
}

References m_name.

◆ setOutputBlackPoint()

void KisLevelsCurve::setOutputBlackPoint ( qreal newOutputBlackPoint )

Set the output black point.

Definition at line 110 of file KisLevelsCurve.cpp.

{
    m_outputBlackPoint = newOutputBlackPoint;
    m_outputLevelsDelta = m_outputWhitePoint - m_outputBlackPoint;
    invalidate();
}

References invalidate(), m_outputBlackPoint, m_outputLevelsDelta, and m_outputWhitePoint.

◆ setOutputWhitePoint()

void KisLevelsCurve::setOutputWhitePoint ( qreal newOutputWhitePoint )

Set the output white point.

Definition at line 117 of file KisLevelsCurve.cpp.

{
    m_outputWhitePoint = newOutputWhitePoint;
    m_outputLevelsDelta = m_outputWhitePoint - m_outputBlackPoint;
    invalidate();
}

References invalidate(), m_outputBlackPoint, m_outputLevelsDelta, and m_outputWhitePoint.

◆ toString()

QString KisLevelsCurve::toString ( ) const

Get a text representation of the parameters. The format is: "input_black_point;input_white_point;input_gamma;output_black_point;output_white_point". For example: "0;1;0.6;0;1", "0.2;0.8;1.2;0.25;0.75".

See also: fromString()

Definition at line 209 of file KisLevelsCurve.cpp.

{
    return
        KisDomUtils::toString(m_inputBlackPoint) + ";" +
        KisDomUtils::toString(m_inputWhitePoint) + ";" +
        KisDomUtils::toString(m_inputGamma) + ";" +
        KisDomUtils::toString(m_outputBlackPoint) + ";" +
        KisDomUtils::toString(m_outputWhitePoint);
}

References m_inputBlackPoint, m_inputGamma, m_inputWhitePoint, m_outputBlackPoint, m_outputWhitePoint, and KisDomUtils::toString().

◆ uint16Transfer()

const QVector< quint16 > & KisLevelsCurve::uint16Transfer ( int size = 256 ) const

Returns a vector of size.

Parameters

size	with values obtained by evaluating the function formed by the levels parameters from 0.0 to 1.0. The resulting values are scaled to the range [0, 0xFF]
size	The size of the returned vector

Returns: const QVector<quint16>& The vector with the values

See also: value(); floatTransfer()

Definition at line 175 of file KisLevelsCurve.cpp.

{
 
    if (!m_mustRecomputeU16Transfer && size == m_u16Transfer.size()) {
        return m_u16Transfer;
    }
 
    m_u16Transfer.resize(size);
 
    for (int i = 0; i < size; ++i) {
        const qreal x = static_cast<qreal>(i) / static_cast<qreal>(size - 1);
        m_u16Transfer[i] = static_cast<quint16>(qRound(value(x) * static_cast<qreal>(0xFFFF)));
    }
 
    m_mustRecomputeU16Transfer = false;
    return m_u16Transfer;
}

References m_mustRecomputeU16Transfer, m_u16Transfer, and value().

◆ value()

qreal KisLevelsCurve::value ( qreal x ) const

Evaluates the function formed by the levels parameters for a given x. The input and output values are normalized.

Definition at line 53 of file KisLevelsCurve.cpp.

{
    if (x <= m_inputBlackPoint)
        return m_outputBlackPoint;
    else if (x < m_inputWhitePoint) {
        return m_outputBlackPoint + m_outputLevelsDelta * std::pow((x - m_inputBlackPoint) / m_inputLevelsDelta, m_inverseInputGamma);
    } else {
        return m_outputWhitePoint;
    }
}

References m_inputBlackPoint, m_inputLevelsDelta, m_inputWhitePoint, m_inverseInputGamma, m_outputBlackPoint, m_outputLevelsDelta, and m_outputWhitePoint.

Member Data Documentation

◆ m_fTransfer

QVector<qreal> KisLevelsCurve::m_fTransfer

mutableprivate

Definition at line 174 of file KisLevelsCurve.h.

◆ m_inputBlackPoint

qreal KisLevelsCurve::m_inputBlackPoint

private

Definition at line 169 of file KisLevelsCurve.h.

◆ m_inputGamma

qreal KisLevelsCurve::m_inputGamma

private

Definition at line 169 of file KisLevelsCurve.h.

◆ m_inputLevelsDelta

qreal KisLevelsCurve::m_inputLevelsDelta

private

Definition at line 171 of file KisLevelsCurve.h.

◆ m_inputWhitePoint

qreal KisLevelsCurve::m_inputWhitePoint

private

Definition at line 169 of file KisLevelsCurve.h.

◆ m_inverseInputGamma

qreal KisLevelsCurve::m_inverseInputGamma

private

Definition at line 171 of file KisLevelsCurve.h.

◆ m_mustRecomputeFTransfer

bool KisLevelsCurve::m_mustRecomputeFTransfer

mutableprivate

Definition at line 176 of file KisLevelsCurve.h.

◆ m_mustRecomputeU16Transfer

bool KisLevelsCurve::m_mustRecomputeU16Transfer

mutableprivate

Definition at line 175 of file KisLevelsCurve.h.

◆ m_name

QString KisLevelsCurve::m_name

private

Definition at line 172 of file KisLevelsCurve.h.

◆ m_outputBlackPoint

qreal KisLevelsCurve::m_outputBlackPoint

private

Definition at line 170 of file KisLevelsCurve.h.

◆ m_outputLevelsDelta

qreal KisLevelsCurve::m_outputLevelsDelta

private

Definition at line 171 of file KisLevelsCurve.h.

◆ m_outputWhitePoint

qreal KisLevelsCurve::m_outputWhitePoint

private

Definition at line 170 of file KisLevelsCurve.h.

◆ m_u16Transfer

QVector<quint16> KisLevelsCurve::m_u16Transfer

mutableprivate

Definition at line 173 of file KisLevelsCurve.h.

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

libs/image/KisLevelsCurve.h
libs/image/KisLevelsCurve.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KisLevelsCurve() [1/4]

◆ KisLevelsCurve() [2/4]

◆ KisLevelsCurve() [3/4]

◆ KisLevelsCurve() [4/4]

Member Function Documentation

◆ defaultInputBlackPoint()

◆ defaultInputGamma()

◆ defaultInputWhitePoint()

◆ defaultOutputBlackPoint()

◆ defaultOutputWhitePoint()

◆ floatTransfer()

◆ fromString()

◆ inputBlackPoint()

◆ inputGamma()

◆ inputWhitePoint()

◆ invalidate()

◆ isIdentity()

◆ name()

◆ operator=()

◆ operator==()

◆ outputBlackPoint()

◆ outputWhitePoint()

◆ resetAll()

◆ resetInputLevels()

◆ resetOutputLevels()

◆ setInputBlackPoint()

◆ setInputGamma()

◆ setInputWhitePoint()

◆ setName()

◆ setOutputBlackPoint()

◆ setOutputWhitePoint()

◆ toString()

◆ uint16Transfer()

◆ value()

Member Data Documentation

◆ m_fTransfer

◆ m_inputBlackPoint

◆ m_inputGamma

◆ m_inputLevelsDelta

◆ m_inputWhitePoint

◆ m_inverseInputGamma

◆ m_mustRecomputeFTransfer

◆ m_mustRecomputeU16Transfer

◆ m_name

◆ m_outputBlackPoint

◆ m_outputLevelsDelta

◆ m_outputWhitePoint

◆ m_u16Transfer