ConvolutionDetectorResolution Class Reference

Inheritance diagram for ConvolutionDetectorResolution:

Collaboration diagram for ConvolutionDetectorResolution:

Public Types
typedef double(*	cumulative_DF_1d) (double)

Public Member Functions
	ConvolutionDetectorResolution (cumulative_DF_1d res_function_1d)
	ConvolutionDetectorResolution (const IResolutionFunction2D &p_res_function_2d)
virtual	~ConvolutionDetectorResolution ()
virtual void	applyDetectorResolution (OutputData< double > *p_intensity_map) const
virtual ConvolutionDetectorResolution *	clone () const
void	accept (INodeVisitor *visitor) const final
const IResolutionFunction2D *	getResolutionFunction2D () const
std::vector< const INode * >	getChildren () const
void	applyDetectorResolutionPol (OutputData< Eigen::Matrix2d > *p_matrix_intensity) const
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
	ConvolutionDetectorResolution (const ConvolutionDetectorResolution &other)

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

Private Member Functions
void	setResolutionFunction (const IResolutionFunction2D &resFunc)
void	apply1dConvolution (OutputData< double > *p_intensity_map) const
void	apply2dConvolution (OutputData< double > *p_intensity_map) const
double	getIntegratedPDF1d (double x, double step) const
double	getIntegratedPDF2d (double x, double step_x, double y, double step_y) const

Private Attributes
size_t	m_dimension
cumulative_DF_1d	m_res_function_1d
std::unique_ptr< IResolutionFunction2D >	mp_res_function_2d
const INode *	m_parent {nullptr}
std::string	m_name
std::unique_ptr< ParameterPool >	m_pool

Detailed Description

Convolutes the intensity in 1 or 2 dimensions with a resolution function.

Limitation: this class assumes that the data points are evenly distributed on each axis

Definition at line 26 of file ConvolutionDetectorResolution.h.

Member Typedef Documentation

cumulative_DF_1d

typedef double(* ConvolutionDetectorResolution::cumulative_DF_1d) (double)

Definition at line 29 of file ConvolutionDetectorResolution.h.

Constructor & Destructor Documentation

ConvolutionDetectorResolution() [1/3]

ConvolutionDetectorResolution::ConvolutionDetectorResolution

(

cumulative_DF_1d

res_function_1d

)

Constructor taking a 1 dimensional resolution function as argument.

Definition at line 18 of file ConvolutionDetectorResolution.cpp.

    : m_dimension(1), m_res_function_1d(res_function_1d)
{
    setName("ConvolutionDetectorResolution");
}

References IParameterized::setName().

Referenced by clone().

Here is the call graph for this function:

ConvolutionDetectorResolution() [2/3]

ConvolutionDetectorResolution::ConvolutionDetectorResolution

(

const IResolutionFunction2D &

p_res_function_2d

)

Constructor taking a 2 dimensional resolution function as argument.

Definition at line 24 of file ConvolutionDetectorResolution.cpp.

    : m_dimension(2), m_res_function_1d(0)
{
    setName("ConvolutionDetectorResolution");
    setResolutionFunction(p_res_function_2d);
}

References IParameterized::setName(), and setResolutionFunction().

Here is the call graph for this function:

~ConvolutionDetectorResolution()

ConvolutionDetectorResolution::~ConvolutionDetectorResolution ( )

virtualdefault

ConvolutionDetectorResolution() [3/3]

ConvolutionDetectorResolution::ConvolutionDetectorResolution ( const ConvolutionDetectorResolution &  other )

protected

Definition at line 34 of file ConvolutionDetectorResolution.cpp.

{
    m_dimension = other.m_dimension;
    m_res_function_1d = other.m_res_function_1d;
    if (other.mp_res_function_2d)
        setResolutionFunction(*other.mp_res_function_2d);
    setName(other.getName());
}

References IParameterized::getName(), m_dimension, m_res_function_1d, mp_res_function_2d, IParameterized::setName(), and setResolutionFunction().

Here is the call graph for this function:

Member Function Documentation

applyDetectorResolution()

void ConvolutionDetectorResolution::applyDetectorResolution ( OutputData< double > *  p_intensity_map ) const

virtual

Convolve given intensities with the encapsulated resolution.

Implements IDetectorResolution.

Definition at line 54 of file ConvolutionDetectorResolution.cpp.

{
    if (p_intensity_map->getRank() != m_dimension) {
        throw Exceptions::RuntimeErrorException(
            "ConvolutionDetectorResolution::applyDetectorResolution() -> Error! "
            "Intensity map must have same dimension as detector resolution function.");
    }
    switch (m_dimension) {
    case 1:
        apply1dConvolution(p_intensity_map);
        break;
    case 2:
        apply2dConvolution(p_intensity_map);
        break;
    default:
        throw Exceptions::LogicErrorException(
            "ConvolutionDetectorResolution::applyDetectorResolution() -> Error! "
            "Class ConvolutionDetectorResolution must be initialized with dimension 1 or 2.");
    }
}

References apply1dConvolution(), apply2dConvolution(), OutputData< T >::getRank(), and m_dimension.

Here is the call graph for this function:

clone()

ConvolutionDetectorResolution * ConvolutionDetectorResolution::clone ( ) const

virtual

Implements IDetectorResolution.

Definition at line 44 of file ConvolutionDetectorResolution.cpp.

{
    return new ConvolutionDetectorResolution(*this);
}

References ConvolutionDetectorResolution().

Here is the call graph for this function:

accept()

void ConvolutionDetectorResolution::accept ( INodeVisitor *  visitor ) const

inlinefinalvirtual

Calls the INodeVisitor's visit method.

Implements INode.

Definition at line 44 of file ConvolutionDetectorResolution.h.

{ visitor->visit(this); }

getResolutionFunction2D()

const IResolutionFunction2D * ConvolutionDetectorResolution::getResolutionFunction2D ( ) const

inline

Definition at line 65 of file ConvolutionDetectorResolution.h.

{
    return mp_res_function_2d.get();
}

References mp_res_function_2d.

getChildren()

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

virtual

Returns a vector of children (const).

Reimplemented from INode.

Definition at line 49 of file ConvolutionDetectorResolution.cpp.

{
    return std::vector<const INode*>() << mp_res_function_2d;
}

References mp_res_function_2d.

setResolutionFunction()

void ConvolutionDetectorResolution::setResolutionFunction ( const IResolutionFunction2D &  resFunc )

private

Definition at line 76 of file ConvolutionDetectorResolution.cpp.

{
    mp_res_function_2d.reset(resFunc.clone());
    registerChild(mp_res_function_2d.get());
}

References IResolutionFunction2D::clone(), mp_res_function_2d, and INode::registerChild().

Referenced by ConvolutionDetectorResolution().

Here is the call graph for this function:

apply1dConvolution()

void ConvolutionDetectorResolution::apply1dConvolution ( OutputData< double > *  p_intensity_map ) const

private

Definition at line 82 of file ConvolutionDetectorResolution.cpp.

{
    if (m_res_function_1d == 0)
        throw Exceptions::LogicErrorException(
            "ConvolutionDetectorResolution::apply1dConvolution() -> Error! "
            "No 1d resolution function present for convolution of 1d data.");
    if (p_intensity_map->getRank() != 1)
        throw Exceptions::LogicErrorException(
            "ConvolutionDetectorResolution::apply1dConvolution() -> Error! "
            "Number of axes for intensity map does not correspond to the dimension of the map.");
    const IAxis& axis = p_intensity_map->getAxis(0);
    // Construct source vector from original intensity map
    std::vector<double> source_vector = p_intensity_map->getRawDataVector();
    size_t data_size = source_vector.size();
    if (data_size < 2)
        return; // No convolution for sets of zero or one element
    // Construct kernel vector from resolution function
    if (axis.size() != data_size)
        throw Exceptions::LogicErrorException(
            "ConvolutionDetectorResolution::apply1dConvolution() -> Error! "
            "Size of axis for intensity map does not correspond to size of data in the map.");
    double step_size = std::abs(axis[0] - axis[axis.size() - 1]) / (data_size - 1);
    double mid_value = axis[axis.size() / 2]; // because Convolve expects zero at midpoint
    std::vector<double> kernel;
    for (size_t index = 0; index < data_size; ++index) {
        kernel.push_back(getIntegratedPDF1d(axis[index] - mid_value, step_size));
    }
    // Calculate convolution
    std::vector<double> result;
    Convolve().fftconvolve(source_vector, kernel, result);
    // Truncate negative values that can arise because of finite precision of Fourier Transform
    std::for_each(result.begin(), result.end(), [](double& val) { val = std::max(0.0, val); });
    // Populate intensity map with results
    p_intensity_map->setRawDataVector(result);
}

References Convolve::fftconvolve(), OutputData< T >::getAxis(), getIntegratedPDF1d(), OutputData< T >::getRank(), OutputData< T >::getRawDataVector(), m_res_function_1d, OutputData< T >::setRawDataVector(), and IAxis::size().

Referenced by applyDetectorResolution().

Here is the call graph for this function:

apply2dConvolution()

void ConvolutionDetectorResolution::apply2dConvolution ( OutputData< double > *  p_intensity_map ) const

private

Definition at line 118 of file ConvolutionDetectorResolution.cpp.

{
    if (mp_res_function_2d == 0)
        throw Exceptions::LogicErrorException(
            "ConvolutionDetectorResolution::apply2dConvolution() -> Error! "
            "No 2d resolution function present for convolution of 2d data.");
    if (p_intensity_map->getRank() != 2)
        throw Exceptions::LogicErrorException(
            "ConvolutionDetectorResolution::apply2dConvolution() -> Error! "
            "Number of axes for intensity map does not correspond to the dimension of the map.");
    const IAxis& axis_1 = p_intensity_map->getAxis(0);
    const IAxis& axis_2 = p_intensity_map->getAxis(1);
    size_t axis_size_1 = axis_1.size();
    size_t axis_size_2 = axis_2.size();
    if (axis_size_1 < 2 || axis_size_2 < 2)
        return; // No 2d convolution for 1d data
    // Construct source vector array from original intensity map
    std::vector<double> raw_source_vector = p_intensity_map->getRawDataVector();
    std::vector<std::vector<double>> source;
    size_t raw_data_size = raw_source_vector.size();
    if (raw_data_size != axis_size_1 * axis_size_2)
        throw Exceptions::LogicErrorException(
            "ConvolutionDetectorResolution::apply2dConvolution() -> Error! "
            "Intensity map data size does not match the product of its axes' sizes");
    for (auto it = raw_source_vector.begin(); it != raw_source_vector.end(); it += axis_size_2) {
        std::vector<double> row_vector(it, it + axis_size_2);
        source.push_back(row_vector);
    }
    // Construct kernel vector from resolution function
    std::vector<std::vector<double>> kernel;
    kernel.resize(axis_size_1);
    double mid_value_1 = axis_1[axis_size_1 / 2]; // because Convolve expects zero at midpoint
    double mid_value_2 = axis_2[axis_size_2 / 2]; // because Convolve expects zero at midpoint
    double step_size_1 = std::abs(axis_1[0] - axis_1[axis_size_1 - 1]) / (axis_size_1 - 1);
    double step_size_2 = std::abs(axis_2[0] - axis_2[axis_size_2 - 1]) / (axis_size_2 - 1);
    for (size_t index_1 = 0; index_1 < axis_size_1; ++index_1) {
        double value_1 = axis_1[index_1] - mid_value_1;
        std::vector<double> row_vector;
        row_vector.resize(axis_size_2, 0.0);
        for (size_t index_2 = 0; index_2 < axis_size_2; ++index_2) {
            double value_2 = axis_2[index_2] - mid_value_2;
            double z_value = getIntegratedPDF2d(value_1, step_size_1, value_2, step_size_2);
            row_vector[index_2] = z_value;
        }
        kernel[index_1] = row_vector;
    }
    // Calculate convolution
    std::vector<std::vector<double>> result;
    Convolve().fftconvolve(source, kernel, result);
    // Populate intensity map with results
    std::vector<double> result_vector;
    for (size_t index_1 = 0; index_1 < axis_size_1; ++index_1) {
        for (size_t index_2 = 0; index_2 < axis_size_2; ++index_2) {
            double value = result[index_1][index_2];
            result_vector.push_back(value);
        }
    }
    // Truncate negative values that can arise because of finite precision of Fourier Transform
    std::for_each(result_vector.begin(), result_vector.end(),
                  [](double& val) { val = std::max(0.0, val); });
    for (auto it = p_intensity_map->begin(); it != p_intensity_map->end(); ++it)
        (*it) = result_vector[it.getIndex()];
}

References OutputData< T >::begin(), OutputData< T >::end(), Convolve::fftconvolve(), OutputData< T >::getAxis(), getIntegratedPDF2d(), OutputData< T >::getRank(), OutputData< T >::getRawDataVector(), mp_res_function_2d, and IAxis::size().

Referenced by applyDetectorResolution().

Here is the call graph for this function:

getIntegratedPDF1d()

double ConvolutionDetectorResolution::getIntegratedPDF1d ( double  x, double  step  ) const

private

Definition at line 182 of file ConvolutionDetectorResolution.cpp.

{
    double halfstep = step / 2.0;
    double xmin = x - halfstep;
    double xmax = x + halfstep;
    ASSERT(m_res_function_1d != nullptr);
    return m_res_function_1d(xmax) - m_res_function_1d(xmin);
}

References ASSERT, and m_res_function_1d.

Referenced by apply1dConvolution().

getIntegratedPDF2d()

double ConvolutionDetectorResolution::getIntegratedPDF2d ( double  x, double  step_x, double  y, double  step_y  ) const

private

Definition at line 191 of file ConvolutionDetectorResolution.cpp.

{
    double halfstepx = step_x / 2.0;
    double halfstepy = step_y / 2.0;
    double xmin = x - halfstepx;
    double xmax = x + halfstepx;
    double ymin = y - halfstepy;
    double ymax = y + halfstepy;
    double result =
        mp_res_function_2d->evaluateCDF(xmax, ymax) - mp_res_function_2d->evaluateCDF(xmax, ymin)
        - mp_res_function_2d->evaluateCDF(xmin, ymax) + mp_res_function_2d->evaluateCDF(xmin, ymin);
    return result;
}

References mp_res_function_2d.

Referenced by apply2dConvolution().

applyDetectorResolutionPol()

void IDetectorResolution::applyDetectorResolutionPol ( OutputData< Eigen::Matrix2d > *  p_matrix_intensity ) const

inherited

Applies the detector resolution to the matrix-valued intensity data.

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(), 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(), DepthProbeSimulation::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 DepthProbeSimulation::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(), 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(), DepthProbeSimulation::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(), 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_dimension

size_t ConvolutionDetectorResolution::m_dimension

private

Definition at line 60 of file ConvolutionDetectorResolution.h.

Referenced by applyDetectorResolution(), and ConvolutionDetectorResolution().

m_res_function_1d

cumulative_DF_1d ConvolutionDetectorResolution::m_res_function_1d

private

Definition at line 61 of file ConvolutionDetectorResolution.h.

Referenced by apply1dConvolution(), ConvolutionDetectorResolution(), and getIntegratedPDF1d().

mp_res_function_2d

std::unique_ptr<IResolutionFunction2D> ConvolutionDetectorResolution::mp_res_function_2d

private

Definition at line 62 of file ConvolutionDetectorResolution.h.

Referenced by apply2dConvolution(), ConvolutionDetectorResolution(), getChildren(), getIntegratedPDF2d(), getResolutionFunction2D(), and setResolutionFunction().

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/Device/Resolution/ConvolutionDetectorResolution.h
• /home/www/ba/Device/Resolution/ConvolutionDetectorResolution.cpp