SpecularComputation Class Reference

Performs a single-threaded specular computation with given sample. More...

Inheritance diagram for SpecularComputation:

Collaboration diagram for SpecularComputation:

Public Member Functions
	SpecularComputation (const MultiLayer &multilayer, const SimulationOptions &options, ProgressHandler &progress, SpecularElementIter begin_it, SpecularElementIter end_it, bool forcePolarized=false)
	~SpecularComputation () override
std::string	errorMessage () const
bool	isCompleted () const
void	run ()

Protected Attributes
std::unique_ptr< ProcessedSample >	m_processed_sample
ProgressHandler *	m_progress
SimulationOptions	m_sim_options
ComputationStatus	m_status

Private Types
using	SpecularElementIter = std::vector< SpecularSimulationElement >::iterator

Private Member Functions
void	runProtected () override

Private Attributes
const SpecularElementIter	m_begin_it
	these iterators define the span of detector bins this simulation will work on More...
std::unique_ptr< SpecularComputationTerm >	m_computation_term
const SpecularElementIter	m_end_it

Detailed Description

Performs a single-threaded specular computation with given sample.

Controlled by the multi-threading machinery in ISimulation::runSingleSimulation().

Definition at line 35 of file SpecularComputation.h.

Member Typedef Documentation

SpecularElementIter

using SpecularComputation::SpecularElementIter = std::vector<SpecularSimulationElement>::iterator

private

Definition at line 36 of file SpecularComputation.h.

Constructor & Destructor Documentation

SpecularComputation()

SpecularComputation::SpecularComputation	(	const MultiLayer &	multilayer,
		const SimulationOptions &	options,
		ProgressHandler &	progress,
		SpecularElementIter	begin_it,
		SpecularElementIter	end_it,
		bool	forcePolarized = false
	)

Definition at line 27 of file SpecularComputation.cpp.

    : IComputation(multilayer, options, progress), m_begin_it(begin_it), m_end_it(end_it)
{
    if (m_processed_sample->containsMagneticMaterial()
        || m_processed_sample->externalField() != kvector_t{}
        || forcePolarized)
 
        m_computation_term.reset(
            new SpecularMatrixTerm(SpecularStrategyBuilder::build(multilayer, true)));
    else
        m_computation_term.reset(
            new SpecularScalarTerm(SpecularStrategyBuilder::build(multilayer, false)));
}

References SpecularStrategyBuilder::build(), m_computation_term, and IComputation::m_processed_sample.

Here is the call graph for this function:

~SpecularComputation()

SpecularComputation::~SpecularComputation ( )

overridedefault

Member Function Documentation

errorMessage()

std::string IComputation::errorMessage ( ) const

inlineinherited

Definition at line 48 of file IComputation.h.

{ return m_status.errorMessage(); }

References ComputationStatus::errorMessage(), and IComputation::m_status.

Here is the call graph for this function:

isCompleted()

bool IComputation::isCompleted ( ) const

inlineinherited

Definition at line 47 of file IComputation.h.

{ return m_status.isCompleted(); }

References ComputationStatus::isCompleted(), and IComputation::m_status.

Here is the call graph for this function:

run()

void IComputation::run ( )

inherited

Definition at line 31 of file IComputation.cpp.

{
    m_status.setRunning();
    try {
        runProtected();
        m_status.setCompleted();
    } catch (const std::exception& ex) {
        m_status.setFailed(ex.what());
    }
}

References IComputation::m_status, IComputation::runProtected(), ComputationStatus::setCompleted(), ComputationStatus::setFailed(), and ComputationStatus::setRunning().

Here is the call graph for this function:

runProtected()

void SpecularComputation::runProtected ( )

overrideprivatevirtual

Implements IComputation.

Definition at line 46 of file SpecularComputation.cpp.

{
    if (!m_progress->alive())
        return;
 
    m_computation_term->setProgressHandler(m_progress);
    auto& slices = m_processed_sample->averageSlices();
    for (auto it = m_begin_it; it != m_end_it; ++it)
        m_computation_term->computeIntensity(*it, slices);
}

References ProgressHandler::alive(), m_begin_it, m_computation_term, m_end_it, IComputation::m_processed_sample, and IComputation::m_progress.

Here is the call graph for this function:

Member Data Documentation

m_begin_it

const SpecularElementIter SpecularComputation::m_begin_it

private

these iterators define the span of detector bins this simulation will work on

Definition at line 48 of file SpecularComputation.h.

Referenced by runProtected().

m_computation_term

std::unique_ptr<SpecularComputationTerm> SpecularComputation::m_computation_term

mutableprivate

Definition at line 49 of file SpecularComputation.h.

Referenced by SpecularComputation(), and runProtected().

m_end_it

const SpecularElementIter SpecularComputation::m_end_it

private

Definition at line 48 of file SpecularComputation.h.

Referenced by runProtected().

m_processed_sample

std::unique_ptr<ProcessedSample> IComputation::m_processed_sample

protectedinherited

Definition at line 54 of file IComputation.h.

Referenced by DWBAComputation::DWBAComputation(), SpecularComputation(), and runProtected().

m_progress

ProgressHandler* IComputation::m_progress

protectedinherited

Definition at line 52 of file IComputation.h.

Referenced by DepthProbeComputation::runProtected(), DWBAComputation::runProtected(), and runProtected().

m_sim_options

SimulationOptions IComputation::m_sim_options

protectedinherited

Definition at line 51 of file IComputation.h.

Referenced by DWBAComputation::DWBAComputation().

m_status

ComputationStatus IComputation::m_status

protectedinherited

Definition at line 53 of file IComputation.h.

Referenced by IComputation::errorMessage(), IComputation::isCompleted(), and IComputation::run().

---

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

• /home/www/ba/Core/Computation/SpecularComputation.h
• /home/www/ba/Core/Computation/SpecularComputation.cpp