Inheritance diagram for SpecularScalarTerm:

Collaboration diagram for SpecularScalarTerm:

Public Member Functions
	SpecularScalarTerm (std::unique_ptr< ISpecularStrategy > strategy)

void	setProgressHandler (ProgressHandler *p_progress)

void	computeIntensity (SpecularSimulationElement &elem, const std::vector< Slice > &slices) const

Protected Attributes
std::unique_ptr< ISpecularStrategy >	m_Strategy

Private Member Functions
	~SpecularScalarTerm () override

void	eval (SpecularSimulationElement &elem, const std::vector< Slice > &slices) const override

Private Attributes
std::unique_ptr< DelayedProgressCounter >	mP_progress_counter

Detailed Description

Computes the specular scattering for a scalar sample Used by SpecularComputation.

Definition at line 60 of file SpecularComputationTerm.h.

Constructor & Destructor Documentation

◆ SpecularScalarTerm()

SpecularScalarTerm::SpecularScalarTerm ( std::unique_ptr< ISpecularStrategy > strategy )

Definition at line 27 of file SpecularComputationTerm.cpp.

     : SpecularComputationTerm(std::move(strategy))
 {
 }

◆ ~SpecularScalarTerm()

SpecularScalarTerm::~SpecularScalarTerm ( )

overrideprivatedefault

Member Function Documentation

◆ eval()

void SpecularScalarTerm::eval	(	SpecularSimulationElement &	elem,
		const std::vector< Slice > &	slices
	)		const

overrideprivatevirtual

Implements SpecularComputationTerm.

Definition at line 57 of file SpecularComputationTerm.cpp.

 {
     const auto coeff = m_Strategy->Execute(slices, elem.produceKz(slices));
     elem.setIntensity(std::norm(coeff.front()->getScalarR()));
 }

References SpecularComputationTerm::m_Strategy, SpecularSimulationElement::produceKz(), and SpecularSimulationElement::setIntensity().

Here is the call graph for this function:

◆ setProgressHandler()

void SpecularComputationTerm::setProgressHandler ( ProgressHandler * p_progress )

inherited

Definition at line 34 of file SpecularComputationTerm.cpp.

 {
     mP_progress_counter = std::make_unique<DelayedProgressCounter>(p_progress, 100);
 }

References SpecularComputationTerm::mP_progress_counter.

◆ computeIntensity()

void SpecularComputationTerm::computeIntensity	(	SpecularSimulationElement &	elem,
		const std::vector< Slice > &	slices
	)		const

inherited

Definition at line 39 of file SpecularComputationTerm.cpp.

 {
     if (!elem.isCalculated())
         return;
  
     eval(elem, slices);
  
     if (mP_progress_counter)
         mP_progress_counter->stepProgress();
 }

References SpecularComputationTerm::eval(), SpecularSimulationElement::isCalculated(), and SpecularComputationTerm::mP_progress_counter.

Here is the call graph for this function:

Member Data Documentation

◆ m_Strategy

std::unique_ptr<ISpecularStrategy> SpecularComputationTerm::m_Strategy

protectedinherited

Definition at line 50 of file SpecularComputationTerm.h.

Referenced by eval(), and SpecularMatrixTerm::eval().

◆ mP_progress_counter

std::unique_ptr<DelayedProgressCounter> SpecularComputationTerm::mP_progress_counter

privateinherited

Definition at line 53 of file SpecularComputationTerm.h.

Referenced by SpecularComputationTerm::computeIntensity(), and SpecularComputationTerm::setProgressHandler().

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

/home/www/ba/Core/Computation/SpecularComputationTerm.h
/home/www/ba/Core/Computation/SpecularComputationTerm.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes