quantumtimeseriesplotwidget.h

Go to the documentation of this file.

/**
 * @file quantumtimeseriesplotwidget.h
 * @brief Declares the quantumtimeseriesplotwidget visualization component used by QPE.
 * @ingroup qpe_graphics
 *
 * Source: @c graphics/renderer/quantumtimeseriesplotwidget.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 "core/quantum/observablestimeseries2d.h"
 
#include <QWidget>
#include <QString>
 
class QPaintEvent;
 
/**
 * @brief Qt visualization component for Quantum Time Series Plot Widget.
 *
 * The class presents computed state to the user and does not alter the propagated physical state.
 */
class QuantumTimeSeriesPlotWidget final : public QWidget
{
public:
    /**
     * @brief Enumerates the supported Quantity values.
     *
     * The enumeration is part of the typed interface used to keep experiment configuration and analysis routing explicit.
     */
    enum class Quantity
    {
        MeanX = 0,
        MeanY,
        SigmaX,
        SigmaY,
        Norm,
        AbsorbedProbability,
        ReflectionProbability,
        TransmissionProbability,
        KineticEnergy,
        PotentialEnergy,
        TotalEnergy,
        EnergyDriftPercent,
        LeftWellProbability,
        RightWellProbability
    };
 
    /**
     * @brief Constructs a Quantum Time Series Plot Widget instance.
     * @param parent Optional Qt parent object/widget.
     */
    explicit QuantumTimeSeriesPlotWidget(QWidget *parent = nullptr);
 
    /**
     * @brief Sets samples.
     * @param samples The samples value used by the operation.
     */
    void setSamples(const std::vector<qpe::ObservablesTimeSeries2DSample> &samples);
    /**
     * @brief Clears samples.
     */
    void clearSamples();
    /**
     * @brief Sets quantity.
     * @param quantity The quantity value used by the operation.
     */
    void setQuantity(Quantity quantity);
    /**
     * @brief Carries out quantity.
     */
    Quantity quantity() const noexcept { return quantity_; }
 
    /**
     * @brief Carries out minimum size hint.
     */
    QSize minimumSizeHint() const override;
 
protected:
    /**
     * @brief Paints event.
     * @param event Qt event being handled.
     */
    void paintEvent(QPaintEvent *event) override;
 
private:
    /**
     * @brief Samples value.
     * @param sample The sample value used by the operation.
     * @param value Value to assign or evaluate.
     */
    bool sampleValue(const qpe::ObservablesTimeSeries2DSample &sample,
                     double &value) const noexcept;
    /**
     * @brief Carries out quantity title.
     */
    QString quantityTitle() const;
    /**
     * @brief Carries out fixed probability range.
     */
    bool fixedProbabilityRange() const noexcept;
 
    std::vector<qpe::ObservablesTimeSeries2DSample> samples_;
    Quantity quantity_ = Quantity::MeanX;
};