ScanResolution Class Reference

Description

Container for reflectivity resolution data.

Definition at line 28 of file ScanResolution.h.

Inheritance diagram for ScanResolution:

Collaboration diagram for ScanResolution:

Public Member Functions
	~ScanResolution () override
ScanResolution *	clone () const override=0
virtual double	delta () const =0
const IRangedDistribution *	distribution () const
bool	empty () const
virtual DistrOutput	generateSamples (const std::vector< double > &mean) const =0
virtual DistrOutput	generateSamples (double mean, size_t n_times) const =0
virtual std::string	name () const =0
size_t	nSamples () const
virtual std::vector< double >	stdDevs (const std::vector< double > &mean) const =0
virtual std::vector< double >	stdDevs (double mean, size_t n_times) const =0
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

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

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

Protected Member Functions
	ScanResolution ()
	ScanResolution (const IRangedDistribution &distr)

Private Attributes
std::unique_ptr< IRangedDistribution >	m_distr
	basic distribution function More...

Member Typedef Documentation

DistrOutput

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

protected

Definition at line 30 of file ScanResolution.h.

Constructor & Destructor Documentation

~ScanResolution()

ScanResolution::~ScanResolution ( )

overridedefault

ScanResolution() [1/2]

ScanResolution::ScanResolution ( )

protecteddefault

ScanResolution() [2/2]

ScanResolution::ScanResolution ( const IRangedDistribution &  distr )

protected

Definition at line 202 of file ScanResolution.cpp.

    : m_distr(distr.clone())
{
}

Member Function Documentation

clone()

ScanResolution* ScanResolution::clone ( ) const

overridepure virtual

Implements ICloneable.

Referenced by AlphaScan::setAngleResolution(), QzScan::setQResolution(), and AlphaScan::setWavelengthResolution().

delta()

virtual double ScanResolution::delta ( ) const

pure virtual

distribution()

const IRangedDistribution* ScanResolution::distribution ( ) const

inline

Definition at line 44 of file ScanResolution.h.

{ return m_distr.get(); }

References m_distr.

empty()

bool ScanResolution::empty ( ) const

inline

Definition at line 51 of file ScanResolution.h.

{ return !m_distr; }

References m_distr.

generateSamples() [1/2]

virtual DistrOutput ScanResolution::generateSamples ( const std::vector< double > &  mean ) const

pure virtual

generateSamples() [2/2]

virtual DistrOutput ScanResolution::generateSamples ( double  mean, size_t  n_times  ) const

pure virtual

name()

virtual std::string ScanResolution::name ( ) const

pure virtual

nSamples()

size_t ScanResolution::nSamples

(

)

const

Definition at line 193 of file ScanResolution.cpp.

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

References m_distr.

scanAbsoluteResolution() [1/2]

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

static

Definition at line 182 of file ScanResolution.cpp.

{
    return new ScanVectorAbsoluteResolution(distr, stddevs);
}

scanAbsoluteResolution() [2/2]

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

static

Definition at line 176 of file ScanResolution.cpp.

{
    return new ScanSingleAbsoluteResolution(distr, stddev);
}

Referenced by AlphaScan::setAbsoluteAngularResolution(), QzScan::setAbsoluteQResolution(), and AlphaScan::setAbsoluteWavelengthResolution().

scanEmptyResolution()

ScanResolution * ScanResolution::scanEmptyResolution ( )

static

Definition at line 188 of file ScanResolution.cpp.

{
    return new ScanEmptyResolution();
}

scanRelativeResolution() [1/2]

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

static

Definition at line 170 of file ScanResolution.cpp.

{
    return new ScanVectorRelativeResolution(distr, stddevs);
}

scanRelativeResolution() [2/2]

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

static

Definition at line 164 of file ScanResolution.cpp.

{
    return new ScanSingleRelativeResolution(distr, stddev);
}

Referenced by AlphaScan::setRelativeAngularResolution(), QzScan::setRelativeQResolution(), and AlphaScan::setRelativeWavelengthResolution().

stdDevs() [1/2]

virtual std::vector<double> ScanResolution::stdDevs ( const std::vector< double > &  mean ) const

pure virtual

stdDevs() [2/2]

virtual std::vector<double> ScanResolution::stdDevs ( double  mean, size_t  n_times  ) const

pure virtual

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

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

Definition at line 32 of file ICloneable.h.

Member Data Documentation

m_distr

std::unique_ptr<IRangedDistribution> ScanResolution::m_distr

private

basic distribution function

Definition at line 62 of file ScanResolution.h.

Referenced by distribution(), empty(), and nSamples().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Scan/ScanResolution.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Scan/ScanResolution.cpp