anonymous_namespace{ScanResolution.cpp}::ScanEmptyResolution Class Reference

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

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

Public Member Functions
	ScanEmptyResolution ()
	~ScanEmptyResolution () 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
std::unique_ptr< RangedDistribution >	m_distr

Detailed Description

Definition at line 137 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

ScanEmptyResolution()

anonymous_namespace{ScanResolution.cpp}::ScanEmptyResolution::ScanEmptyResolution ( )

inline

Definition at line 140 of file ScanResolution.cpp.

: ScanResolution() {}

~ScanEmptyResolution()

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

overridedefault

Member Function Documentation

clone()

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

inlineoverridevirtual

Implements ScanResolution.

Definition at line 144 of file ScanResolution.cpp.

{ return new ScanEmptyResolution(); }

generateSamples() [1/2]

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

overridevirtual

Implements ScanResolution.

Definition at line 340 of file ScanResolution.cpp.

{
    return DistrOutput(n_times, std::vector<ParameterSample>{ParameterSample(mean, 1.)});
}

generateSamples() [2/2]

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

overridevirtual

Implements ScanResolution.

Definition at line 347 of file ScanResolution.cpp.

{
    DistrOutput result;
    result.reserve(mean.size());
    for (size_t i = 0, size = mean.size(); i < size; ++i)
        result.push_back({ParameterSample(mean[i], 1.0)});
    return result;
}

stdDevs() [1/2]

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

overridevirtual

Implements ScanResolution.

Definition at line 356 of file ScanResolution.cpp.

{
    return std::vector<double>(n_times, 0.0);
}

stdDevs() [2/2]

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

overridevirtual

Implements ScanResolution.

Definition at line 361 of file ScanResolution.cpp.

{
    return std::vector<double>(mean.size(), 0.0);
}

name()

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

overrideprotectedvirtual

Implements ScanResolution.

Definition at line 366 of file ScanResolution.cpp.

{
    throw std::runtime_error(
        "Error in ScanEmptyResolution::name: attempt to get a name of an empty resolution object.");
}

printStdDevs()

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

overrideprotectedvirtual

Implements ScanResolution.

Definition at line 372 of file ScanResolution.cpp.

{
    throw std::runtime_error("Error in ScanEmptyResolution::printStdDevs: attempt to print data "
                             "from empty resolution object.");
}

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_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