Implements the Quantum Talbot History2D component. More...

#include <quantumtalbot2d.h>

Public Member Functions
	QuantumTalbotHistory2D (std::size_t maximumSamples=1000u)
	Constructs a Quantum Talbot History 2D instance.

void	clear () noexcept
	Clears stored state and returns the component to its empty/default state.

bool	captureReference (const ComplexField2D &field, const QuantumTalbotInitialState2DConfig &config)
	Carries out capture reference.

bool	hasReference () const noexcept
	Returns whether reference.

void	setMaximumSamples (std::size_t maximumSamples)
	Sets maximum samples.

std::size_t	maximumSamples () const noexcept
	Carries out maximum samples.

bool	append (double time, const ComplexField2D &field)
	Carries out append.

const std::vector< QuantumTalbotSample2D > &	samples () const noexcept
	Samples s.

const std::vector< float > &	referenceMarginal () const noexcept
	Carries out reference marginal.

const QuantumTalbotInitialState2DConfig &	config () const noexcept
	Returns config.

std::size_t	gridWidth () const noexcept
	Carries out grid width.

float	dx () const noexcept
	Returns the X-axis grid spacing.

bool	empty () const noexcept
	Returns whether the object contains no data.

Private Member Functions
void	trimToLimit ()
	Carries out trim to limit.

Private Attributes
std::size_t	maximumSamples_ = 1000u

std::size_t	gridWidth_ = 0u

std::size_t	gridHeight_ = 0u

float	dx_ = 0.0f

float	dy_ = 0.0f

QuantumTalbotInitialState2DConfig	config_

std::vector< float >	referenceMarginal_

std::vector< float >	halfShiftReference_

std::vector< QuantumTalbotSample2D >	samples_

Detailed Description

Implements the Quantum Talbot History2D component.

The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.

Definition at line 131 of file quantumtalbot2d.h.

Constructor & Destructor Documentation

◆ QuantumTalbotHistory2D()

qpe::QuantumTalbotHistory2D::QuantumTalbotHistory2D ( std::size_t maximumSamples = 1000u )

explicit

Constructs a Quantum Talbot History 2D instance.

Parameters

maximumSamples The maximum samples value used by the operation.

Definition at line 214 of file quantumtalbot2d.cpp.

Member Function Documentation

◆ append()

bool qpe::QuantumTalbotHistory2D::append	(	double	time,
		const ComplexField2D &	field )

Carries out append.

Parameters

time	Simulation time in solver units.
field	Field data to read or modify.

Definition at line 258 of file quantumtalbot2d.cpp.

References qpe::ComplexField2D::dx(), dx_, qpe::ComplexField2D::dy(), dy_, qpe::ComplexField2D::empty(), gridHeight_, gridWidth_, halfShiftReference_, hasReference(), qpe::ComplexField2D::height(), qpe::QuantumTalbot2D::marginalProbabilityX(), qpe::QuantumTalbot2D::profileCorrelation(), referenceMarginal_, samples_, trimToLimit(), and qpe::ComplexField2D::width().

Referenced by MainWindow::recordTimeSeriesSample(), and qpe::tests::runQuantumTalbot2DTests().

◆ captureReference()

bool qpe::QuantumTalbotHistory2D::captureReference	(	const ComplexField2D &	field,
		const QuantumTalbotInitialState2DConfig &	config )

Carries out capture reference.

Parameters

field	Field data to read or modify.
config	Configuration to apply.

Definition at line 231 of file quantumtalbot2d.cpp.

References qpe::QuantumTalbot2D::circularShiftHalfPeriod(), clear(), config(), config_, qpe::ComplexField2D::dx(), dx_, qpe::ComplexField2D::dy(), dy_, qpe::ComplexField2D::empty(), gridHeight_, gridWidth_, halfShiftReference_, qpe::ComplexField2D::height(), qpe::QuantumTalbot2D::marginalProbabilityX(), qpe::QuantumTalbotInitialState2DConfig::period, referenceMarginal_, qpe::QuantumTalbot2D::validateConfig(), and qpe::ComplexField2D::width().

Referenced by MainWindow::resetSimulation(), and qpe::tests::runQuantumTalbot2DTests().

◆ clear()

void qpe::QuantumTalbotHistory2D::clear ( )

noexcept

Clears stored state and returns the component to its empty/default state.

Definition at line 219 of file quantumtalbot2d.cpp.

References config_, dx_, dy_, gridHeight_, gridWidth_, halfShiftReference_, referenceMarginal_, and samples_.

Referenced by captureReference(), and MainWindow::resetSimulation().

◆ config()

const QuantumTalbotInitialState2DConfig & qpe::QuantumTalbotHistory2D::config ( ) const

inlinenoexcept

Returns config.

Definition at line 193 of file quantumtalbot2d.h.

References config_.

Referenced by captureReference(), and QuantumTalbotPlotWidget::paintEvent().

◆ dx()

float qpe::QuantumTalbotHistory2D::dx ( ) const

inlinenoexcept

Returns the X-axis grid spacing.

Definition at line 205 of file quantumtalbot2d.h.

References dx_.

Referenced by QuantumTalbotPlotWidget::paintEvent(), and MainWindow::updateTalbotAnalysis().

◆ empty()

bool qpe::QuantumTalbotHistory2D::empty ( ) const

inlinenoexcept

Returns whether the object contains no data.

Parameters

empty The empty value used by the operation.

Definition at line 210 of file quantumtalbot2d.h.

References samples_.

Referenced by QuantumTalbotPlotWidget::paintEvent(), and MainWindow::updateTalbotAnalysis().

◆ gridWidth()

std::size_t qpe::QuantumTalbotHistory2D::gridWidth ( ) const

inlinenoexcept

Carries out grid width.

Definition at line 201 of file quantumtalbot2d.h.

References gridWidth_.

Referenced by QuantumTalbotPlotWidget::paintEvent(), and MainWindow::updateTalbotAnalysis().

◆ hasReference()

bool qpe::QuantumTalbotHistory2D::hasReference ( ) const

inlinenoexcept

Returns whether reference.

Parameters

empty The empty value used by the operation.

Definition at line 155 of file quantumtalbot2d.h.

References referenceMarginal_.

Referenced by append(), QuantumTalbotPlotWidget::paintEvent(), MainWindow::recordTimeSeriesSample(), and MainWindow::updateTalbotAnalysis().

◆ maximumSamples()

std::size_t qpe::QuantumTalbotHistory2D::maximumSamples ( ) const

inlinenoexcept

Carries out maximum samples.

Definition at line 165 of file quantumtalbot2d.h.

References maximumSamples_.

Referenced by setMaximumSamples().

◆ referenceMarginal()

const std::vector< float > & qpe::QuantumTalbotHistory2D::referenceMarginal ( ) const

inlinenoexcept

Carries out reference marginal.

Definition at line 185 of file quantumtalbot2d.h.

References referenceMarginal_.

◆ samples()

const std::vector< QuantumTalbotSample2D > & qpe::QuantumTalbotHistory2D::samples ( ) const

inlinenoexcept

Samples s.

Definition at line 177 of file quantumtalbot2d.h.

References samples_.

Referenced by QuantumTalbotPlotWidget::paintEvent(), qpe::tests::runQuantumTalbot2DTests(), and MainWindow::updateTalbotAnalysis().

◆ setMaximumSamples()

void qpe::QuantumTalbotHistory2D::setMaximumSamples ( std::size_t maximumSamples )

Sets maximum samples.

Parameters

maximumSamples The maximum samples value used by the operation.

Definition at line 252 of file quantumtalbot2d.cpp.

References maximumSamples(), maximumSamples_, and trimToLimit().

◆ trimToLimit()

void qpe::QuantumTalbotHistory2D::trimToLimit ( )

private

Carries out trim to limit.

Definition at line 278 of file quantumtalbot2d.cpp.

References maximumSamples_, and samples_.

Referenced by append(), and setMaximumSamples().

Member Data Documentation

◆ config_

QuantumTalbotInitialState2DConfig qpe::QuantumTalbotHistory2D::config_

private

Definition at line 223 of file quantumtalbot2d.h.

Referenced by captureReference(), clear(), and config().

◆ dx_

float qpe::QuantumTalbotHistory2D::dx_ = 0.0f

private

Definition at line 221 of file quantumtalbot2d.h.

Referenced by append(), captureReference(), clear(), and dx().

◆ dy_

float qpe::QuantumTalbotHistory2D::dy_ = 0.0f

private

Definition at line 222 of file quantumtalbot2d.h.

Referenced by append(), captureReference(), and clear().

◆ gridHeight_

std::size_t qpe::QuantumTalbotHistory2D::gridHeight_ = 0u

private

Definition at line 220 of file quantumtalbot2d.h.

Referenced by append(), captureReference(), and clear().

◆ gridWidth_

std::size_t qpe::QuantumTalbotHistory2D::gridWidth_ = 0u

private

Definition at line 219 of file quantumtalbot2d.h.

Referenced by append(), captureReference(), clear(), and gridWidth().

◆ halfShiftReference_

std::vector<float> qpe::QuantumTalbotHistory2D::halfShiftReference_

private

Definition at line 225 of file quantumtalbot2d.h.

Referenced by append(), captureReference(), and clear().

◆ maximumSamples_

std::size_t qpe::QuantumTalbotHistory2D::maximumSamples_ = 1000u

private

Definition at line 218 of file quantumtalbot2d.h.

Referenced by maximumSamples(), setMaximumSamples(), and trimToLimit().

◆ referenceMarginal_

std::vector<float> qpe::QuantumTalbotHistory2D::referenceMarginal_

private

Definition at line 224 of file quantumtalbot2d.h.

Referenced by append(), captureReference(), clear(), hasReference(), and referenceMarginal().

◆ samples_

std::vector<QuantumTalbotSample2D> qpe::QuantumTalbotHistory2D::samples_

private

Definition at line 226 of file quantumtalbot2d.h.

Referenced by append(), clear(), empty(), samples(), and trimToLimit().

The documentation for this class was generated from the following files:

core/quantum/quantumtalbot2d.h
core/quantum/quantumtalbot2d.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QuantumTalbotHistory2D()

Member Function Documentation

◆ append()

◆ captureReference()

◆ clear()

◆ config()

◆ dx()

◆ empty()

◆ gridWidth()

◆ hasReference()

◆ maximumSamples()

◆ referenceMarginal()

◆ samples()

◆ setMaximumSamples()

◆ trimToLimit()

Member Data Documentation

◆ config_

◆ dx_

◆ dy_

◆ gridHeight_

◆ gridWidth_

◆ halfShiftReference_

◆ maximumSamples_

◆ referenceMarginal_

◆ samples_