wavefunctionimagerenderer.h

Go to the documentation of this file.

/**
 * @file wavefunctionimagerenderer.h
 * @brief Declares the wavefunctionimagerenderer visualization component used by QPE.
 * @ingroup qpe_graphics
 *
 * Source: @c graphics/renderer/wavefunctionimagerenderer.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 Enumerates the supported Wave Function View values.
 *
 * The enumeration is part of the typed interface used to keep experiment configuration and analysis routing explicit.
 */
enum class WaveFunctionView
{
    Probability = 0,
    Phase,
    Real,
    Imaginary
};
 
/**
 * @brief Configuration values for Wave Function Render Options.
 *
 * The structure groups parameters that are passed together so the associated numerical/analysis component can be configured reproducibly.
 */
struct WaveFunctionRenderOptions
{
    // Display-only gamma. The wavefunction itself is never modified.
    float gamma = 1.0f;
};
 
/**
 * @brief Implements the Wave Function Image Renderer component.
 *
 * The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.
 */
class WaveFunctionImageRenderer
{
public:
    /**
     * @brief Renders the component state.
     * @param field Field data to read or modify.
     * @param view The view value used by the operation.
     * @param options The options value used by the operation.
     */
    static QImage render(const ComplexField2D &field,
                         WaveFunctionView view,
                         const WaveFunctionRenderOptions &options = {});
 
    /**
     * @brief Carries out peak amplitude.
     * @param field Field data to read or modify.
     */
    static double peakAmplitude(const ComplexField2D &field) noexcept;
    /**
     * @brief Carries out peak abs real.
     * @param field Field data to read or modify.
     */
    static double peakAbsReal(const ComplexField2D &field) noexcept;
    /**
     * @brief Carries out peak abs imaginary.
     * @param field Field data to read or modify.
     */
    static double peakAbsImaginary(const ComplexField2D &field) noexcept;
};
 
} // namespace qpe