PolFilter Class Reference

Description

Detector properties (efficiency, transmission).

Definition at line 27 of file PolFilter.h.

Inheritance diagram for PolFilter:

Collaboration diagram for PolFilter:

Public Member Functions
	PolFilter ()
	PolFilter (R3 direction, double efficiency, double total_transmission)
	~PolFilter () override=default
R3	analyzerDirection () const
	Retrieve the analyzer characteristics. More...
double	analyzerEfficiency () const
	will always return positive value More...
void	checkNodeArgs () const
	Raises exception if a parameter value is invalid. More...
std::string	className () const final
	Returns the class name, to be hard-coded in each leaf class that inherits from INode. More...
SpinMatrix	matrix () const
	Return the polarization density matrix (in spin basis along z-axis) More...
virtual std::vector< const INode * >	nodeChildren () const
	Returns all children. More...
std::vector< const INode * >	nodeOffspring () const
	Returns all descendants. More...
std::vector< ParaMeta >	parDefs () const final
	Returns the parameter definitions, to be hard-coded in each leaf class. More...
double	totalTransmission () const

Protected Attributes
std::vector< double >	m_P

Private Attributes
R3	m_direction
	direction of polarization analysis More...
double	m_efficiency
	efficiency of polarization analysis More...
double	m_total_transmission
	total transmission of polarization analysis More...

Constructor & Destructor Documentation

PolFilter() [1/2]

PolFilter::PolFilter	(	R3	direction,
		double	efficiency,
		double	total_transmission
	)

Definition at line 18 of file PolFilter.cpp.

{
    double aplus = total_transmission * (1.0 + efficiency);
    double amin = total_transmission * (1.0 - efficiency);
    if (aplus < 0.0 || aplus > 1.0 || amin < 0.0 || amin > 1.0)
        throw std::runtime_error("Invalid efficiency and transmission for polarization analyzer");
    if (efficiency == 0.0 || total_transmission == 0.0 || direction.mag() == 0.0) {
        m_direction = {};
        m_efficiency = 0;
        m_total_transmission = total_transmission;
    } else {
        m_direction = direction.unit();
        m_efficiency = efficiency;
        m_total_transmission = total_transmission;
    }
}

References m_direction, m_efficiency, and m_total_transmission.

PolFilter() [2/2]

PolFilter::PolFilter

(

)

Definition at line 35 of file PolFilter.cpp.

    : PolFilter({}, 0.0, 1.0)
{
}

~PolFilter()

PolFilter::~PolFilter ( )

overridedefault

Member Function Documentation

analyzerDirection()

R3 PolFilter::analyzerDirection

(

)

const

Retrieve the analyzer characteristics.

Definition at line 48 of file PolFilter.cpp.

{
    return m_direction;
}

References m_direction.

Referenced by ISimulation2D::force_polarized().

analyzerEfficiency()

double PolFilter::analyzerEfficiency

(

)

const

will always return positive value

Definition at line 53 of file PolFilter.cpp.

{
    return m_efficiency;
}

References m_efficiency.

checkNodeArgs()

void INode::checkNodeArgs ( ) const

inherited

Raises exception if a parameter value is invalid.

Definition at line 27 of file INode.cpp.

{
    size_t nP = m_P.size();
    if (parDefs().size() != nP) {
        std::cerr << "BUG in class " << className() << std::endl;
        std::cerr << "#m_P = " << nP << std::endl;
        std::cerr << "#PDf = " << parDefs().size() << std::endl;
        for (const ParaMeta& pm : parDefs())
            std::cerr << "  PDf: " << pm.name << std::endl;
        ASSERT(0);
    }
    ASSERT(parDefs().size() == nP);
    for (size_t i = 0; i < nP; ++i) {
        const ParaMeta pm = parDefs()[i];
 
        RealLimits limits = RealLimits::limitless();
        if (pm.vMin == -INF) {
            ASSERT(pm.vMax == +INF);
            // nothing to do
        } else if (pm.vMax == +INF) {
            ASSERT(pm.vMin == 0);
            limits = RealLimits::nonnegative();
        } else {
            limits = RealLimits::limited(pm.vMin, pm.vMax);
        }
        limits.check(pm.name, m_P[i]);
    }
}

References ASSERT, RealLimits::check(), INode::className(), INF, RealLimits::limited(), RealLimits::limitless(), INode::m_P, ParaMeta::name, RealLimits::nonnegative(), INode::parDefs(), ParaMeta::vMax, and ParaMeta::vMin.

Referenced by BarGauss::BarGauss(), BarLorentz::BarLorentz(), Bipyramid4::Bipyramid4(), Box::Box(), CantellatedCube::CantellatedCube(), Cone::Cone(), ConstantBackground::ConstantBackground(), CosineRippleBox::CosineRippleBox(), CosineRippleGauss::CosineRippleGauss(), CosineRippleLorentz::CosineRippleLorentz(), Cylinder::Cylinder(), DistributionCosine::DistributionCosine(), DistributionGate::DistributionGate(), DistributionGaussian::DistributionGaussian(), DistributionLogNormal::DistributionLogNormal(), DistributionLorentz::DistributionLorentz(), DistributionTrapezoid::DistributionTrapezoid(), Dodecahedron::Dodecahedron(), EllipsoidalCylinder::EllipsoidalCylinder(), FootprintGauss::FootprintGauss(), FootprintSquare::FootprintSquare(), FuzzySphere::FuzzySphere(), GaussSphere::GaussSphere(), HemiEllipsoid::HemiEllipsoid(), HollowSphere::HollowSphere(), HorizontalCylinder::HorizontalCylinder(), Icosahedron::Icosahedron(), LongBoxGauss::LongBoxGauss(), LongBoxLorentz::LongBoxLorentz(), PlatonicOctahedron::PlatonicOctahedron(), PlatonicTetrahedron::PlatonicTetrahedron(), Prism3::Prism3(), Prism6::Prism6(), Profile1DCauchy::Profile1DCauchy(), Profile1DCosine::Profile1DCosine(), Profile1DGate::Profile1DGate(), Profile1DGauss::Profile1DGauss(), Profile1DTriangle::Profile1DTriangle(), Profile1DVoigt::Profile1DVoigt(), Profile2DCauchy::Profile2DCauchy(), Profile2DCone::Profile2DCone(), Profile2DGate::Profile2DGate(), Profile2DGauss::Profile2DGauss(), Profile2DVoigt::Profile2DVoigt(), Pyramid2::Pyramid2(), Pyramid3::Pyramid3(), Pyramid4::Pyramid4(), Pyramid6::Pyramid6(), RotationEuler::RotationEuler(), RotationX::RotationX(), RotationY::RotationY(), RotationZ::RotationZ(), SawtoothRippleBox::SawtoothRippleBox(), SawtoothRippleGauss::SawtoothRippleGauss(), SawtoothRippleLorentz::SawtoothRippleLorentz(), Sphere::Sphere(), Spheroid::Spheroid(), TruncatedCube::TruncatedCube(), TruncatedSphere::TruncatedSphere(), and TruncatedSpheroid::TruncatedSpheroid().

Here is the call graph for this function:

className()

std::string PolFilter::className ( ) const

inlinefinalvirtual

Returns the class name, to be hard-coded in each leaf class that inherits from INode.

Implements INode.

Definition at line 33 of file PolFilter.h.

{ return "PolFilter"; }

matrix()

SpinMatrix PolFilter::matrix

(

)

const

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

Definition at line 40 of file PolFilter.cpp.

{
    if (m_direction.mag() == 0.0 || m_efficiency == 0.0)
        return m_total_transmission * SpinMatrix::One();
    R3 v = m_direction.unit() * m_efficiency;
    return 2 * m_total_transmission * SpinMatrix::FromBlochVector(v);
}

References SpinMatrix::FromBlochVector(), m_direction, m_efficiency, m_total_transmission, and SpinMatrix::One().

Referenced by ISimulation2D::generateElements(), and DetectorContext::setup_context().

Here is the call graph for this function:

nodeChildren()

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

virtualinherited

Returns all children.

Reimplemented in ISimulation2D, ISimulation, ParticleCoreShell, ParticleComposition, Particle, MesoCrystal, IParticle, Crystal, MultiLayer, Layer, LayerInterface, ParticleLayout, InterferenceRadialParaCrystal, InterferenceFinite3DLattice, InterferenceFinite2DLattice, Interference3DLattice, Interference2DSuperLattice, Interference2DParaCrystal, Interference2DLattice, Interference1DLattice, ConvolutionDetectorResolution, IDetector, and Beam.

Definition at line 56 of file INode.cpp.

{
    return {};
}

Referenced by NodeUtils::AllDescendantsOfType(), NodeUtils::ChildNodesOfType(), ISampleNode::containedMaterials(), and INode::nodeOffspring().

nodeOffspring()

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

inherited

Returns all descendants.

Definition at line 61 of file INode.cpp.

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

References INode::nodeChildren().

Here is the call graph for this function:

parDefs()

std::vector<ParaMeta> PolFilter::parDefs ( ) const

inlinefinalvirtual

Returns the parameter definitions, to be hard-coded in each leaf class.

Reimplemented from INode.

Definition at line 34 of file PolFilter.h.

    {
        return {{"Efficiency", "", "efficiency", 0, 1, 1},
                {"Transmission", "", "total transmission", 0, 1, 1}};
    }

totalTransmission()

double PolFilter::totalTransmission

(

)

const

Definition at line 58 of file PolFilter.cpp.

{
    return m_total_transmission;
}

References m_total_transmission.

Member Data Documentation

m_direction

R3 PolFilter::m_direction

private

direction of polarization analysis

Definition at line 49 of file PolFilter.h.

Referenced by PolFilter(), analyzerDirection(), and matrix().

m_efficiency

double PolFilter::m_efficiency

private

efficiency of polarization analysis

Definition at line 50 of file PolFilter.h.

Referenced by PolFilter(), analyzerEfficiency(), and matrix().

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 63 of file INode.h.

Referenced by IFootprintFactor::IFootprintFactor(), INode::checkNodeArgs(), IProfile1D::pythonConstructor(), IProfile2D::pythonConstructor(), IFormFactor::pythonConstructor(), Profile1DVoigt::pythonConstructor(), and Profile2DVoigt::pythonConstructor().

m_total_transmission

double PolFilter::m_total_transmission

private

total transmission of polarization analysis

Definition at line 51 of file PolFilter.h.

Referenced by PolFilter(), matrix(), and totalTransmission().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Pol/PolFilter.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Pol/PolFilter.cpp