DWBAComputation Class Reference

Performs a single-threaded DWBA computation with given sample and simulation parameters. More...

Inheritance diagram for DWBAComputation:

Collaboration diagram for DWBAComputation:

Public Member Functions
	DWBAComputation (const MultiLayer &multilayer, const SimulationOptions &options, ProgressHandler &progress, std::vector< SimulationElement >::iterator begin_it, std::vector< SimulationElement >::iterator end_it, bool forcePolarized=false)
	~DWBAComputation () 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 Member Functions
void	runProtected () override

Private Attributes
std::vector< SimulationElement >::iterator	m_begin_it
	These iterators define the span of detector bins this simulation will work on. More...
std::vector< SimulationElement >::iterator	m_end_it
DWBASingleComputation	m_single_computation
	Contains the information, necessary to calculate the Fresnel coefficients. More...

Detailed Description

Performs a single-threaded DWBA computation with given sample and simulation parameters.

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

Definition at line 35 of file DWBAComputation.h.

Constructor & Destructor Documentation

DWBAComputation()

DWBAComputation::DWBAComputation	(	const MultiLayer &	multilayer,
		const SimulationOptions &	options,
		ProgressHandler &	progress,
		std::vector< SimulationElement >::iterator	begin_it,
		std::vector< SimulationElement >::iterator	end_it,
		bool	forcePolarized = false
	)

Definition at line 31 of file DWBAComputation.cpp.

    : IComputation(multilayer, options, progress, forcePolarized)
    , m_begin_it(begin_it)
    , m_end_it(end_it)
{
    const IFresnelMap* p_fresnel_map = m_processed_sample->fresnelMap();
    bool polarized = m_processed_sample->containsMagneticMaterial() || forcePolarized;
 
    for (const ProcessedLayout& layout : m_processed_sample->layouts()) {
        m_single_computation.addLayoutComputation(
            new ParticleLayoutComputation(layout, m_sim_options, polarized));
    }
    // scattering from rough surfaces in DWBA
    if (m_processed_sample->hasRoughness())
        m_single_computation.setRoughnessComputation(
            new RoughMultiLayerComputation(m_processed_sample.get()));
    if (m_sim_options.includeSpecular())
        m_single_computation.setSpecularBinComputation(new GISASSpecularComputation(p_fresnel_map));
}

References DWBASingleComputation::addLayoutComputation(), SimulationOptions::includeSpecular(), IComputation::m_processed_sample, IComputation::m_sim_options, m_single_computation, FormFactorPrecompute::polarized(), DWBASingleComputation::setRoughnessComputation(), and DWBASingleComputation::setSpecularBinComputation().

Here is the call graph for this function:

~DWBAComputation()

DWBAComputation::~DWBAComputation ( )

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 DWBAComputation::runProtected ( )

overrideprivatevirtual

Implements IComputation.

Definition at line 62 of file DWBAComputation.cpp.

{
    if (!m_progress->alive())
        return;
    m_single_computation.setProgressHandler(m_progress);
    for (auto it = m_begin_it; it != m_end_it; ++it) {
        if (!m_progress->alive())
            break;
        m_single_computation.compute(*it);
    }
}

References ProgressHandler::alive(), DWBASingleComputation::compute(), m_begin_it, m_end_it, IComputation::m_progress, m_single_computation, and DWBASingleComputation::setProgressHandler().

Here is the call graph for this function:

Member Data Documentation

m_begin_it

std::vector<SimulationElement>::iterator DWBAComputation::m_begin_it

private

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

Definition at line 46 of file DWBAComputation.h.

Referenced by runProtected().

m_end_it

std::vector<SimulationElement>::iterator DWBAComputation::m_end_it

private

Definition at line 46 of file DWBAComputation.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(), SpecularComputation::SpecularComputation(), and SpecularComputation::runProtected().

m_progress

ProgressHandler* IComputation::m_progress

protectedinherited

Definition at line 52 of file IComputation.h.

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

m_sim_options

SimulationOptions IComputation::m_sim_options

protectedinherited

Definition at line 51 of file IComputation.h.

Referenced by DWBAComputation().

m_single_computation

DWBASingleComputation DWBAComputation::m_single_computation

private

Contains the information, necessary to calculate the Fresnel coefficients.

Definition at line 48 of file DWBAComputation.h.

Referenced by DWBAComputation(), and runProtected().

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/DWBAComputation.h
• /home/www/ba/Core/Computation/DWBAComputation.cpp