anonymous_namespace{ScanResolution.cpp}::ScanSingleRelativeResolution Class Reference

Inheritance diagram for anonymous_namespace{ScanResolution.cpp}::ScanSingleRelativeResolution:

Collaboration diagram for anonymous_namespace{ScanResolution.cpp}::ScanSingleRelativeResolution:

Public Member Functions
	ScanSingleRelativeResolution (const RangedDistribution &distr, double reldev)
	~ScanSingleRelativeResolution () override=default
ScanResolution *	clone () const override
DistrOutput	generateSamples (double mean, size_t n_times) const override
DistrOutput	generateSamples (const std::vector< double > &mean) const override
std::vector< double >	stdDevs (double mean, size_t n_times) const override
std::vector< double >	stdDevs (const std::vector< double > &mean) const override
const RangedDistribution *	distribution () const
size_t	nSamples () const
bool	empty () const
std::string	print () const
virtual void	transferToCPP ()

Static Public Member Functions
static ScanResolution *	scanRelativeResolution (const RangedDistribution &distr, double stddev)
static ScanResolution *	scanRelativeResolution (const RangedDistribution &distr, const std::vector< double > &stddevs)
static ScanResolution *	scanAbsoluteResolution (const RangedDistribution &distr, double stddev)
static ScanResolution *	scanAbsoluteResolution (const RangedDistribution &distr, const std::vector< double > &stddevs)
static ScanResolution *	scanEmptyResolution ()

Protected Types
using	DistrOutput = std::vector< std::vector< ParameterSample > >

Protected Member Functions
std::string	name () const override
std::string	printStdDevs () const override

Private Attributes
double	m_reldev
std::unique_ptr< RangedDistribution >	m_distr

Detailed Description

Definition at line 27 of file ScanResolution.cpp.

Member Typedef Documentation

DistrOutput

using ScanResolution::DistrOutput = std::vector<std::vector<ParameterSample> >

protectedinherited

Definition at line 31 of file ScanResolution.h.

Constructor & Destructor Documentation

ScanSingleRelativeResolution()

anonymous_namespace{ScanResolution.cpp}::ScanSingleRelativeResolution::ScanSingleRelativeResolution ( const RangedDistribution &  distr, double  reldev  )

inline

Definition at line 30 of file ScanResolution.cpp.

        : ScanResolution(distr), m_reldev(reldev)
    {
    }

~ScanSingleRelativeResolution()

anonymous_namespace{ScanResolution.cpp}::ScanSingleRelativeResolution::~ScanSingleRelativeResolution ( )

overridedefault

Member Function Documentation

clone()

ScanResolution* anonymous_namespace{ScanResolution.cpp}::ScanSingleRelativeResolution::clone ( ) const

inlineoverridevirtual

Implements ScanResolution.

Definition at line 36 of file ScanResolution.cpp.

    {
        return new ScanSingleRelativeResolution(*distribution(), m_reldev);
    }

generateSamples() [1/2]

ScanResolution::DistrOutput anonymous_namespace{ScanResolution.cpp}::ScanSingleRelativeResolution::generateSamples ( double  mean, size_t  n_times  ) const

overridevirtual

Implements ScanResolution.

Definition at line 215 of file ScanResolution.cpp.

{
    const double stddev = mean * m_reldev;
    return DistrOutput(n_times, distribution()->generateSamples(mean, stddev));
}

generateSamples() [2/2]

ScanResolution::DistrOutput anonymous_namespace{ScanResolution.cpp}::ScanSingleRelativeResolution::generateSamples ( const std::vector< double > &  mean ) const

overridevirtual

Implements ScanResolution.

Definition at line 223 of file ScanResolution.cpp.

{
    checkIfEmpty(mean);
    DistrOutput result;
    result.reserve(mean.size());
    for (size_t i = 0, size = mean.size(); i < size; ++i)
        result.push_back(distribution()->generateSamples(mean[i], mean[i] * m_reldev));
    return result;
}

References anonymous_namespace{ScanResolution.cpp}::checkIfEmpty().

Here is the call graph for this function:

stdDevs() [1/2]

std::vector< double > anonymous_namespace{ScanResolution.cpp}::ScanSingleRelativeResolution::stdDevs ( double  mean, size_t  n_times  ) const

overridevirtual

Implements ScanResolution.

Definition at line 233 of file ScanResolution.cpp.

{
    return std::vector<double>(n_times, mean * m_reldev);
}

stdDevs() [2/2]

std::vector< double > anonymous_namespace{ScanResolution.cpp}::ScanSingleRelativeResolution::stdDevs ( const std::vector< double > &  mean ) const

overridevirtual

Implements ScanResolution.

Definition at line 238 of file ScanResolution.cpp.

{
    checkIfEmpty(mean);
    std::vector<double> result;
    result.reserve(mean.size());
    for (size_t i = 0, size = mean.size(); i < size; ++i)
        result.push_back(mean[i] * m_reldev);
    return result;
}

References anonymous_namespace{ScanResolution.cpp}::checkIfEmpty().

Here is the call graph for this function:

name()

std::string anonymous_namespace{ScanResolution.cpp}::ScanSingleRelativeResolution::name ( ) const

inlineoverrideprotectedvirtual

Implements ScanResolution.

Definition at line 47 of file ScanResolution.cpp.

{ return relative_resolution; }

References anonymous_namespace{ScanResolution.cpp}::relative_resolution.

printStdDevs()

std::string anonymous_namespace{ScanResolution.cpp}::ScanSingleRelativeResolution::printStdDevs ( ) const

inlineoverrideprotectedvirtual

Implements ScanResolution.

Definition at line 48 of file ScanResolution.cpp.

{ return pyfmt::printDouble(m_reldev); }

References pyfmt::printDouble().

Here is the call graph for this function:

scanRelativeResolution() [1/2]

ScanResolution * ScanResolution::scanRelativeResolution ( const RangedDistribution &  distr, double  stddev  )

staticinherited

Definition at line 159 of file ScanResolution.cpp.

{
    return new ScanSingleRelativeResolution(distr, stddev);
}

Referenced by AngularSpecScan::setRelativeAngularResolution(), QSpecScan::setRelativeQResolution(), and AngularSpecScan::setRelativeWavelengthResolution().

scanRelativeResolution() [2/2]

ScanResolution * ScanResolution::scanRelativeResolution ( const RangedDistribution &  distr, const std::vector< double > &  stddevs  )

staticinherited

Definition at line 165 of file ScanResolution.cpp.

{
    return new ScanVectorRelativeResolution(distr, stddevs);
}

scanAbsoluteResolution() [1/2]

ScanResolution * ScanResolution::scanAbsoluteResolution ( const RangedDistribution &  distr, double  stddev  )

staticinherited

Definition at line 171 of file ScanResolution.cpp.

{
    return new ScanSingleAbsoluteResolution(distr, stddev);
}

Referenced by AngularSpecScan::setAbsoluteAngularResolution(), QSpecScan::setAbsoluteQResolution(), AngularSpecScan::setAbsoluteWavelengthResolution(), and StandardSimulations::SpecularDivergentBeam().

scanAbsoluteResolution() [2/2]

ScanResolution * ScanResolution::scanAbsoluteResolution ( const RangedDistribution &  distr, const std::vector< double > &  stddevs  )

staticinherited

Definition at line 177 of file ScanResolution.cpp.

{
    return new ScanVectorAbsoluteResolution(distr, stddevs);
}

scanEmptyResolution()

ScanResolution * ScanResolution::scanEmptyResolution ( )

staticinherited

Definition at line 183 of file ScanResolution.cpp.

{
    return new ScanEmptyResolution();
}

distribution()

const RangedDistribution* ScanResolution::distribution ( ) const

inlineinherited

Definition at line 45 of file ScanResolution.h.

{ return m_distr.get(); }

References ScanResolution::m_distr.

nSamples()

size_t ScanResolution::nSamples ( ) const

inherited

Definition at line 188 of file ScanResolution.cpp.

{
    if (m_distr)
        return m_distr->nSamples();
    return 1;
}

References ScanResolution::m_distr.

empty()

bool ScanResolution::empty ( ) const

inlineinherited

Definition at line 52 of file ScanResolution.h.

{ return !m_distr; }

References ScanResolution::m_distr.

print()

std::string ScanResolution::print ( ) const

inherited

Prints object definition in python format.

Definition at line 195 of file ScanResolution.cpp.

{
    std::stringstream result;
    result << *m_distr << "\n";
    result << pyfmt::indent() << "resolution = ";
    result << "ba." << name();
    result << "("
           << "distribution"
           << ", ";
    result << printStdDevs();
    result << ")";
    return result.str();
}

References pyfmt::indent(), ScanResolution::m_distr, ScanResolution::name(), and ScanResolution::printStdDevs().

Referenced by operator<<().

Here is the call graph for this function:

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

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

Definition at line 34 of file ICloneable.h.

Member Data Documentation

m_reldev

double anonymous_namespace{ScanResolution.cpp}::ScanSingleRelativeResolution::m_reldev

private

deltas for computing resolutions

Definition at line 51 of file ScanResolution.cpp.

m_distr

std::unique_ptr<RangedDistribution> ScanResolution::m_distr

privateinherited

basic distribution function

Definition at line 64 of file ScanResolution.h.

Referenced by ScanResolution::distribution(), ScanResolution::empty(), ScanResolution::nSamples(), and ScanResolution::print().

---

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

• /home/www/ba/Device/Resolution/ScanResolution.cpp