quantumtonemapping.h

Go to the documentation of this file.

/**
 * @file quantumtonemapping.h
 * @brief Declares the quantumtonemapping visualization component used by QPE.
 * @ingroup qpe_graphics
 *
 * Source: @c graphics/renderer/quantumtonemapping.h. This file is part of Quantum Phenomena Explorer (QPE),
 * maintained by Officina Turini. See LICENSE_IT.txt / LICENSE.txt for the
 * QPE freeware source-available terms and THIRD_PARTY_NOTICES.txt for
 * third-party components.
 */
 
#pragma once
 
namespace qpe {
 
/**
 * @brief Enumerates the supported Quantum Tone Map Operator values.
 *
 * The enumeration is part of the typed interface used to keep experiment configuration and analysis routing explicit.
 */
enum class QuantumToneMapOperator
{
    Off = 0,
    Reinhard,
    AcesFilmic
};
 
/**
 * @brief Data record containing Quantum Tone Map Sample.
 *
 * The structure carries computed data without coupling the numerical component to the GUI or renderer.
 */
struct QuantumToneMapSample
{
    float r = 0.0f;
    float g = 0.0f;
    float b = 0.0f;
};
 
// CPU reference for the final HDR -> display tone-mapping pass.
// This is display-only: it never modifies psi, probability, or observables.
/**
 * @brief Implements the Quantum Tone Mapping component.
 *
 * The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.
 */
class QuantumToneMapping
{
public:
    /**
     * @brief Performs map channel.
     * @param value Value to assign or evaluate.
     * @param op The op value used by the operation.
     */
    static float mapChannel(float value, QuantumToneMapOperator op);
    /**
     * @brief Performs apply.
     * @param hdr The hdr value used by the operation.
     * @param op The op value used by the operation.
     */
    static QuantumToneMapSample apply(const QuantumToneMapSample &hdr,
                                      QuantumToneMapOperator op);
};
 
} // namespace qpe