quantumblochplotwidget.h

Go to the documentation of this file.

/**
 * @file quantumblochplotwidget.h
 * @brief Declares the quantumblochplotwidget visualization component used by QPE.
 * @ingroup qpe_graphics
 *
 * Source: @c graphics/renderer/quantumblochplotwidget.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/blochoscillations2d.h"
#include "core/quantum/observablestimeseries2d.h"
 
#include <QWidget>
 
class QPaintEvent;
 
/**
 * @brief Qt visualization component for Quantum Bloch Plot Widget.
 *
 * The class presents computed state to the user and does not alter the propagated physical state.
 */
class QuantumBlochPlotWidget final : public QWidget
{
public:
    /**
     * @brief Performs quantum bloch plot widget.
     * @param parent Optional Qt parent object/widget.
     */
    explicit QuantumBlochPlotWidget(QWidget *parent = nullptr);
 
    /**
     * @brief Sets data.
     * @param samples The samples value used by the operation.
     * @param geometry The geometry value used by the operation.
     * @param initialMomentum The initial momentum value used by the operation.
     * @param hbar The hbar value used by the operation.
     */
    void setData(const std::vector<qpe::ObservablesTimeSeries2DSample> &samples,
                 const qpe::BlochLatticeGeometry2D &geometry,
                 double initialMomentum,
                 double hbar);
    /**
     * @brief Performs clear.
     */
    void clear();
 
    /**
     * @brief Performs minimum size hint.
     */
    QSize minimumSizeHint() const override;
 
protected:
    /**
     * @brief Paints event.
     * @param event Qt event being handled.
     */
    void paintEvent(QPaintEvent *event) override;
 
private:
    std::vector<qpe::ObservablesTimeSeries2DSample> samples_;
    qpe::BlochLatticeGeometry2D geometry_;
    double initialMomentum_ = 0.0;
    double hbar_ = 1.0;
};