probabilityimagerenderer.h

Go to the documentation of this file.

/**
 * @file probabilityimagerenderer.h
 * @brief Declares the probabilityimagerenderer visualization component used by QPE.
 * @ingroup qpe_graphics
 *
 * Source: @c graphics/renderer/probabilityimagerenderer.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
 
#include <QImage>
 
namespace qpe {
class ComplexField2D;
 
/**
 * @brief Configuration values for Probability Render Options.
 *
 * The structure groups parameters that are passed together so the associated numerical/analysis component can be configured reproducibly.
 */
struct ProbabilityRenderOptions
{
    // Display normalization only: the physical wavefunction is never modified.
    bool normalizeToPeak = true;
    float gamma = 1.0f;
};
 
/**
 * @brief Implements the Probability Image Renderer component.
 *
 * The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.
 */
class ProbabilityImageRenderer
{
public:
    /**
     * @brief Renders the component state.
     * @param field Field data to read or modify.
     * @param options The options value used by the operation.
     */
    static QImage render(const ComplexField2D &field,
                         const ProbabilityRenderOptions &options = {});
 
    /**
     * @brief Carries out peak probability.
     * @param field Field data to read or modify.
     */
    static double peakProbability(const ComplexField2D &field) noexcept;
};
 
} // namespace qpe