Instrument Class Reference

Inheritance diagram for Instrument:

Collaboration diagram for Instrument:

Public Member Functions
	Instrument ()
	Instrument (const Instrument &other)
Instrument &	operator= (const Instrument &other)
virtual	~Instrument ()
void	accept (INodeVisitor *visitor) const final
Beam &	getBeam ()
const Beam &	getBeam () const
void	setBeam (const Beam &beam)
void	setBeamParameters (double wavelength, double alpha_i, double phi_i)
void	setBeamIntensity (double intensity)
void	setBeamPolarization (const kvector_t bloch_vector)
double	getBeamIntensity () const
const IDetector *	getDetector () const
IDetector &	detector ()
const IDetector &	detector () const
IDetector2D &	detector2D ()
const IDetector2D &	detector2D () const
const DetectorMask *	getDetectorMask () const
const IAxis &	getDetectorAxis (size_t index) const
size_t	getDetectorDimension () const
void	setDetector (const IDetector &detector)
void	setDetectorResolutionFunction (const IResolutionFunction2D &p_resolution_function)
void	removeDetectorResolution ()
void	setAnalyzerProperties (const kvector_t direction, double efficiency, double total_transmission)
void	applyDetectorResolution (OutputData< double > *p_intensity_map) const
void	initDetector ()
std::vector< const INode * >	getChildren () const
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 Attributes
std::unique_ptr< IDetector >	m_detector
Beam	m_beam
const size_t	m_NP
std::vector< double >	m_P

Private Attributes
const INode *	m_parent {nullptr}
std::string	m_name
std::unique_ptr< ParameterPool >	m_pool

Detailed Description

Assembles beam, detector and their relative positions with respect to the sample.

Definition at line 33 of file Instrument.h.

Constructor & Destructor Documentation

Instrument() [1/2]

Instrument::Instrument

(

)

Definition at line 20 of file Instrument.cpp.

                       : m_detector(new SphericalDetector), m_beam(Beam::horizontalBeam())
{
    setName("Instrument");
    registerChild(m_detector.get());
    registerChild(&m_beam);
}

References m_beam, m_detector, INode::registerChild(), and IParameterized::setName().

Here is the call graph for this function:

Instrument() [2/2]

Instrument::Instrument

(

const Instrument &

other

)

Definition at line 27 of file Instrument.cpp.

                                              : INode(), m_beam(other.m_beam)
{
    if (other.m_detector)
        setDetector(*other.m_detector);
    registerChild(&m_beam);
    setName(other.getName());
}

References IParameterized::getName(), m_beam, m_detector, INode::registerChild(), setDetector(), and IParameterized::setName().

Here is the call graph for this function:

~Instrument()

Instrument::~Instrument ( )

virtualdefault

Member Function Documentation

operator=()

Instrument & Instrument::operator=

(

const Instrument &

other

)

Definition at line 37 of file Instrument.cpp.

{
    if (this != &other) {
        m_beam = other.m_beam;
        registerChild(&m_beam);
        if (other.m_detector)
            setDetector(*other.m_detector);
    }
    return *this;
}

References m_beam, m_detector, INode::registerChild(), and setDetector().

Here is the call graph for this function:

accept()

void Instrument::accept ( INodeVisitor *  visitor ) const

inlinefinalvirtual

Calls the INodeVisitor's visit method.

Implements INode.

Definition at line 42 of file Instrument.h.

{ visitor->visit(this); }

getBeam() [1/2]

Beam& Instrument::getBeam ( )

inline

Definition at line 44 of file Instrument.h.

{ return m_beam; }

References m_beam.

Referenced by UnitConverterUtils::createConverterForGISAS(), SimulationToPython::defineGISASBeam(), SimulationToPython::defineOffSpecBeam(), SimulationToPython::defineSpecularScan(), anonymous_namespace{SpecularSimulation.cpp}::generateSimulationElements(), initDetector(), DepthProbeSimulation::initialize(), SpecularSimulation::initialize(), DepthProbeSimulation::initSimulationElementVector(), GISASSimulation::initSimulationElementVector(), OffSpecSimulation::initSimulationElementVector(), DepthProbeSimulation::normalize(), and DepthProbeSimulation::setBeamParameters().

getBeam() [2/2]

const Beam& Instrument::getBeam ( ) const

inline

Definition at line 45 of file Instrument.h.

{ return m_beam; }

References m_beam.

setBeam()

void Instrument::setBeam

(

const Beam &

beam

)

Definition at line 99 of file Instrument.cpp.

{
    m_beam = beam;
    if (m_detector)
        initDetector();
}

References initDetector(), m_beam, and m_detector.

Here is the call graph for this function:

setBeamParameters()

void Instrument::setBeamParameters	(	double	wavelength,
		double	alpha_i,
		double	phi_i
	)

Sets the beam wavelength and incoming angles.

Definition at line 87 of file Instrument.cpp.

{
    m_beam.setCentralK(wavelength, alpha_i, phi_i);
    if (m_detector)
        initDetector();
}

References initDetector(), m_beam, m_detector, Beam::setCentralK(), and anonymous_namespace{SlicedCylindersBuilder.cpp}::wavelength().

Referenced by DepthProbeSimulation::setBeamParameters(), OffSpecSimulation::setBeamParameters(), GISASSimulation::setBeamParameters(), and SpecularSimulation::setScan().

Here is the call graph for this function:

setBeamIntensity()

void Instrument::setBeamIntensity

(

double

intensity

)

Definition at line 106 of file Instrument.cpp.

{
    m_beam.setIntensity(intensity);
}

References m_beam, and Beam::setIntensity().

Referenced by Simulation::setBeamIntensity().

Here is the call graph for this function:

setBeamPolarization()

void Instrument::setBeamPolarization

(

const kvector_t

bloch_vector

)

Sets the beam's polarization according to the given Bloch vector.

Definition at line 111 of file Instrument.cpp.

{
    m_beam.setPolarization(bloch_vector);
}

References m_beam, and Beam::setPolarization().

Referenced by Simulation::setBeamPolarization().

Here is the call graph for this function:

getBeamIntensity()

double Instrument::getBeamIntensity

(

)

const

Definition at line 116 of file Instrument.cpp.

{
    return m_beam.getIntensity();
}

References Beam::getIntensity(), and m_beam.

Referenced by Simulation::getBeamIntensity().

Here is the call graph for this function:

getDetector()

const IDetector * Instrument::getDetector

(

)

const

Definition at line 121 of file Instrument.cpp.

{
    ASSERT(m_detector);
    return m_detector.get();
}

References ASSERT, and m_detector.

Referenced by UnitConverterUtils::createConverterForGISAS(), SimulationToPython::defineDetector(), SimulationToPython::defineDetectorPolarizationAnalysis(), SimulationToPython::defineDetectorResolutionFunction(), and SimulationToPython::defineMasks().

detector() [1/2]

IDetector & Instrument::detector

(

)

Definition at line 133 of file Instrument.cpp.

{
    ASSERT(m_detector);
    return *m_detector;
}

References ASSERT, and m_detector.

Referenced by Simulation::convertData(), anonymous_namespace{SpecularSimulation.cpp}::generateSimulationElements(), GISASSimulation::intensityMapSize(), and setDetector().

detector() [2/2]

const IDetector & Instrument::detector

(

)

const

Definition at line 127 of file Instrument.cpp.

{
    ASSERT(m_detector);
    return *m_detector;
}

References ASSERT, and m_detector.

detector2D() [1/2]

IDetector2D & Instrument::detector2D

(

)

Definition at line 139 of file Instrument.cpp.

{
    ASSERT(m_detector);
    IDetector2D* p = dynamic_cast<IDetector2D*>(m_detector.get());
    if (!p)
        throw std::runtime_error("Error: Detector is not twodimensional");
    return *p;
}

References ASSERT, m_detector, and anonymous_namespace{InterferenceFunctionHardDisk.cpp}::p.

Referenced by Simulation2D::addMask(), Simulation2D::generateSimulationElements(), Simulation2D::maskAll(), Simulation2D::prepareSimulation(), Simulation2D::removeMasks(), Simulation2D::setDetectorParameters(), and Simulation2D::setRegionOfInterest().

detector2D() [2/2]

const IDetector2D & Instrument::detector2D

(

)

const

Definition at line 148 of file Instrument.cpp.

{
    ASSERT(m_detector);
    IDetector2D* const p = dynamic_cast<IDetector2D* const>(m_detector.get());
    if (!p)
        throw std::runtime_error("Error: Detector is not twodimensional");
    return *p;
}

References ASSERT, m_detector, and anonymous_namespace{InterferenceFunctionHardDisk.cpp}::p.

getDetectorMask()

const DetectorMask * Instrument::getDetectorMask

(

)

const

Definition at line 94 of file Instrument.cpp.

{
    return m_detector->detectorMask();
}

References m_detector.

getDetectorAxis()

const IAxis & Instrument::getDetectorAxis

(

size_t

index

)

const

Definition at line 157 of file Instrument.cpp.

{
    return m_detector->getAxis(index);
}

References m_detector.

Referenced by OffSpecSimulation::intensityMapSize(), OffSpecSimulation::transferDetectorImage(), and OffSpecSimulation::transferResultsToIntensityMap().

getDetectorDimension()

size_t Instrument::getDetectorDimension

(

)

const

Definition at line 162 of file Instrument.cpp.

{
    return m_detector->dimension();
}

References m_detector.

Referenced by OffSpecSimulation::transferDetectorImage(), and OffSpecSimulation::updateIntensityMap().

setDetector()

void Instrument::setDetector

(

const IDetector &

detector

)

Sets the detector (axes can be overwritten later)

Definition at line 48 of file Instrument.cpp.

{
    m_detector.reset(detector.clone());
    registerChild(m_detector.get());
    initDetector();
}

References IDetector::clone(), detector(), initDetector(), m_detector, and INode::registerChild().

Referenced by Instrument(), operator=(), DepthProbeSimulation::setBeamParameters(), Simulation2D::setDetector(), and SpecularSimulation::setScan().

Here is the call graph for this function:

setDetectorResolutionFunction()

void Instrument::setDetectorResolutionFunction

(

const IResolutionFunction2D &

p_resolution_function

)

Sets detector resolution function.

Definition at line 72 of file Instrument.cpp.

{
    m_detector->setResolutionFunction(p_resolution_function);
}

References m_detector.

Referenced by Simulation::setDetectorResolutionFunction().

removeDetectorResolution()

void Instrument::removeDetectorResolution

(

)

Removes detector resolution function.

Definition at line 77 of file Instrument.cpp.

{
    m_detector->removeDetectorResolution();
}

References m_detector.

Referenced by Simulation::removeDetectorResolutionFunction().

setAnalyzerProperties()

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

Sets the polarization analyzer characteristics of the detector.

Definition at line 167 of file Instrument.cpp.

{
    m_detector->setAnalyzerProperties(direction, efficiency, total_transmission);
}

References m_detector.

Referenced by Simulation::setAnalyzerProperties().

applyDetectorResolution()

void Instrument::applyDetectorResolution

(

OutputData< double > *

p_intensity_map

)

const

apply the detector resolution to the given intensity map

Definition at line 82 of file Instrument.cpp.

{
    m_detector->applyDetectorResolution(p_intensity_map);
}

References m_detector.

Referenced by OffSpecSimulation::transferDetectorImage().

initDetector()

void Instrument::initDetector

(

)

init detector with beam settings

Definition at line 55 of file Instrument.cpp.

{
    if (!m_detector)
        throw Exceptions::RuntimeErrorException(
            "Instrument::initDetector() -> Error. Detector is not initialized.");
    m_detector->init(getBeam());
}

References getBeam(), and m_detector.

Referenced by GISASSimulation::prepareSimulation(), SpecularSimulation::prepareSimulation(), setBeam(), setBeamParameters(), and setDetector().

Here is the call graph for this function:

getChildren()

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

virtual

Returns a vector of children (const).

Reimplemented from INode.

Definition at line 63 of file Instrument.cpp.

{
    std::vector<const INode*> result;
    result.push_back(&m_beam);
    if (m_detector)
        result.push_back(m_detector.get());
    return result;
}

References m_beam, and m_detector.

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(), Beam::operator=(), operator=(), Particle::Particle(), ParticleDistribution::ParticleDistribution(), IParticle::rotate(), ParticleLayout::setAndRegisterInterferenceFunction(), Simulation::setBackground(), InterferenceFunction1DLattice::setDecayFunction(), InterferenceFunction2DLattice::setDecayFunction(), 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(), 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::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(), 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(), IParameterized::IParameterized(), Beam::operator=(), SampleBuilderNode::operator=(), anonymous_namespace{ParticleLayout.cpp}::particleDensityIsProvidedByInterference(), IParameterized::registerParameter(), SampleBuilderNode::SampleBuilderNode(), and IFormFactor::sliceFormFactor().

Member Data Documentation

m_detector

std::unique_ptr<IDetector> Instrument::m_detector

protected

Definition at line 93 of file Instrument.h.

Referenced by applyDetectorResolution(), detector(), detector2D(), getChildren(), getDetector(), getDetectorAxis(), getDetectorDimension(), getDetectorMask(), initDetector(), Instrument(), operator=(), removeDetectorResolution(), setAnalyzerProperties(), setBeam(), setBeamParameters(), setDetector(), and setDetectorResolutionFunction().

m_beam

Beam Instrument::m_beam

protected

Definition at line 94 of file Instrument.h.

Referenced by getBeam(), getBeamIntensity(), getChildren(), Instrument(), operator=(), setBeam(), setBeamIntensity(), setBeamParameters(), and setBeamPolarization().

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