Beam Class Reference

An incident neutron or x-ray beam. More...

Inheritance diagram for Beam:

Collaboration diagram for Beam:

Public Member Functions
	Beam (const Beam &other)
	Beam (double intensity, double wavelength, const Direction &direction)
virtual	~Beam ()
void	accept (INodeVisitor *visitor) const override
	Calls the INodeVisitor's visit method. More...
int	copyNumber (const INode *node) const
	Returns copyNumber of child, which takes into account existence of children with same name. More...
ParameterPool *	createParameterTree () const
	Creates new parameter pool, with all local parameters and those of its children. More...
Direction	direction () const
std::string	displayName () const
	Returns display name, composed from the name of node and it's copy number. More...
const IFootprintFactor *	footprintFactor () const
	Returns footprint factor. More...
kvector_t	getBlochVector () const
kvector_t	getCentralK () const
	Returns the wavevector. More...
std::vector< const INode * >	getChildren () const override
	Returns a vector of children. More...
const std::string &	getName () const
Eigen::Matrix2cd	getPolarization () const
	Returns the polarization density matrix (in spin basis along z-axis) More...
double	intensity () const
	Returns the beam intensity in neutrons/sec. More...
virtual void	onChange ()
	Action to be taken in inherited class when a parameter has changed. More...
Beam &	operator= (const Beam &other)
RealParameter *	parameter (const std::string &name) const
	Returns parameter with given 'name'. More...
ParameterPool *	parameterPool () const
	Returns pointer to the parameter pool. More...
std::string	parametersToString () const
	Returns multiline string representing available parameters. More...
INode *	parent ()
const INode *	parent () const
std::vector< const INode * >	progeny () const
	Returns a vector of all descendants. More...
void	registerChild (INode *node)
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	removeParameter (const std::string &name)
void	removeVector (const std::string &base_name)
void	setDirection (const Direction &direction)
void	setFootprintFactor (const IFootprintFactor &shape_factor)
	Sets footprint factor to the beam. More...
void	setInclination (const double alpha)
void	setIntensity (double intensity)
	Sets the beam intensity in neutrons/sec. More...
void	setName (const std::string &name)
void	setParameterValue (const std::string &name, double value)
virtual void	setParent (const INode *newParent)
void	setPolarization (const kvector_t bloch_vector)
	Sets the polarization density matrix according to the given Bloch vector. More...
void	setVectorValue (const std::string &base_name, kvector_t value)
void	setWavelength (double wavelength)
virtual std::string	treeToString () const
	Returns multiline string representing tree structure below the node. More...
double	wavelength () const

Static Public Member Functions
static Beam	horizontalBeam ()
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
const size_t	m_NP
std::vector< double >	m_P

Private Member Functions
	Beam ()

Private Attributes
double	m_alpha
kvector_t	m_bloch_vector
	Bloch vector encoding the beam's polarization. More...
double	m_intensity
	beam intensity (neutrons/sec) More...
std::string	m_name
const INode *	m_parent {nullptr}
double	m_phi
std::unique_ptr< ParameterPool >	m_pool
	parameter pool (kind of pointer-to-implementation) More...
std::unique_ptr< IFootprintFactor >	m_shape_factor
	footprint correction handler More...
double	m_wavelength

Detailed Description

An incident neutron or x-ray beam.

Definition at line 27 of file Beam.h.

Constructor & Destructor Documentation

Beam() [1/3]

Beam::Beam	(	double	intensity,
		double	wavelength,
		const Direction &	direction
	)

Definition at line 24 of file Beam.cpp.

    : m_intensity(intensity)
    , m_wavelength(wavelength)
    // , m_direction(direction)
    , m_alpha(direction.alpha())
    , m_phi(direction.phi())
{
    setName("Beam");
    registerParameter("Intensity", &m_intensity).setNonnegative();
    registerParameter("Wavelength", &m_wavelength).setUnit("nm").setNonnegative();
    registerParameter("InclinationAngle", &m_alpha).setUnit("rad").setLimited(0, INCLINATION_LIMIT);
    registerParameter("AzimuthalAngle", &m_phi).setUnit("rad").setLimited(-M_PI_2, M_PI_2);
    registerVector("BlochVector", &m_bloch_vector, "");
}

References INCLINATION_LIMIT, m_alpha, m_bloch_vector, m_intensity, m_phi, M_PI_2, m_wavelength, IParametricComponent::registerParameter(), IParametricComponent::registerVector(), RealParameter::setLimited(), IParametricComponent::setName(), RealParameter::setNonnegative(), and RealParameter::setUnit().

Here is the call graph for this function:

Beam() [2/3]

Beam::Beam

(

const Beam &

other

)

Definition at line 44 of file Beam.cpp.

                            : Beam(other.m_intensity, other.m_wavelength, other.direction())
{
    m_bloch_vector = other.m_bloch_vector;
    setName(other.getName());
    if (other.m_shape_factor) {
        m_shape_factor.reset(other.m_shape_factor->clone());
        registerChild(m_shape_factor.get());
    }
}

References IParametricComponent::getName(), m_bloch_vector, m_shape_factor, INode::registerChild(), and IParametricComponent::setName().

Here is the call graph for this function:

~Beam()

Beam::~Beam ( )

virtualdefault

Beam() [3/3]

Beam::Beam ( )

private

Referenced by horizontalBeam().

Member Function Documentation

accept()

void Beam::accept ( INodeVisitor *  visitor ) const

inlineoverridevirtual

Calls the INodeVisitor's visit method.

Implements INode.

Definition at line 38 of file Beam.h.

{ visitor->visit(this); }

References INodeVisitor::visit().

Here is the call graph for this function:

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 94 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(), IParametricComponent::getName(), and INode::parent().

Referenced by INode::displayName().

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 IParametricComponent.

Definition at line 126 of file INode.cpp.

{
    std::unique_ptr<ParameterPool> result(new ParameterPool);
 
    for (const INode* child : progeny()) {
        const std::string path = NodeUtils::nodePath(child, parent()) + "/";
        child->parameterPool()->copyToExternalPool(path, result.get());
    }
 
    return result.release();
}

References NodeUtils::nodePath(), INode::parent(), and INode::progeny().

Referenced by ISimulation::runSimulation(), DepthProbeSimulation::validateParametrization(), OffSpecularSimulation::validateParametrization(), and SpecularSimulation::validateParametrization().

Here is the call graph for this function:

direction()

Direction Beam::direction ( ) const

inline

Definition at line 45 of file Beam.h.

{ return {m_alpha, m_phi}; } // TODO -> const .. &

References m_alpha, and m_phi.

Referenced by DepthProbeSimulation::generateSimulationElements(), ISimulation2D::generateSimulationElements(), getCentralK(), RectangularDetector::indexOfSpecular(), SphericalDetector::indexOfSpecular(), RectangularDetector::init(), setDirection(), TransformFromDomain::setGISASBeamItem(), and TransformFromDomain::setOffSpecularBeamItem().

displayName()

std::string INode::displayName ( ) const

inherited

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

Definition at line 115 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(), IParametricComponent::getName(), and INode::m_parent.

Referenced by NodeUtils::nodePath().

Here is the call graph for this function:

footprintFactor()

const IFootprintFactor * Beam::footprintFactor

(

)

const

Returns footprint factor.

Definition at line 101 of file Beam.cpp.

{
    return m_shape_factor.get();
}

References m_shape_factor.

Referenced by DepthProbeSimulation::normalize().

getBlochVector()

kvector_t Beam::getBlochVector

(

)

const

Definition at line 122 of file Beam.cpp.

{
    return m_bloch_vector;
}

References m_bloch_vector.

Referenced by TransformFromDomain::setGISASBeamItem().

getCentralK()

kvector_t Beam::getCentralK

(

)

const

Returns the wavevector.

Definition at line 73 of file Beam.cpp.

{
    return M_TWOPI / m_wavelength * Direction(-direction().alpha(), direction().phi()).vector();
}

References direction(), M_TWOPI, m_wavelength, and Direction::vector().

Referenced by RectangularDetector::init().

Here is the call graph for this function:

getChildren()

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

overridevirtual

Returns a vector of children.

Reimplemented from INode.

Definition at line 140 of file Beam.cpp.

{
    if (m_shape_factor)
        return {m_shape_factor.get()};
    return {};
}

References m_shape_factor.

getName()

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

inlineinherited

Definition at line 70 of file IParametricComponent.h.

{ return m_name; }

References IParametricComponent::m_name.

Referenced by Beam(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), IDetector::IDetector(), Instrument::Instrument(), IParametricComponent::IParametricComponent(), SampleBuilderNode::SampleBuilderNode(), Layer::clone(), INode::copyNumber(), IParametricComponent::createParameterTree(), IFormFactor::createSlicedFormFactor(), SampleToPython::defineInterferenceFunctions(), INode::displayName(), operator=(), SampleBuilderNode::operator=(), GUIObjectBuilder::populateInstrumentModel(), PyImportAssistant::populateModels(), GUIDomainSampleVisitor::populateSampleModel(), IParametricComponent::registerParameter(), IFormFactor::sliceFormFactor(), and GUIDomainSampleVisitor::visit().

getPolarization()

Eigen::Matrix2cd Beam::getPolarization

(

)

const

Returns the polarization density matrix (in spin basis along z-axis)

Definition at line 127 of file Beam.cpp.

{
    Eigen::Matrix2cd result;
    double x = m_bloch_vector.x();
    double y = m_bloch_vector.y();
    double z = m_bloch_vector.z();
    result(0, 0) = (1.0 + z) / 2.0;
    result(0, 1) = complex_t(x, -y) / 2.0;
    result(1, 0) = complex_t(x, y) / 2.0;
    result(1, 1) = (1.0 - z) / 2.0;
    return result;
}

References m_bloch_vector, BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

Referenced by ISimulation2D::generateSimulationElements().

Here is the call graph for this function:

horizontalBeam()

Beam Beam::horizontalBeam ( )

static

Definition at line 39 of file Beam.cpp.

{
    return Beam(1.0, 1.0, {0, 0});
}

References Beam().

Here is the call graph for this function:

intensity()

double Beam::intensity ( ) const

inline

Returns the beam intensity in neutrons/sec.

Definition at line 42 of file Beam.h.

{ return m_intensity; }

References m_intensity.

Referenced by DepthProbeSimulation::normalize(), ISimulation2D::normalize(), SpecularSimulation::normalize(), TransformFromDomain::setGISASBeamItem(), setIntensity(), TransformFromDomain::setOffSpecularBeamItem(), and TransformFromDomain::setSpecularBeamItem().

onChange()

virtual void IParametricComponent::onChange ( )

inlinevirtualinherited

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

Reimplemented in IProfileRipple, Lattice3D, InterferenceFunction3DLattice, InterferenceFunction2DLattice, 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, and Lattice2D.

Definition at line 59 of file IParametricComponent.h.

{}

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

operator=()

Beam & Beam::operator=

(

const Beam &

other

)

Definition at line 54 of file Beam.cpp.

{
    m_intensity = other.m_intensity;
    m_wavelength = other.m_wavelength;
    // m_direction = other.m_direction;
    m_alpha = other.m_alpha;
    m_phi = other.m_phi;
    m_bloch_vector = other.m_bloch_vector;
    setName(other.getName());
    if (other.m_shape_factor) {
        m_shape_factor.reset(other.m_shape_factor->clone());
        registerChild(m_shape_factor.get());
    } else
        m_shape_factor.release();
    return *this;
}

References IParametricComponent::getName(), m_alpha, m_bloch_vector, m_intensity, m_phi, m_shape_factor, m_wavelength, INode::registerChild(), and IParametricComponent::setName().

Here is the call graph for this function:

parameter()

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

inherited

Returns parameter with given 'name'.

Definition at line 86 of file IParametricComponent.cpp.

{
    return m_pool->parameter(name);
}

References IParametricComponent::m_pool, and RealSpace::Particles::name().

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

Here is the call graph for this function:

parameterPool()

ParameterPool* IParametricComponent::parameterPool ( ) const

inlineinherited

Returns pointer to the parameter pool.

Definition at line 39 of file IParametricComponent.h.

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

References IParametricComponent::m_pool.

Referenced by INode::INode(), IParametricComponent::IParametricComponent(), pyfmt2::argumentList(), SampleBuilderNode::borrow_builder_parameters(), SampleBuilderNode::reset(), and IDistribution1D::setUnits().

parametersToString()

std::string IParametricComponent::parametersToString ( ) const

inherited

Returns multiline string representing available parameters.

Definition at line 43 of file IParametricComponent.cpp.

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

References IParametricComponent::createParameterTree().

Here is the call graph for this function:

parent() [1/2]

INode * INode::parent ( )

inherited

Definition at line 89 of file INode.cpp.

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

References INode::m_parent.

parent() [2/2]

const INode * INode::parent ( ) const

inherited

Definition at line 84 of file INode.cpp.

{
    return m_parent;
}

References INode::m_parent.

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

progeny()

std::vector< const INode * > INode::progeny ( ) const

inherited

Returns a vector of all descendants.

Definition at line 68 of file INode.cpp.

{
    std::vector<const INode*> result;
    result.push_back(this);
    for (const auto* child : getChildren()) {
        for (const auto* p : child->progeny())
            result.push_back(p);
    }
    return result;
}

References INode::getChildren().

Referenced by INode::createParameterTree(), and ParticleDistribution::generateParticles().

Here is the call graph for this function:

registerChild()

void INode::registerChild ( INode *  node )

inherited

Definition at line 57 of file INode.cpp.

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

References ASSERT, and INode::setParent().

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

Here is the call graph for this function:

registerParameter()

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

inherited

Definition at line 51 of file IParametricComponent.cpp.

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

References IParametricComponent::getName(), IParametricComponent::m_pool, RealSpace::Particles::name(), and IParametricComponent::onChange().

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

Here is the call graph for this function:

registerVector()

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

inherited

Definition at line 57 of file IParametricComponent.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 ModelView::Utils::base_name(), IParametricComponent::registerParameter(), RealParameter::setUnit(), IParametricComponent::XComponentName(), IParametricComponent::YComponentName(), and IParametricComponent::ZComponentName().

Referenced by Beam(), DetectionProperties::DetectionProperties(), InterferenceFunctionTwin::InterferenceFunctionTwin(), MultiLayer::MultiLayer(), Lattice3D::initialize(), and IParticle::registerPosition().

Here is the call graph for this function:

removeParameter()

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

inherited

Definition at line 91 of file IParametricComponent.cpp.

{
    m_pool->removeParameter(name);
}

References IParametricComponent::m_pool, and RealSpace::Particles::name().

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

Here is the call graph for this function:

removeVector()

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

inherited

Definition at line 96 of file IParametricComponent.cpp.

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

References ModelView::Utils::base_name(), IParametricComponent::removeParameter(), IParametricComponent::XComponentName(), IParametricComponent::YComponentName(), and IParametricComponent::ZComponentName().

Referenced by IParticle::registerPosition().

Here is the call graph for this function:

setDirection()

void Beam::setDirection

(

const Direction &

direction

)

Definition at line 86 of file Beam.cpp.

{
    if (direction.alpha() < 0.0)
        throw std::runtime_error(
            "Beam::setCentralK() -> Error. Inclination angle alpha_i can't be negative.");
    // m_direction = direction;
    m_alpha = direction.alpha();
    m_phi = direction.phi();
}

References Direction::alpha(), direction(), m_alpha, m_phi, and Direction::phi().

Referenced by Instrument::setBeamParameters().

Here is the call graph for this function:

setFootprintFactor()

void Beam::setFootprintFactor

(

const IFootprintFactor &

shape_factor

)

Sets footprint factor to the beam.

Definition at line 106 of file Beam.cpp.

{
    m_shape_factor.reset(shape_factor.clone());
    registerChild(m_shape_factor.get());
}

References IFootprintFactor::clone(), m_shape_factor, and INode::registerChild().

Referenced by DepthProbeSimulation::setBeamParameters().

Here is the call graph for this function:

setInclination()

void Beam::setInclination

(

const double

alpha

)

Definition at line 96 of file Beam.cpp.

{
    m_alpha = alpha;
}

References m_alpha.

Referenced by OffSpecularSimulation::initSimulationElementVector().

setIntensity()

void Beam::setIntensity ( double  intensity )

inline

Sets the beam intensity in neutrons/sec.

Definition at line 61 of file Beam.h.

{ m_intensity = intensity; }

References intensity(), and m_intensity.

Here is the call graph for this function:

setName()

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

inlineinherited

Definition at line 69 of file IParametricComponent.h.

{ m_name = name; }

References IParametricComponent::m_name, and RealSpace::Particles::name().

Referenced by BasicLattice2D::BasicLattice2D(), Beam(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), Crystal::Crystal(), DetectionProperties::DetectionProperties(), DistributionHandler::DistributionHandler(), FormFactorCoreShell::FormFactorCoreShell(), FormFactorCrystal::FormFactorCrystal(), FormFactorDecoratorMaterial::FormFactorDecoratorMaterial(), FormFactorDecoratorPositionFactor::FormFactorDecoratorPositionFactor(), FormFactorDecoratorRotation::FormFactorDecoratorRotation(), FormFactorWeighted::FormFactorWeighted(), HexagonalLattice2D::HexagonalLattice2D(), IDetector::IDetector(), 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(), Lattice3D::Lattice3D(), Layer::Layer(), LayerInterface::LayerInterface(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), ParticleCoreShell::ParticleCoreShell(), ParticleDistribution::ParticleDistribution(), ParticleLayout::ParticleLayout(), RectangularDetector::RectangularDetector(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), SampleBuilderNode::SampleBuilderNode(), SphericalDetector::SphericalDetector(), SquareLattice2D::SquareLattice2D(), Layer::clone(), LayersWithAbsorptionBuilder::createSampleByIndex(), Basic2DParaCrystalBuilder::createSampleByIndex(), ParticleInVacuumBuilder::createSampleByIndex(), SimpleMagneticRotationBuilder::createSampleByIndex(), DepthProbeSimulation::initialize(), GISASSimulation::initialize(), OffSpecularSimulation::initialize(), SpecularSimulation::initialize(), SpecularDetector1D::initialize(), MesoCrystal::initialize(), Particle::initialize(), ParticleComposition::initialize(), operator=(), SampleBuilderNode::operator=(), SampleBuilderNode::reset(), and SampleBuilderNode::setSBN().

Here is the call graph for this function:

setParameterValue()

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

inherited

Definition at line 65 of file IParametricComponent.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 IParametricComponent::createParameterTree(), IParametricComponent::m_pool, RealSpace::Particles::name(), and ParameterPool::setMatchedParametersValue().

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

Here is the call graph for this function:

setParent()

void INode::setParent ( const INode *  newParent )

virtualinherited

Reimplemented in SampleProvider.

Definition at line 79 of file INode.cpp.

{
    m_parent = newParent;
}

References INode::m_parent.

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

setPolarization()

void Beam::setPolarization

(

const kvector_t

bloch_vector

)

Sets the polarization density matrix according to the given Bloch vector.

Definition at line 112 of file Beam.cpp.

{
    if (bloch_vector.mag() > 1.0) {
        throw std::runtime_error(
            "Beam::setPolarization: "
            "The given Bloch vector cannot represent a real physical ensemble");
    }
    m_bloch_vector = bloch_vector;
}

References m_bloch_vector, and BasicVector3D< T >::mag().

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:

setVectorValue()

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

inherited

Definition at line 78 of file IParametricComponent.cpp.

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

References ModelView::Utils::base_name(), IParametricComponent::setParameterValue(), BasicVector3D< T >::x(), IParametricComponent::XComponentName(), BasicVector3D< T >::y(), IParametricComponent::YComponentName(), BasicVector3D< T >::z(), and IParametricComponent::ZComponentName().

Here is the call graph for this function:

setWavelength()

void Beam::setWavelength

(

double

wavelength

)

Definition at line 78 of file Beam.cpp.

{
    if (wavelength <= 0.0)
        throw std::runtime_error(
            "Beam::setCentralK() -> Error. Wavelength can't be negative or zero.");
    m_wavelength = wavelength;
}

References m_wavelength, and wavelength().

Referenced by Instrument::setBeamParameters().

Here is the call graph for this function:

treeToString()

std::string INode::treeToString ( ) const

virtualinherited

Returns multiline string representing tree structure below the node.

Definition at line 52 of file INode.cpp.

{
    return NodeUtils::nodeToString(this);
}

References NodeUtils::nodeToString().

Here is the call graph for this function:

wavelength()

double Beam::wavelength ( ) const

inline

Definition at line 43 of file Beam.h.

{ return m_wavelength; }

References m_wavelength.

Referenced by DepthProbeSimulation::generateSimulationElements(), ISimulation2D::generateSimulationElements(), RectangularDetector::indexOfSpecular(), TransformFromDomain::setGISASBeamItem(), TransformFromDomain::setOffSpecularBeamItem(), TransformFromDomain::setSpecularBeamItem(), and setWavelength().

XComponentName()

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

staticinherited

Definition at line 103 of file IParametricComponent.cpp.

{
    return base_name + "X";
}

References ModelView::Utils::base_name().

Referenced by Lattice3D::initialize(), IParticle::registerPosition(), IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

YComponentName()

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

staticinherited

Definition at line 108 of file IParametricComponent.cpp.

{
    return base_name + "Y";
}

References ModelView::Utils::base_name().

Referenced by IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

ZComponentName()

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

staticinherited

Definition at line 113 of file IParametricComponent.cpp.

{
    return base_name + "Z";
}

References ModelView::Utils::base_name().

Referenced by IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

Member Data Documentation

m_alpha

double Beam::m_alpha

private

Definition at line 72 of file Beam.h.

Referenced by Beam(), direction(), operator=(), setDirection(), and setInclination().

m_bloch_vector

kvector_t Beam::m_bloch_vector

private

Bloch vector encoding the beam's polarization.

Definition at line 75 of file Beam.h.

Referenced by Beam(), getBlochVector(), getPolarization(), operator=(), and setPolarization().

m_intensity

double Beam::m_intensity

private

beam intensity (neutrons/sec)

Definition at line 69 of file Beam.h.

Referenced by Beam(), intensity(), operator=(), and setIntensity().

m_name

std::string IParametricComponent::m_name

privateinherited

Definition at line 73 of file IParametricComponent.h.

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

m_NP

const size_t INode::m_NP

protectedinherited

Definition at line 88 of file INode.h.

Referenced by INode::INode().

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 89 of file INode.h.

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

m_parent

const INode* INode::m_parent {nullptr}

privateinherited

Definition at line 83 of file INode.h.

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

m_phi

double Beam::m_phi

private

Definition at line 73 of file Beam.h.

Referenced by Beam(), direction(), operator=(), and setDirection().

m_pool

std::unique_ptr<ParameterPool> IParametricComponent::m_pool

privateinherited

parameter pool (kind of pointer-to-implementation)

Definition at line 74 of file IParametricComponent.h.

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

m_shape_factor

std::unique_ptr<IFootprintFactor> Beam::m_shape_factor

private

footprint correction handler

Definition at line 74 of file Beam.h.

Referenced by Beam(), footprintFactor(), getChildren(), operator=(), and setFootprintFactor().

m_wavelength

double Beam::m_wavelength

private

Definition at line 70 of file Beam.h.

Referenced by Beam(), getCentralK(), operator=(), setWavelength(), and wavelength().

---

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

• /home/www/ba/Device/Beam/Beam.h
• /home/www/ba/Device/Beam/Beam.cpp