DepthProbeSimulation Class Reference

Inheritance diagram for DepthProbeSimulation:

Collaboration diagram for DepthProbeSimulation:

Public Member Functions
	DepthProbeSimulation ()
	~DepthProbeSimulation () override
DepthProbeSimulation *	clone () const override
void	accept (INodeVisitor *visitor) const override final
SimulationResult	result () const override
void	setBeamParameters (double lambda, int nbins, double alpha_i_min, double alpha_i_max, const IFootprintFactor *beam_shape=nullptr)
void	setZSpan (size_t n_bins, double z_min, double z_max)
const IAxis *	getAlphaAxis () const
const IAxis *	getZAxis () const
size_t	intensityMapSize () const override
std::unique_ptr< IUnitConverter >	createUnitConverter () const
virtual void	prepareSimulation ()
void	runSimulation ()
void	runMPISimulation ()
void	setInstrument (const Instrument &instrument_)
const Instrument &	instrument () const
Instrument &	instrument ()
void	setBeamIntensity (double intensity)
double	getBeamIntensity () const
void	setBeamPolarization (const kvector_t bloch_vector)
void	setDetectorResolutionFunction (const IResolutionFunction2D &resolution_function)
void	removeDetectorResolutionFunction ()
void	setAnalyzerProperties (const kvector_t direction, double efficiency, double total_transmission)
void	setSample (const MultiLayer &sample)
const MultiLayer *	sample () const
void	setSampleBuilder (const std::shared_ptr< ISampleBuilder > &sample_builder)
void	setBackground (const IBackground &bg)
const IBackground *	background () const
void	addParameterDistribution (const std::string &param_name, const IDistribution1D &distribution, size_t nbr_samples, double sigma_factor=0.0, const RealLimits &limits=RealLimits())
void	addParameterDistribution (const ParameterDistribution &par_distr)
const DistributionHandler &	getDistributionHandler () const
void	setOptions (const SimulationOptions &options)
const SimulationOptions &	getOptions () const
SimulationOptions &	getOptions ()
void	subscribe (ProgressHandler::Callback_t inform)
void	setTerminalProgressMonitor ()
std::vector< const INode * >	getChildren () const
SimulationResult	convertData (const OutputData< double > &data, bool put_masked_areas_to_zero=true)
virtual void	transferToCPP ()
virtual std::string	treeToString () const
void	registerChild (INode *node)
virtual void	setParent (const INode *newParent)
const INode *	parent () const
INode *	parent ()
int	copyNumber (const INode *node) const
std::string	displayName () const
ParameterPool *	createParameterTree () const
ParameterPool *	parameterPool () const
std::string	parametersToString () const
RealParameter &	registerParameter (const std::string &name, double *parpointer)
void	registerVector (const std::string &base_name, kvector_t *p_vec, const std::string &units="nm")
void	setParameterValue (const std::string &name, double value)
void	setVectorValue (const std::string &base_name, kvector_t value)
RealParameter *	parameter (const std::string &name) const
virtual void	onChange ()
void	removeParameter (const std::string &name)
void	removeVector (const std::string &base_name)
void	setName (const std::string &name)
const std::string &	getName () const

Static Public Member Functions
static std::string	XComponentName (const std::string &base_name)
static std::string	YComponentName (const std::string &base_name)
static std::string	ZComponentName (const std::string &base_name)

Protected Member Functions
virtual void	transferResultsToIntensityMap ()
virtual void	updateIntensityMap ()
const SimulationOptions &	options () const
ProgressHandler &	progress ()

Protected Attributes
const size_t	m_NP
std::vector< double >	m_P

Private Member Functions
	DepthProbeSimulation (const DepthProbeSimulation &other)
void	setBeamParameters (double lambda, const IAxis &alpha_axis, const IFootprintFactor *beam_shape)
void	initSimulationElementVector () override
size_t	numberOfSimulationElements () const override
std::vector< DepthProbeElement >	generateSimulationElements (const Beam &beam)
std::unique_ptr< IComputation >	generateSingleThreadedComputation (size_t start, size_t n_elements) override
void	validityCheck () const
void	checkCache () const
void	validateParametrization (const ParameterDistribution &par_distr) const override
void	initialize ()
void	normalize (size_t start_ind, size_t n_elements) override
void	addBackgroundIntensity (size_t start_ind, size_t n_elements) override
void	addDataToCache (double weight) override
void	moveDataFromCache () override
double	incidentAngle (size_t index) const
std::unique_ptr< OutputData< double > >	createIntensityData () const
std::vector< double >	rawResults () const override
void	setRawResults (const std::vector< double > &raw_data) override
void	runSingleSimulation (size_t batch_start, size_t batch_size, double weight=1.0)

Private Attributes
std::unique_ptr< IAxis >	m_alpha_axis
std::unique_ptr< IAxis >	m_z_axis
std::vector< DepthProbeElement >	m_sim_elements
std::vector< std::valarray< double > >	m_cache
SimulationOptions	m_options
ProgressHandler	m_progress
SampleProvider	m_sample_provider
DistributionHandler	m_distribution_handler
Instrument	m_instrument
std::unique_ptr< IBackground >	m_background
const INode *	m_parent {nullptr}
std::string	m_name
std::unique_ptr< ParameterPool >	m_pool

Detailed Description

Definition at line 33 of file DepthProbeSimulation.h.

Constructor & Destructor Documentation

DepthProbeSimulation() [1/2]

DepthProbeSimulation::DepthProbeSimulation

(

)

Definition at line 37 of file DepthProbeSimulation.cpp.

                                           : Simulation()
{
    initialize();
}

References initialize().

Referenced by clone().

Here is the call graph for this function:

~DepthProbeSimulation()

DepthProbeSimulation::~DepthProbeSimulation ( )

overridedefault

DepthProbeSimulation() [2/2]

DepthProbeSimulation::DepthProbeSimulation ( const DepthProbeSimulation &  other )

private

Definition at line 105 of file DepthProbeSimulation.cpp.

    : Simulation(other), m_sim_elements(other.m_sim_elements), m_cache(other.m_cache)
{
    if (other.m_alpha_axis)
        m_alpha_axis.reset(other.m_alpha_axis->clone());
    if (other.m_z_axis)
        m_z_axis.reset(other.m_z_axis->clone());
    for (auto iter = m_sim_elements.begin(); iter != m_sim_elements.end(); ++iter)
        iter->setZPositions(m_alpha_axis.get());
    initialize();
}

References initialize(), m_alpha_axis, m_sim_elements, and m_z_axis.

Here is the call graph for this function:

Member Function Documentation

clone()

DepthProbeSimulation * DepthProbeSimulation::clone ( ) const

overridevirtual

Implements Simulation.

Definition at line 44 of file DepthProbeSimulation.cpp.

{
    return new DepthProbeSimulation(*this);
}

References DepthProbeSimulation().

Here is the call graph for this function:

accept()

void DepthProbeSimulation::accept ( INodeVisitor *  visitor ) const

inlinefinaloverridevirtual

Calls the INodeVisitor's visit method.

Implements INode.

Definition at line 41 of file DepthProbeSimulation.h.

{ visitor->visit(this); }

result()

SimulationResult DepthProbeSimulation::result ( ) const

overridevirtual

Returns the results of the simulation in a format that supports unit conversion and export to numpy arrays.

Implements Simulation.

Definition at line 54 of file DepthProbeSimulation.cpp.

{
    validityCheck();
    auto data = createIntensityData();
    return SimulationResult(*data, *createUnitConverter());
}

References createIntensityData(), createUnitConverter(), and validityCheck().

Referenced by createIntensityData(), generateSimulationElements(), and rawResults().

Here is the call graph for this function:

setBeamParameters() [1/2]

void DepthProbeSimulation::setBeamParameters	(	double	lambda,
		int	nbins,
		double	alpha_i_min,
		double	alpha_i_max,
		const IFootprintFactor *	beam_shape = nullptr
	)

Sets beam parameters with alpha_i of the beam defined in the range.

Definition at line 61 of file DepthProbeSimulation.cpp.

{
    FixedBinAxis axis("alpha_i", static_cast<size_t>(nbins), alpha_i_min, alpha_i_max);
    setBeamParameters(lambda, axis, beam_shape);
}

setZSpan()

void DepthProbeSimulation::setZSpan	(	size_t	n_bins,
		double	z_min,
		double	z_max
	)

Set z positions for intensity calculations.

Negative z's correspond to the area under sample surface. The more negative z is, the deeper layer corresponds to it.

Definition at line 68 of file DepthProbeSimulation.cpp.

{
    if (z_max <= z_min)
        throw std::runtime_error("Error in DepthProbeSimulation::setZSpan: maximum on-axis value "
                                 "is less or equal to the minimum one");
    m_z_axis = std::make_unique<FixedBinAxis>("z", n_bins, z_min, z_max);
}

References m_z_axis.

getAlphaAxis()

const IAxis * DepthProbeSimulation::getAlphaAxis

(

)

const

Returns a pointer to incident angle axis.

Definition at line 76 of file DepthProbeSimulation.cpp.

{
    if (!m_alpha_axis)
        throw std::runtime_error("Error in DepthProbeSimulation::getAlphaAxis: incident angle axis "
                                 "was not initialized.");
    return m_alpha_axis.get();
}

References m_alpha_axis.

Referenced by createIntensityData(), generateSimulationElements(), numberOfSimulationElements(), rawResults(), setRawResults(), and validityCheck().

getZAxis()

const IAxis * DepthProbeSimulation::getZAxis

(

)

const

Returns a pointer to z-position axis.

Definition at line 84 of file DepthProbeSimulation.cpp.

{
    if (!m_z_axis)
        throw std::runtime_error("Error in DepthProbeSimulation::getZAxis: position axis "
                                 "was not initialized.");
    return m_z_axis.get();
}

References m_z_axis.

Referenced by createIntensityData(), generateSimulationElements(), initSimulationElementVector(), rawResults(), and setRawResults().

intensityMapSize()

size_t DepthProbeSimulation::intensityMapSize ( ) const

overridevirtual

Returns the total number of the intensity values in the simulation result.

Implements Simulation.

Definition at line 92 of file DepthProbeSimulation.cpp.

{
    if (!m_z_axis || !m_alpha_axis)
        throw std::runtime_error("Error in DepthProbeSimulation::intensityMapSize: attempt to "
                                 "access non-initialized data.");
    return m_z_axis->size() * m_alpha_axis->size();
}

References m_alpha_axis, and m_z_axis.

createUnitConverter()

std::unique_ptr< IUnitConverter > DepthProbeSimulation::createUnitConverter

(

)

const

Definition at line 100 of file DepthProbeSimulation.cpp.

{
    return std::make_unique<DepthProbeConverter>(instrument().getBeam(), *m_alpha_axis, *m_z_axis);
}

References Simulation::instrument(), m_alpha_axis, and m_z_axis.

Referenced by result().

Here is the call graph for this function:

setBeamParameters() [2/2]

void DepthProbeSimulation::setBeamParameters ( double  lambda, const IAxis &  alpha_axis, const IFootprintFactor *  beam_shape  )

private

Sets beam parameters with alpha_i of the beam defined in the range.

Definition at line 117 of file DepthProbeSimulation.cpp.

{
    if (lambda <= 0.0)
        throw std::runtime_error(
            "Error in DepthProbeSimulation::setBeamParameters: wavelength must be positive.");
    if (alpha_axis.getMin() < 0.0)
        throw std::runtime_error(
            "Error in DepthProbeSimulation::setBeamParameters: minimum value on "
            "angle axis is negative.");
    if (alpha_axis.getMin() >= alpha_axis.getMax())
        throw std::runtime_error(
            "Error in DepthProbeSimulation::setBeamParameters: maximal value on "
            "angle axis is less or equal to the minimal one.");
    if (alpha_axis.size() == 0)
        throw std::runtime_error(
            "Error in DepthProbeSimulation::setBeamParameters: angle axis is empty");
 
    SpecularDetector1D detector(alpha_axis);
    instrument().setDetector(detector);
    m_alpha_axis.reset(alpha_axis.clone());
 
    // beam is initialized with zero-valued angles
    // Zero-valued incident alpha is required for proper
    // taking into account beam resolution effects
    instrument().setBeamParameters(lambda, zero_alpha_i, zero_phi_i);
 
    if (beam_shape)
        instrument().getBeam().setFootprintFactor(*beam_shape);
}

References IAxis::clone(), Instrument::getBeam(), IAxis::getMax(), IAxis::getMin(), Simulation::instrument(), m_alpha_axis, Instrument::setBeamParameters(), Instrument::setDetector(), Beam::setFootprintFactor(), IAxis::size(), anonymous_namespace{DepthProbeSimulation.cpp}::zero_alpha_i, and anonymous_namespace{DepthProbeSimulation.cpp}::zero_phi_i.

Here is the call graph for this function:

initSimulationElementVector()

void DepthProbeSimulation::initSimulationElementVector ( )

overrideprivatevirtual

Initializes the vector of Simulation elements.

Implements Simulation.

Definition at line 148 of file DepthProbeSimulation.cpp.

{
    const auto& beam = instrument().getBeam();
    m_sim_elements = generateSimulationElements(beam);
 
    if (!m_cache.empty())
        return;
    m_cache.resize(m_sim_elements.size(), std::valarray<double>(0.0, getZAxis()->size()));
}

References generateSimulationElements(), Instrument::getBeam(), getZAxis(), Simulation::instrument(), m_cache, and m_sim_elements.

Here is the call graph for this function:

numberOfSimulationElements()

size_t DepthProbeSimulation::numberOfSimulationElements ( ) const

overrideprivatevirtual

Gets the number of elements this simulation needs to calculate.

Implements Simulation.

Definition at line 49 of file DepthProbeSimulation.cpp.

{
    return getAlphaAxis()->size();
}

References getAlphaAxis(), and IAxis::size().

Here is the call graph for this function:

generateSimulationElements()

std::vector< DepthProbeElement > DepthProbeSimulation::generateSimulationElements ( const Beam &  beam )

private

Generate simulation elements for given beam.

Definition at line 158 of file DepthProbeSimulation.cpp.

{
    std::vector<DepthProbeElement> result;
 
    const double wavelength = beam.getWavelength();
    const double angle_shift = beam.getAlpha();
 
    const size_t axis_size = getAlphaAxis()->size();
    result.reserve(axis_size);
    for (size_t i = 0; i < axis_size; ++i) {
        double result_angle = incidentAngle(i) + angle_shift;
        result.emplace_back(wavelength, -result_angle, getZAxis());
        if (!alpha_limits.isInRange(result_angle))
            result.back().setCalculationFlag(false); // false = exclude from calculations
    }
    return result;
}

References anonymous_namespace{DepthProbeSimulation.cpp}::alpha_limits, Beam::getAlpha(), getAlphaAxis(), Beam::getWavelength(), getZAxis(), incidentAngle(), RealLimits::isInRange(), result(), IAxis::size(), and anonymous_namespace{SlicedCylindersBuilder.cpp}::wavelength().

Referenced by initSimulationElementVector().

Here is the call graph for this function:

generateSingleThreadedComputation()

std::unique_ptr< IComputation > DepthProbeSimulation::generateSingleThreadedComputation ( size_t  start, size_t  n_elements  )

overrideprivatevirtual

Generate a single threaded computation for a given range of simulation elements.

Parameters

start	Index of the first element to include into computation
n_elements	Number of elements to process

Implements Simulation.

Definition at line 177 of file DepthProbeSimulation.cpp.

{
    ASSERT(start < m_sim_elements.size() && start + n_elements <= m_sim_elements.size());
    const auto& begin = m_sim_elements.begin() + static_cast<long>(start);
    return std::make_unique<DepthProbeComputation>(*sample(), options(), progress(), begin,
                                                   begin + static_cast<long>(n_elements));
}

References ASSERT, m_sim_elements, Simulation::options(), Simulation::progress(), and Simulation::sample().

Here is the call graph for this function:

validityCheck()

void DepthProbeSimulation::validityCheck ( ) const

private

Checks if simulation data is ready for retrieval.

Definition at line 185 of file DepthProbeSimulation.cpp.

{
    const MultiLayer* current_sample = sample();
    if (!current_sample)
        throw std::runtime_error(
            "Error in DepthProbeSimulation::validityCheck: no sample found in the simulation.");
 
    const size_t data_size = m_sim_elements.size();
    if (data_size != getAlphaAxis()->size())
        throw std::runtime_error(
            "Error in DepthProbeSimulation::validityCheck: length of simulation "
            "element vector is not equal to the number of inclination angles");
}

References getAlphaAxis(), m_sim_elements, and Simulation::sample().

Referenced by rawResults(), result(), and setRawResults().

Here is the call graph for this function:

checkCache()

void DepthProbeSimulation::checkCache ( ) const

private

Definition at line 199 of file DepthProbeSimulation.cpp.

{
    if (m_sim_elements.size() != m_cache.size())
        throw std::runtime_error("Error in DepthProbeSimulation: the sizes of simulation element "
                                 "vector and of its cache are different");
}

References m_cache, and m_sim_elements.

Referenced by addDataToCache(), and moveDataFromCache().

validateParametrization()

void DepthProbeSimulation::validateParametrization ( const ParameterDistribution &  par_distr ) const

overrideprivatevirtual

Checks the distribution validity for simulation.

Reimplemented from Simulation.

Definition at line 206 of file DepthProbeSimulation.cpp.

{
    const bool zero_mean = par_distr.getDistribution()->getMean() == 0.0;
    if (zero_mean)
        return;
 
    std::unique_ptr<ParameterPool> parameter_pool(createParameterTree());
    const std::vector<RealParameter*> names =
        parameter_pool->getMatchedParameters(par_distr.getMainParameterName());
    for (const auto par : names)
        if (par->getName().find("InclinationAngle") != std::string::npos && !zero_mean)
            throw std::runtime_error("Error in DepthProbeSimulation: parameter distribution of "
                                     "beam inclination angle should have zero mean.");
}

References INode::createParameterTree(), ParameterDistribution::getDistribution(), ParameterDistribution::getMainParameterName(), and IDistribution1D::getMean().

Here is the call graph for this function:

initialize()

void DepthProbeSimulation::initialize ( )

private

Initializes simulation.

Definition at line 221 of file DepthProbeSimulation.cpp.

{
    setName("DepthProbeSimulation");
 
    // allow for negative inclinations in the beam of specular simulation
    // it is required for proper averaging in the case of divergent beam
    auto inclination = instrument().getBeam().parameter("InclinationAngle");
    inclination->setLimits(RealLimits::limited(-M_PI_2, M_PI_2));
}

References Instrument::getBeam(), Simulation::instrument(), RealLimits::limited(), M_PI_2, IParameterized::parameter(), RealParameter::setLimits(), and IParameterized::setName().

Referenced by DepthProbeSimulation().

Here is the call graph for this function:

normalize()

void DepthProbeSimulation::normalize ( size_t  start_ind, size_t  n_elements  )

overrideprivatevirtual

Normalize the detector counts to beam intensity, to solid angle, and to exposure angle.

Parameters

start_ind	Index of the first element to operate on
n_elements	Number of elements to process

Implements Simulation.

Definition at line 231 of file DepthProbeSimulation.cpp.

{
    const double beam_intensity = getBeamIntensity();
    if (beam_intensity == 0.0)
        return; // no normalization when beam intensity is zero
    for (size_t i = start_ind, stop_point = start_ind + n_elements; i < stop_point; ++i) {
        auto& element = m_sim_elements[i];
        const double alpha_i = -element.getAlphaI();
        const auto footprint = instrument().getBeam().footprintFactor();
        double intensity_factor = beam_intensity;
        if (footprint != nullptr)
            intensity_factor = intensity_factor * footprint->calculate(alpha_i);
        element.setIntensities(element.getIntensities() * intensity_factor);
    }
}

References IFootprintFactor::calculate(), Beam::footprintFactor(), Instrument::getBeam(), Simulation::getBeamIntensity(), Simulation::instrument(), and m_sim_elements.

Here is the call graph for this function:

addBackgroundIntensity()

void DepthProbeSimulation::addBackgroundIntensity ( size_t  start_ind, size_t  n_elements  )

overrideprivatevirtual

Implements Simulation.

Definition at line 247 of file DepthProbeSimulation.cpp.

{
    if (background())
        throw std::runtime_error(
            "Error: nonzero background is not supported by DepthProbeSimulation");
}

References Simulation::background().

Here is the call graph for this function:

addDataToCache()

void DepthProbeSimulation::addDataToCache ( double  weight )

overrideprivatevirtual

Implements Simulation.

Definition at line 254 of file DepthProbeSimulation.cpp.

{
    checkCache();
    for (size_t i = 0, size = m_sim_elements.size(); i < size; ++i)
        m_cache[i] += m_sim_elements[i].getIntensities() * weight;
}

References checkCache(), m_cache, and m_sim_elements.

Here is the call graph for this function:

moveDataFromCache()

void DepthProbeSimulation::moveDataFromCache ( )

overrideprivatevirtual

Implements Simulation.

Definition at line 261 of file DepthProbeSimulation.cpp.

{
    checkCache();
    for (size_t i = 0, size = m_sim_elements.size(); i < size; ++i)
        m_sim_elements[i].setIntensities(std::move(m_cache[i]));
    m_cache.clear();
    m_cache.shrink_to_fit();
}

References checkCache(), m_cache, and m_sim_elements.

Here is the call graph for this function:

incidentAngle()

double DepthProbeSimulation::incidentAngle ( size_t  index ) const

private

Definition at line 270 of file DepthProbeSimulation.cpp.

{
    return m_alpha_axis->getBin(index).getMidPoint();
}

References m_alpha_axis.

Referenced by generateSimulationElements().

createIntensityData()

std::unique_ptr< OutputData< double > > DepthProbeSimulation::createIntensityData ( ) const

private

Creates intensity data from simulation elements.

Definition at line 275 of file DepthProbeSimulation.cpp.

{
    std::unique_ptr<OutputData<double>> result = std::make_unique<OutputData<double>>();
    result->addAxis(*getAlphaAxis());
    result->addAxis(*getZAxis());
 
    std::vector<double> rawData;
    rawData.reserve(getAlphaAxis()->size() * getZAxis()->size());
    for (size_t i = 0, size = m_sim_elements.size(); i < size; ++i) {
        const std::valarray<double>& fixed_angle_result = m_sim_elements[i].getIntensities();
        rawData.insert(rawData.end(), std::begin(fixed_angle_result), std::end(fixed_angle_result));
    }
    result->setRawDataVector(rawData);
 
    return result;
}

References getAlphaAxis(), getZAxis(), m_sim_elements, result(), and IAxis::size().

Referenced by result().

Here is the call graph for this function:

rawResults()

std::vector< double > DepthProbeSimulation::rawResults ( ) const

overrideprivatevirtual

Implements Simulation.

Definition at line 292 of file DepthProbeSimulation.cpp.

{
    validityCheck();
    const size_t z_size = getZAxis()->size();
    const size_t alpha_size = getAlphaAxis()->size();
 
    std::vector<double> result;
    result.reserve(alpha_size * z_size);
    for (size_t i = 0; i < alpha_size; ++i) {
        if (m_sim_elements[i].size() != z_size)
            throw std::runtime_error("Error in DepthProbeSimulation::rawResults: simulation "
                                     "element size is not equal to the size of the position axis");
        const auto& intensities = m_sim_elements[i].getIntensities();
        result.insert(result.end(), std::begin(intensities), std::end(intensities));
    }
 
    return result;
}

References getAlphaAxis(), getZAxis(), m_sim_elements, result(), IAxis::size(), and validityCheck().

Here is the call graph for this function:

setRawResults()

void DepthProbeSimulation::setRawResults ( const std::vector< double > &  raw_data )

overrideprivatevirtual

Implements Simulation.

Definition at line 311 of file DepthProbeSimulation.cpp.

{
    validityCheck();
    const size_t z_size = getZAxis()->size();
    const size_t alpha_size = getAlphaAxis()->size();
 
    if (raw_results.size() != z_size * alpha_size)
        throw std::runtime_error(
            "Error in DepthProbeSimulation::setRawResults: the vector to set is of invalid size");
 
    const double* raw_array = raw_results.data();
    for (size_t i = 0; i < alpha_size; ++i) {
        std::valarray<double> fixed_angle_result(raw_array, z_size);
        m_sim_elements[i].setIntensities(std::move(fixed_angle_result));
        raw_array += z_size;
    }
}

References getAlphaAxis(), getZAxis(), m_sim_elements, IAxis::size(), and validityCheck().

Here is the call graph for this function:

prepareSimulation()

void Simulation::prepareSimulation ( )

virtualinherited

Put into a clean state for running a simulation.

Reimplemented in SpecularSimulation, Simulation2D, GISASSimulation, and OffSpecSimulation.

Definition at line 189 of file Simulation.cpp.

{
    m_sample_provider.updateSample();
    if (!MultiLayerUtils::ContainsCompatibleMaterials(*m_sample_provider.sample()))
        throw std::runtime_error(
            "Error in Simulation::prepareSimulation(): non-default materials of"
            " several different types are used in the sample provided");
    gsl_set_error_handler_off();
}

References MultiLayerUtils::ContainsCompatibleMaterials(), Simulation::m_sample_provider, SampleProvider::sample(), and SampleProvider::updateSample().

Referenced by Simulation2D::prepareSimulation(), SpecularSimulation::prepareSimulation(), and Simulation::runSimulation().

Here is the call graph for this function:

runSimulation()

void Simulation::runSimulation ( )

inherited

Run a simulation, possibly averaged over parameter distributions.

Run simulation with possible averaging over parameter distributions.

Definition at line 200 of file Simulation.cpp.

{
    prepareSimulation();
 
    const size_t total_size = numberOfSimulationElements();
    size_t param_combinations = m_distribution_handler.getTotalNumberOfSamples();
 
    m_progress.reset();
    m_progress.setExpectedNTicks(param_combinations * total_size);
 
    // restrict calculation to current batch
    const size_t n_batches = m_options.getNumberOfBatches();
    const size_t current_batch = m_options.getCurrentBatch();
 
    const size_t batch_start = getStartIndex(n_batches, current_batch, total_size);
    const size_t batch_size = getNumberOfElements(n_batches, current_batch, total_size);
    if (batch_size == 0)
        return;
 
    std::unique_ptr<ParameterPool> param_pool(createParameterTree());
    for (size_t index = 0; index < param_combinations; ++index) {
        double weight = m_distribution_handler.setParameterValues(param_pool.get(), index);
        runSingleSimulation(batch_start, batch_size, weight);
    }
    m_distribution_handler.setParameterToMeans(param_pool.get());
    moveDataFromCache();
    transferResultsToIntensityMap();
}

References INode::createParameterTree(), SimulationOptions::getCurrentBatch(), SimulationOptions::getNumberOfBatches(), anonymous_namespace{Simulation.cpp}::getNumberOfElements(), anonymous_namespace{Simulation.cpp}::getStartIndex(), DistributionHandler::getTotalNumberOfSamples(), Simulation::m_distribution_handler, Simulation::m_options, Simulation::m_progress, Simulation::moveDataFromCache(), Simulation::numberOfSimulationElements(), Simulation::prepareSimulation(), ProgressHandler::reset(), Simulation::runSingleSimulation(), ProgressHandler::setExpectedNTicks(), DistributionHandler::setParameterToMeans(), DistributionHandler::setParameterValues(), and Simulation::transferResultsToIntensityMap().

Here is the call graph for this function:

runMPISimulation()

void Simulation::runMPISimulation ( )

inherited

Run a simulation in a MPI environment.

Definition at line 229 of file Simulation.cpp.

{
    MPISimulation ompi;
    ompi.runSimulation(this);
}

References MPISimulation::runSimulation().

Here is the call graph for this function:

setInstrument()

void Simulation::setInstrument ( const Instrument &  instrument_ )

inherited

Definition at line 235 of file Simulation.cpp.

{
    m_instrument = instrument_;
    updateIntensityMap();
}

References Simulation::m_instrument, and Simulation::updateIntensityMap().

Here is the call graph for this function:

instrument() [1/2]

const Instrument& Simulation::instrument ( ) const

inlineinherited

Definition at line 55 of file Simulation.h.

{ return m_instrument; }

References Simulation::m_instrument.

Referenced by Simulation2D::addMask(), OffSpecSimulation::checkInitialization(), Simulation::convertData(), createUnitConverter(), OffSpecSimulation::createUnitConverter(), SimulationToPython::defineDetector(), SimulationToPython::defineDetectorPolarizationAnalysis(), SimulationToPython::defineDetectorResolutionFunction(), SimulationToPython::defineGISASBeam(), SimulationToPython::defineMasks(), SimulationToPython::defineOffSpecBeam(), SimulationToPython::defineSpecularScan(), Simulation2D::generateSimulationElements(), Simulation::getBeamIntensity(), Simulation::getChildren(), initialize(), SpecularSimulation::initialize(), initSimulationElementVector(), GISASSimulation::initSimulationElementVector(), OffSpecSimulation::initSimulationElementVector(), SpecularSimulation::initSimulationElementVector(), GISASSimulation::intensityMapSize(), OffSpecSimulation::intensityMapSize(), Simulation2D::maskAll(), normalize(), SpecularSimulation::normalize(), GISASSimulation::prepareSimulation(), Simulation2D::prepareSimulation(), SpecularSimulation::prepareSimulation(), Simulation::removeDetectorResolutionFunction(), Simulation2D::removeMasks(), GISASSimulation::result(), OffSpecSimulation::result(), Simulation::setAnalyzerProperties(), Simulation::setBeamIntensity(), setBeamParameters(), OffSpecSimulation::setBeamParameters(), GISASSimulation::setBeamParameters(), Simulation::setBeamPolarization(), Simulation2D::setDetector(), Simulation2D::setDetectorParameters(), Simulation::setDetectorResolutionFunction(), Simulation2D::setRegionOfInterest(), SpecularSimulation::setScan(), OffSpecSimulation::transferDetectorImage(), OffSpecSimulation::transferResultsToIntensityMap(), and OffSpecSimulation::updateIntensityMap().

instrument() [2/2]

Instrument& Simulation::instrument ( )

inlineinherited

Definition at line 56 of file Simulation.h.

{ return m_instrument; }

References Simulation::m_instrument.

setBeamIntensity()

void Simulation::setBeamIntensity ( double  intensity )

inherited

Definition at line 173 of file Simulation.cpp.

{
    instrument().setBeamIntensity(intensity);
}

References Simulation::instrument(), and Instrument::setBeamIntensity().

Referenced by StandardSimulations::GISASWithMasks().

Here is the call graph for this function:

getBeamIntensity()

double Simulation::getBeamIntensity ( ) const

inherited

Definition at line 178 of file Simulation.cpp.

{
    return instrument().getBeamIntensity();
}

References Instrument::getBeamIntensity(), and Simulation::instrument().

Referenced by normalize(), Simulation2D::normalize(), and SpecularSimulation::normalize().

Here is the call graph for this function:

setBeamPolarization()

void Simulation::setBeamPolarization ( const kvector_t  bloch_vector )

inherited

Sets the beam polarization according to the given Bloch vector.

Definition at line 184 of file Simulation.cpp.

{
    instrument().setBeamPolarization(bloch_vector);
}

References Simulation::instrument(), and Instrument::setBeamPolarization().

Referenced by StandardSimulations::BasicGISAS00(), StandardSimulations::BasicPolarizedGISAS(), StandardSimulations::MaxiGISAS00(), StandardSimulations::MiniGISASPolarizationMM(), StandardSimulations::MiniGISASPolarizationMP(), StandardSimulations::MiniGISASPolarizationPM(), and StandardSimulations::MiniGISASPolarizationPP().

Here is the call graph for this function:

setDetectorResolutionFunction()

void Simulation::setDetectorResolutionFunction ( const IResolutionFunction2D &  resolution_function )

inherited

Definition at line 156 of file Simulation.cpp.

{
    instrument().setDetectorResolutionFunction(resolution_function);
}

References Simulation::instrument(), and Instrument::setDetectorResolutionFunction().

Referenced by StandardSimulations::MiniGISASDetectorResolution().

Here is the call graph for this function:

removeDetectorResolutionFunction()

void Simulation::removeDetectorResolutionFunction ( )

inherited

Definition at line 161 of file Simulation.cpp.

{
    instrument().removeDetectorResolution();
}

References Simulation::instrument(), and Instrument::removeDetectorResolution().

Here is the call graph for this function:

setAnalyzerProperties()

void Simulation::setAnalyzerProperties ( const kvector_t  direction, double  efficiency, double  total_transmission  )

inherited

Sets the polarization analyzer characteristics of the detector.

Definition at line 167 of file Simulation.cpp.

{
    instrument().setAnalyzerProperties(direction, efficiency, total_transmission);
}

References Simulation::instrument(), and Instrument::setAnalyzerProperties().

Referenced by StandardSimulations::BasicGISAS00(), StandardSimulations::BasicPolarizedGISAS(), StandardSimulations::MaxiGISAS00(), StandardSimulations::MiniGISASPolarizationMM(), StandardSimulations::MiniGISASPolarizationMP(), StandardSimulations::MiniGISASPolarizationPM(), and StandardSimulations::MiniGISASPolarizationPP().

Here is the call graph for this function:

setSample()

void Simulation::setSample ( const MultiLayer &  sample )

inherited

The MultiLayer object will not be owned by the Simulation object.

Definition at line 242 of file Simulation.cpp.

{
    m_sample_provider.setSample(sample);
}

References Simulation::m_sample_provider, Simulation::sample(), and SampleProvider::setSample().

Here is the call graph for this function:

sample()

const MultiLayer * Simulation::sample ( ) const

inherited

Definition at line 247 of file Simulation.cpp.

{
    return m_sample_provider.sample();
}

References Simulation::m_sample_provider, and SampleProvider::sample().

Referenced by SimulationToPython::generateSimulationCode(), generateSingleThreadedComputation(), Simulation2D::generateSingleThreadedComputation(), SpecularSimulation::generateSingleThreadedComputation(), Simulation::setSample(), and validityCheck().

Here is the call graph for this function:

setSampleBuilder()

void Simulation::setSampleBuilder ( const std::shared_ptr< ISampleBuilder > &  sample_builder )

inherited

Definition at line 252 of file Simulation.cpp.

{
    m_sample_provider.setBuilder(sample_builder);
}

References Simulation::m_sample_provider, and SampleProvider::setBuilder().

Here is the call graph for this function:

setBackground()

void Simulation::setBackground ( const IBackground &  bg )

inherited

Definition at line 257 of file Simulation.cpp.

{
    m_background.reset(bg.clone());
    registerChild(m_background.get());
}

References IBackground::clone(), Simulation::m_background, and INode::registerChild().

Referenced by StandardSimulations::ConstantBackgroundGISAS(), and Simulation::Simulation().

Here is the call graph for this function:

background()

const IBackground* Simulation::background ( ) const

inlineinherited

Definition at line 75 of file Simulation.h.

{ return m_background.get(); }

References Simulation::m_background.

Referenced by addBackgroundIntensity(), Simulation2D::addBackgroundIntensity(), SpecularSimulation::addBackgroundIntensity(), and SimulationToPython::defineBackground().

addParameterDistribution() [1/2]

void Simulation::addParameterDistribution ( const std::string &  param_name, const IDistribution1D &  distribution, size_t  nbr_samples, double  sigma_factor = 0.0, const RealLimits &  limits = RealLimits()  )

inherited

Definition at line 273 of file Simulation.cpp.

{
    ParameterDistribution par_distr(param_name, distribution, nbr_samples, sigma_factor, limits);
    addParameterDistribution(par_distr);
}

Referenced by StandardSimulations::MiniGISASBeamDivergence().

addParameterDistribution() [2/2]

void Simulation::addParameterDistribution ( const ParameterDistribution &  par_distr )

inherited

Definition at line 281 of file Simulation.cpp.

{
    validateParametrization(par_distr);
    m_distribution_handler.addParameterDistribution(par_distr);
}

References DistributionHandler::addParameterDistribution(), Simulation::m_distribution_handler, and Simulation::validateParametrization().

Here is the call graph for this function:

getDistributionHandler()

const DistributionHandler& Simulation::getDistributionHandler ( ) const

inlineinherited

Definition at line 89 of file Simulation.h.

{ return m_distribution_handler; }

References Simulation::m_distribution_handler.

Referenced by SimulationToPython::defineParameterDistributions().

setOptions()

void Simulation::setOptions ( const SimulationOptions &  options )

inlineinherited

Definition at line 91 of file Simulation.h.

{ m_options = options; }

References Simulation::m_options, and Simulation::options().

Here is the call graph for this function:

getOptions() [1/2]

const SimulationOptions& Simulation::getOptions ( ) const

inlineinherited

Definition at line 92 of file Simulation.h.

{ return m_options; }

References Simulation::m_options.

Referenced by SimulationToPython::defineSimulationOptions(), StandardSimulations::MiniGISASMonteCarlo(), and StandardSimulations::MiniGISASSpecularPeak().

getOptions() [2/2]

SimulationOptions& Simulation::getOptions ( )

inlineinherited

Definition at line 93 of file Simulation.h.

{ return m_options; }

References Simulation::m_options.

subscribe()

void Simulation::subscribe ( ProgressHandler::Callback_t  inform )

inlineinherited

Definition at line 95 of file Simulation.h.

{ m_progress.subscribe(inform); }

References Simulation::m_progress, and ProgressHandler::subscribe().

Here is the call graph for this function:

setTerminalProgressMonitor()

void Simulation::setTerminalProgressMonitor ( )

inherited

Initializes a progress monitor that prints to stdout.

Definition at line 145 of file Simulation.cpp.

{
    m_progress.subscribe([](size_t percentage_done) -> bool {
        if (percentage_done < 100)
            std::cout << std::setprecision(2) << "\r... " << percentage_done << "%" << std::flush;
        else // wipe out
            std::cout << "\r... 100%\n";
        return true;
    });
}

References Simulation::m_progress, and ProgressHandler::subscribe().

Here is the call graph for this function:

getChildren()

std::vector< const INode * > Simulation::getChildren ( ) const

virtualinherited

Returns a vector of children (const).

Reimplemented from INode.

Definition at line 263 of file Simulation.cpp.

{
    std::vector<const INode*> result;
    result.push_back(&instrument());
    result << m_sample_provider.getChildren();
    if (m_background)
        result.push_back(m_background.get());
    return result;
}

References SampleProvider::getChildren(), Simulation::instrument(), Simulation::m_background, Simulation::m_sample_provider, and Simulation::result().

Here is the call graph for this function:

convertData()

SimulationResult Simulation::convertData ( const OutputData< double > &  data, bool  put_masked_areas_to_zero = true  )

inherited

Convert user data to SimulationResult object for later drawing in various axes units.

User data will be cropped to the ROI defined in the simulation, amplitudes in areas corresponding to the masked areas of the detector will be set to zero.

Definition at line 317 of file Simulation.cpp.

{
    auto converter = UnitConverterUtils::createConverter(*this);
    auto roi_data = UnitConverterUtils::createOutputData(*converter, converter->defaultUnits());
 
    const IDetector& detector = instrument().detector();
 
    if (roi_data->hasSameDimensions(data)) {
        // data is already cropped to ROI
        if (put_masked_areas_to_zero) {
            detector.iterate(
                [&](IDetector::const_iterator it) {
                    (*roi_data)[it.roiIndex()] = data[it.roiIndex()];
                },
                /*visit_masked*/ false);
        } else {
            roi_data->setRawDataVector(data.getRawDataVector());
        }
 
    } else if (detHasSameDimensions(detector, data)) {
        // exp data has same shape as the detector, we have to put orig data to smaller roi map
        detector.iterate(
            [&](IDetector::const_iterator it) {
                (*roi_data)[it.roiIndex()] = data[it.detectorIndex()];
            },
            /*visit_masked*/ !put_masked_areas_to_zero);
 
    } else {
        throw std::runtime_error("FitObject::init_dataset() -> Error. Detector and exp data have "
                                 "different shape.");
    }
 
    return SimulationResult(*roi_data, *converter);
}

References UnitConverterUtils::createConverter(), UnitConverterUtils::createOutputData(), Instrument::detector(), SimulationAreaIterator::detectorIndex(), anonymous_namespace{Simulation.cpp}::detHasSameDimensions(), OutputData< T >::getRawDataVector(), Simulation::instrument(), IDetector::iterate(), and SimulationAreaIterator::roiIndex().

Here is the call graph for this function:

transferResultsToIntensityMap()

virtual void Simulation::transferResultsToIntensityMap ( )

inlineprotectedvirtualinherited

Creates the appropriate data structure (e.g.

2D intensity map) from the calculated SimulationElement objects

Reimplemented in OffSpecSimulation.

Definition at line 110 of file Simulation.h.

{}

Referenced by Simulation::runSimulation(), Simulation2D::setRawResults(), and SpecularSimulation::setRawResults().

updateIntensityMap()

virtual void Simulation::updateIntensityMap ( )

inlineprotectedvirtualinherited

Reimplemented in OffSpecSimulation.

Definition at line 115 of file Simulation.h.

{}

Referenced by Simulation2D::setDetectorParameters(), and Simulation::setInstrument().

options()

const SimulationOptions& Simulation::options ( ) const

inlineprotectedinherited

Definition at line 120 of file Simulation.h.

{ return m_options; }

References Simulation::m_options.

Referenced by generateSingleThreadedComputation(), Simulation2D::generateSingleThreadedComputation(), SpecularSimulation::generateSingleThreadedComputation(), and Simulation::setOptions().

progress()

ProgressHandler& Simulation::progress ( )

inlineprotectedinherited

Definition at line 121 of file Simulation.h.

{ return m_progress; }

References Simulation::m_progress.

Referenced by generateSingleThreadedComputation(), Simulation2D::generateSingleThreadedComputation(), and SpecularSimulation::generateSingleThreadedComputation().

runSingleSimulation()

void Simulation::runSingleSimulation ( size_t  batch_start, size_t  batch_size, double  weight = 1.0  )

privateinherited

Runs a single simulation with fixed parameter values.

If desired, the simulation is run in several threads.

Definition at line 289 of file Simulation.cpp.

{
    initSimulationElementVector();
 
    const size_t n_threads = m_options.getNumberOfThreads();
    ASSERT(n_threads > 0);
 
    std::vector<std::unique_ptr<IComputation>> computations;
 
    for (size_t i_thread = 0; i_thread < n_threads;
         ++i_thread) { // Distribute computations by threads
        const size_t thread_start = batch_start + getStartIndex(n_threads, i_thread, batch_size);
        const size_t thread_size = getNumberOfElements(n_threads, i_thread, batch_size);
        if (thread_size == 0)
            break;
        computations.push_back(generateSingleThreadedComputation(thread_start, thread_size));
    }
    runComputations(std::move(computations));
 
    normalize(batch_start, batch_size);
    addBackgroundIntensity(batch_start, batch_size);
    addDataToCache(weight);
}

References Simulation::addBackgroundIntensity(), Simulation::addDataToCache(), ASSERT, Simulation::generateSingleThreadedComputation(), anonymous_namespace{Simulation.cpp}::getNumberOfElements(), SimulationOptions::getNumberOfThreads(), anonymous_namespace{Simulation.cpp}::getStartIndex(), Simulation::initSimulationElementVector(), Simulation::m_options, Simulation::normalize(), and anonymous_namespace{Simulation.cpp}::runComputations().

Referenced by Simulation::runSimulation().

Here is the call graph for this function:

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 34 of file ICloneable.h.

treeToString()

std::string INode::treeToString ( ) const

virtualinherited

Returns multiline string representing tree structure below the node.

Definition at line 53 of file INode.cpp.

{
    return NodeUtils::nodeToString(*this);
}

References NodeUtils::nodeToString().

Here is the call graph for this function:

registerChild()

void INode::registerChild ( INode *  node )

inherited

Definition at line 58 of file INode.cpp.

{
    ASSERT(node);
    node->setParent(this);
}

References ASSERT, and INode::setParent().

Referenced by ParticleLayout::addAndRegisterAbstractParticle(), ParticleCoreShell::addAndRegisterCore(), MultiLayer::addAndRegisterInterface(), MultiLayer::addAndRegisterLayer(), ParticleCoreShell::addAndRegisterShell(), Layer::addLayout(), ParticleComposition::addParticlePointer(), Beam::Beam(), Crystal::Crystal(), IDetector::IDetector(), Simulation::initialize(), MesoCrystal::initialize(), Instrument::Instrument(), Beam::operator=(), Instrument::operator=(), Particle::Particle(), ParticleDistribution::ParticleDistribution(), IParticle::rotate(), ParticleLayout::setAndRegisterInterferenceFunction(), Simulation::setBackground(), InterferenceFunction1DLattice::setDecayFunction(), InterferenceFunction2DLattice::setDecayFunction(), Instrument::setDetector(), IDetector::setDetectorResolution(), Beam::setFootprintFactor(), Particle::setFormFactor(), InterferenceFunctionFinite3DLattice::setLattice(), InterferenceFunction2DLattice::setLattice(), InterferenceFunction2DParaCrystal::setLattice(), InterferenceFunction2DSuperLattice::setLattice(), InterferenceFunctionFinite2DLattice::setLattice(), InterferenceFunctionRadialParaCrystal::setProbabilityDistribution(), InterferenceFunction2DParaCrystal::setProbabilityDistributions(), ConvolutionDetectorResolution::setResolutionFunction(), IParticle::setRotation(), LayerInterface::setRoughness(), and InterferenceFunction2DSuperLattice::setSubstructureIFF().

Here is the call graph for this function:

setParent()

void INode::setParent ( const INode *  newParent )

virtualinherited

Reimplemented in SampleProvider.

Definition at line 69 of file INode.cpp.

{
    m_parent = newParent;
}

References INode::m_parent.

Referenced by INode::registerChild(), SampleProvider::setBuilder(), and SampleProvider::setParent().

parent() [1/2]

const INode * INode::parent ( ) const

inherited

Definition at line 74 of file INode.cpp.

{
    return m_parent;
}

References INode::m_parent.

Referenced by INode::copyNumber(), INode::createParameterTree(), NodeUtils::nodePath(), Lattice2D::onChange(), SampleProvider::setBuilder(), SampleProvider::setParent(), and SampleProvider::setSample().

parent() [2/2]

INode * INode::parent ( )

inherited

Definition at line 79 of file INode.cpp.

{
    return const_cast<INode*>(m_parent);
}

References INode::m_parent.

copyNumber()

int INode::copyNumber ( const INode *  node ) const

inherited

Returns copyNumber of child, which takes into account existence of children with same name.

Definition at line 84 of file INode.cpp.

{
    if (node->parent() != this)
        return -1;
 
    int result(-1), count(0);
    for (auto child : getChildren()) {
 
        if (child == nullptr)
            throw std::runtime_error("INode::copyNumber() -> Error. Nullptr as child.");
 
        if (child == node)
            result = count;
 
        if (child->getName() == node->getName())
            ++count;
    }
 
    return count > 1 ? result : -1;
}

References INode::getChildren(), IParameterized::getName(), and INode::parent().

Referenced by INode::displayName().

Here is the call graph for this function:

displayName()

std::string INode::displayName ( ) const

inherited

Returns display name, composed from the name of node and it's copy number.

Definition at line 105 of file INode.cpp.

{
    std::string result = getName();
    if (m_parent) {
        int index = m_parent->copyNumber(this);
        if (index >= 0)
            result = result + std::to_string(index);
    }
    return result;
}

References INode::copyNumber(), IParameterized::getName(), and INode::m_parent.

Referenced by NodeUtils::nodePath(), and anonymous_namespace{NodeUtils.cpp}::nodeString().

Here is the call graph for this function:

createParameterTree()

ParameterPool * INode::createParameterTree ( ) const

virtualinherited

Creates new parameter pool, with all local parameters and those of its children.

Reimplemented from IParameterized.

Definition at line 116 of file INode.cpp.

{
    std::unique_ptr<ParameterPool> result(new ParameterPool);
 
    NodeIterator<PreorderStrategy> it(this);
    it.first();
    while (!it.isDone()) {
        const INode* child = it.getCurrent();
        const std::string path = NodeUtils::nodePath(*child, this->parent()) + "/";
        child->parameterPool()->copyToExternalPool(path, result.get());
        it.next();
    }
 
    return result.release();
}

References ParameterPool::copyToExternalPool(), NodeIterator< Strategy >::first(), NodeIterator< Strategy >::getCurrent(), NodeIterator< Strategy >::isDone(), NodeIterator< Strategy >::next(), NodeUtils::nodePath(), IParameterized::parameterPool(), and INode::parent().

Referenced by ParticleDistribution::generateParticles(), Simulation::runSimulation(), validateParametrization(), OffSpecSimulation::validateParametrization(), and SpecularSimulation::validateParametrization().

Here is the call graph for this function:

parameterPool()

ParameterPool* IParameterized::parameterPool ( ) const

inlineinherited

Returns pointer to the parameter pool.

Definition at line 38 of file IParameterized.h.

{ return m_pool.get(); } // has non-const usages!

References IParameterized::m_pool.

Referenced by pyfmt2::argumentList(), SampleBuilderNode::borrow_builder_parameters(), INode::createParameterTree(), INode::INode(), IParameterized::IParameterized(), anonymous_namespace{NodeUtils.cpp}::poolToString(), SampleBuilderNode::reset(), and IDistribution1D::setUnits().

parametersToString()

std::string IParameterized::parametersToString ( ) const

inherited

Returns multiline string representing available parameters.

Definition at line 40 of file IParameterized.cpp.

{
    std::ostringstream result;
    std::unique_ptr<ParameterPool> P_pool(createParameterTree());
    result << *P_pool << "\n";
    return result.str();
}

References IParameterized::createParameterTree().

Here is the call graph for this function:

registerParameter()

RealParameter & IParameterized::registerParameter ( const std::string &  name, double *  parpointer  )

inherited

Definition at line 48 of file IParameterized.cpp.

{
    return m_pool->addParameter(
        new RealParameter(name, data, getName(), [&]() -> void { onChange(); }));
}

References IParameterized::getName(), IParameterized::m_pool, and IParameterized::onChange().

Referenced by BasicLattice::BasicLattice(), Beam::Beam(), CylindersInBABuilder::CylindersInBABuilder(), DetectionProperties::DetectionProperties(), HexagonalLattice::HexagonalLattice(), IInterferenceFunction::IInterferenceFunction(), INode::INode(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), Lattice2D::Lattice2D(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), ParticleDistribution::ParticleDistribution(), PlainMultiLayerBySLDBuilder::PlainMultiLayerBySLDBuilder(), IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), IParameterized::registerVector(), ParticleLayout::registerWeight(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), ResonatorBuilder::ResonatorBuilder(), Lattice2D::setRotationEnabled(), SquareLattice::SquareLattice(), and TriangularRippleBuilder::TriangularRippleBuilder().

Here is the call graph for this function:

registerVector()

void IParameterized::registerVector ( const std::string &  base_name, kvector_t *  p_vec, const std::string &  units = "nm"  )

inherited

Definition at line 54 of file IParameterized.cpp.

{
    registerParameter(XComponentName(base_name), &((*p_vec)[0])).setUnit(units);
    registerParameter(YComponentName(base_name), &((*p_vec)[1])).setUnit(units);
    registerParameter(ZComponentName(base_name), &((*p_vec)[2])).setUnit(units);
}

References IParameterized::registerParameter(), RealParameter::setUnit(), IParameterized::XComponentName(), IParameterized::YComponentName(), and IParameterized::ZComponentName().

Referenced by Beam::Beam(), DetectionProperties::DetectionProperties(), InterferenceFunctionTwin::InterferenceFunctionTwin(), MultiLayer::MultiLayer(), Lattice::registerBasisVectors(), and IParticle::registerPosition().

Here is the call graph for this function:

setParameterValue()

void IParameterized::setParameterValue ( const std::string &  name, double  value  )

inherited

Definition at line 62 of file IParameterized.cpp.

{
    if (name.find('*') == std::string::npos && name.find('/') == std::string::npos) {
        m_pool->setParameterValue(name, value);
    } else {
        std::unique_ptr<ParameterPool> P_pool{createParameterTree()};
        if (name.find('*') != std::string::npos)
            P_pool->setMatchedParametersValue(name, value);
        else
            P_pool->setParameterValue(name, value);
    }
}

References IParameterized::createParameterTree(), IParameterized::m_pool, and ParameterPool::setMatchedParametersValue().

Referenced by AsymRippleBuilder::buildSample(), and IParameterized::setVectorValue().

Here is the call graph for this function:

setVectorValue()

void IParameterized::setVectorValue ( const std::string &  base_name, kvector_t  value  )

inherited

Definition at line 75 of file IParameterized.cpp.

{
    setParameterValue(XComponentName(base_name), value.x());
    setParameterValue(YComponentName(base_name), value.y());
    setParameterValue(ZComponentName(base_name), value.z());
}

References IParameterized::setParameterValue(), BasicVector3D< T >::x(), IParameterized::XComponentName(), BasicVector3D< T >::y(), IParameterized::YComponentName(), BasicVector3D< T >::z(), and IParameterized::ZComponentName().

Here is the call graph for this function:

parameter()

RealParameter * IParameterized::parameter ( const std::string &  name ) const

inherited

Returns parameter with given 'name'.

Definition at line 83 of file IParameterized.cpp.

{
    return m_pool->parameter(name);
}

References IParameterized::m_pool.

Referenced by initialize(), SpecularSimulation::initialize(), IParticle::registerAbundance(), Lattice::registerBasisVectors(), ParticleLayout::registerParticleDensity(), IParticle::registerPosition(), Layer::registerThickness(), Lattice2D::setRotationEnabled(), and DistributionLogNormal::setUnits().

onChange()

virtual void IParameterized::onChange ( )

inlinevirtualinherited

Action to be taken in inherited class when a parameter has changed.

Reimplemented in IProfileRipple, FormFactorSphereLogNormalRadius, FormFactorSphereGaussianRadius, FormFactorGaussSphere, ISawtoothRipple, ICosineRipple, IProfileRectangularRipple, FormFactorTruncatedSpheroid, FormFactorTruncatedSphere, FormFactorTruncatedCube, FormFactorTetrahedron, FormFactorPyramid, FormFactorPrism6, FormFactorPrism3, FormFactorLongBoxLorentz, FormFactorLongBoxGauss, FormFactorIcosahedron, FormFactorHollowSphere, FormFactorHemiEllipsoid, FormFactorFullSpheroid, FormFactorFullSphere, FormFactorEllipsoidalCylinder, FormFactorDodecahedron, FormFactorCylinder, FormFactorCuboctahedron, FormFactorCone6, FormFactorCone, FormFactorCantellatedCube, FormFactorBox, FormFactorAnisoPyramid, InterferenceFunction3DLattice, InterferenceFunction2DLattice, Lattice, and Lattice2D.

Definition at line 58 of file IParameterized.h.

{}

Referenced by Lattice2D::onChange(), and IParameterized::registerParameter().

removeParameter()

void IParameterized::removeParameter ( const std::string &  name )

inherited

Definition at line 88 of file IParameterized.cpp.

{
    m_pool->removeParameter(name);
}

References IParameterized::m_pool.

Referenced by IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), IParameterized::removeVector(), and Lattice2D::setRotationEnabled().

removeVector()

void IParameterized::removeVector ( const std::string &  base_name )

inherited

Definition at line 93 of file IParameterized.cpp.

{
    removeParameter(XComponentName(base_name));
    removeParameter(YComponentName(base_name));
    removeParameter(ZComponentName(base_name));
}

References IParameterized::removeParameter(), IParameterized::XComponentName(), IParameterized::YComponentName(), and IParameterized::ZComponentName().

Referenced by IParticle::registerPosition().

Here is the call graph for this function:

XComponentName()

std::string IParameterized::XComponentName ( const std::string &  base_name )

staticinherited

Definition at line 100 of file IParameterized.cpp.

{
    return base_name + "X";
}

Referenced by Lattice::registerBasisVectors(), IParticle::registerPosition(), IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

YComponentName()

std::string IParameterized::YComponentName ( const std::string &  base_name )

staticinherited

Definition at line 105 of file IParameterized.cpp.

{
    return base_name + "Y";
}

Referenced by IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

ZComponentName()

std::string IParameterized::ZComponentName ( const std::string &  base_name )

staticinherited

Definition at line 110 of file IParameterized.cpp.

{
    return base_name + "Z";
}

Referenced by IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

setName()

void IParameterized::setName ( const std::string &  name )

inlineinherited

Definition at line 68 of file IParameterized.h.

{ m_name = name; }

References IParameterized::m_name.

Referenced by BasicLattice::BasicLattice(), Beam::Beam(), Layer::clone(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), LayersWithAbsorptionBuilder::createSampleByIndex(), Basic2DParaCrystalBuilder::createSampleByIndex(), ParticleInVacuumBuilder::createSampleByIndex(), SimpleMagneticRotationBuilder::createSampleByIndex(), Crystal::Crystal(), DetectionProperties::DetectionProperties(), DistributionHandler::DistributionHandler(), FormFactorBAPol::FormFactorBAPol(), FormFactorCoreShell::FormFactorCoreShell(), FormFactorCrystal::FormFactorCrystal(), FormFactorDecoratorMaterial::FormFactorDecoratorMaterial(), FormFactorDecoratorPositionFactor::FormFactorDecoratorPositionFactor(), FormFactorDecoratorRotation::FormFactorDecoratorRotation(), FormFactorDWBA::FormFactorDWBA(), FormFactorDWBAPol::FormFactorDWBAPol(), FormFactorWeighted::FormFactorWeighted(), HexagonalLattice::HexagonalLattice(), IDetector::IDetector(), initialize(), GISASSimulation::initialize(), OffSpecSimulation::initialize(), SpecularSimulation::initialize(), SpecularDetector1D::initialize(), MesoCrystal::initialize(), Particle::initialize(), ParticleComposition::initialize(), INode::INode(), Instrument::Instrument(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DLattice::InterferenceFunction2DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunction2DSuperLattice::InterferenceFunction2DSuperLattice(), InterferenceFunction3DLattice::InterferenceFunction3DLattice(), InterferenceFunctionFinite2DLattice::InterferenceFunctionFinite2DLattice(), InterferenceFunctionFinite3DLattice::InterferenceFunctionFinite3DLattice(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionNone::InterferenceFunctionNone(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), ISampleBuilder::ISampleBuilder(), IsGISAXSDetector::IsGISAXSDetector(), Lattice::Lattice(), Layer::Layer(), LayerInterface::LayerInterface(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), Beam::operator=(), SampleBuilderNode::operator=(), ParticleCoreShell::ParticleCoreShell(), ParticleDistribution::ParticleDistribution(), ParticleLayout::ParticleLayout(), RectangularDetector::RectangularDetector(), SampleBuilderNode::reset(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), SampleBuilderNode::SampleBuilderNode(), SampleBuilderNode::setSBN(), SphericalDetector::SphericalDetector(), and SquareLattice::SquareLattice().

getName()

const std::string& IParameterized::getName ( ) const

inlineinherited

Definition at line 69 of file IParameterized.h.

{ return m_name; }

References IParameterized::m_name.

Referenced by Beam::Beam(), Layer::clone(), IFormFactorBorn::computeSlicingEffects(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), INode::copyNumber(), IParameterized::createParameterTree(), IFormFactor::createSlicedFormFactor(), SampleToPython::defineFormFactors(), SampleToPython::defineInterferenceFunctions(), INode::displayName(), IDetector::IDetector(), Instrument::Instrument(), IParameterized::IParameterized(), Beam::operator=(), SampleBuilderNode::operator=(), anonymous_namespace{ParticleLayout.cpp}::particleDensityIsProvidedByInterference(), IParameterized::registerParameter(), SampleBuilderNode::SampleBuilderNode(), and IFormFactor::sliceFormFactor().

Member Data Documentation

m_alpha_axis

std::unique_ptr<IAxis> DepthProbeSimulation::m_alpha_axis

private

Definition at line 120 of file DepthProbeSimulation.h.

Referenced by createUnitConverter(), DepthProbeSimulation(), getAlphaAxis(), incidentAngle(), intensityMapSize(), and setBeamParameters().

m_z_axis

std::unique_ptr<IAxis> DepthProbeSimulation::m_z_axis

private

Definition at line 121 of file DepthProbeSimulation.h.

Referenced by createUnitConverter(), DepthProbeSimulation(), getZAxis(), intensityMapSize(), and setZSpan().

m_sim_elements

std::vector<DepthProbeElement> DepthProbeSimulation::m_sim_elements

private

Definition at line 122 of file DepthProbeSimulation.h.

Referenced by addDataToCache(), checkCache(), createIntensityData(), DepthProbeSimulation(), generateSingleThreadedComputation(), initSimulationElementVector(), moveDataFromCache(), normalize(), rawResults(), setRawResults(), and validityCheck().

m_cache

std::vector<std::valarray<double> > DepthProbeSimulation::m_cache

private

Definition at line 123 of file DepthProbeSimulation.h.

Referenced by addDataToCache(), checkCache(), initSimulationElementVector(), and moveDataFromCache().

m_options

SimulationOptions Simulation::m_options

privateinherited

Definition at line 152 of file Simulation.h.

Referenced by Simulation::getOptions(), Simulation::options(), Simulation::runSimulation(), Simulation::runSingleSimulation(), and Simulation::setOptions().

m_progress

ProgressHandler Simulation::m_progress

privateinherited

Definition at line 153 of file Simulation.h.

Referenced by Simulation::progress(), Simulation::runSimulation(), Simulation::setTerminalProgressMonitor(), and Simulation::subscribe().

m_sample_provider

SampleProvider Simulation::m_sample_provider

privateinherited

Definition at line 154 of file Simulation.h.

Referenced by Simulation::getChildren(), Simulation::initialize(), Simulation::prepareSimulation(), Simulation::sample(), Simulation::setSample(), and Simulation::setSampleBuilder().

m_distribution_handler

DistributionHandler Simulation::m_distribution_handler

privateinherited

Definition at line 155 of file Simulation.h.

Referenced by Simulation::addParameterDistribution(), Simulation::getDistributionHandler(), and Simulation::runSimulation().

m_instrument

Instrument Simulation::m_instrument

privateinherited

Definition at line 156 of file Simulation.h.

Referenced by Simulation::initialize(), Simulation::instrument(), and Simulation::setInstrument().

m_background

std::unique_ptr<IBackground> Simulation::m_background

privateinherited

Definition at line 157 of file Simulation.h.

Referenced by Simulation::background(), Simulation::getChildren(), Simulation::setBackground(), and Simulation::Simulation().

m_parent

const INode* INode::m_parent {nullptr}

privateinherited

Definition at line 81 of file INode.h.

Referenced by INode::displayName(), INode::parent(), and INode::setParent().

m_NP

const size_t INode::m_NP

protectedinherited

Definition at line 86 of file INode.h.

Referenced by INode::INode().

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 87 of file INode.h.

Referenced by INode::INode(), and IFootprintFactor::setWidthRatio().

m_name

std::string IParameterized::m_name

privateinherited

Definition at line 72 of file IParameterized.h.

Referenced by IParameterized::getName(), and IParameterized::setName().

m_pool

std::unique_ptr<ParameterPool> IParameterized::m_pool

privateinherited

parameter pool (kind of pointer-to-implementation)

Definition at line 73 of file IParameterized.h.

Referenced by IParameterized::createParameterTree(), IParameterized::parameter(), IParameterized::parameterPool(), IParameterized::registerParameter(), IParameterized::removeParameter(), and IParameterized::setParameterValue().

---

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

• /home/www/ba/Core/Simulation/DepthProbeSimulation.h
• /home/www/ba/Core/Simulation/DepthProbeSimulation.cpp