ISpecularScan Class Reference

Abstract base class for all types of specular scans. More...

Inheritance diagram for ISpecularScan:

Collaboration diagram for ISpecularScan:

Public Member Functions
ISpecularScan *	clone () const override=0
virtual const IAxis *	coordinateAxis () const =0
	Returns coordinate axis assigned to the data holder. More...
virtual std::vector< double >	createIntensities (const std::vector< SpecularSimulationElement > &sim_elements) const =0
	Returns intensity vector corresponding to convolution of given simulation elements. More...
virtual std::vector< double >	footprint (size_t i, size_t n_elements) const =0
	Returns footprint correction factor for a range of simulation elements of size n_elements and starting from element with index i. More...
virtual const IFootprintFactor *	footprintFactor () const =0
	Returns IFootprintFactor object pointer. More...
virtual std::vector< SpecularSimulationElement >	generateSimulationElements (const Instrument &instrument) const =0
	Generates simulation elements for specular simulations. More...
virtual size_t	numberOfSimulationElements () const =0
	Returns the number of simulation elements. More...
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Detailed Description

Abstract base class for all types of specular scans.

Definition at line 32 of file ISpecularScan.h.

Member Function Documentation

clone()

ISpecularScan* ISpecularScan::clone ( ) const

overridepure virtual

Implements ICloneable.

Implemented in QSpecScan, and AngularSpecScan.

Referenced by SpecularSimulation::setScan().

coordinateAxis()

virtual const IAxis* ISpecularScan::coordinateAxis ( ) const

pure virtual

Returns coordinate axis assigned to the data holder.

Implemented in QSpecScan, and AngularSpecScan.

Referenced by SpecularSimulation::setScan().

createIntensities()

virtual std::vector<double> ISpecularScan::createIntensities ( const std::vector< SpecularSimulationElement > &  sim_elements ) const

pure virtual

Returns intensity vector corresponding to convolution of given simulation elements.

Implemented in QSpecScan, and AngularSpecScan.

footprint()

virtual std::vector<double> ISpecularScan::footprint ( size_t  i, size_t  n_elements  ) const

pure virtual

Returns footprint correction factor for a range of simulation elements of size n_elements and starting from element with index i.

Implemented in QSpecScan, and AngularSpecScan.

footprintFactor()

virtual const IFootprintFactor* ISpecularScan::footprintFactor ( ) const

pure virtual

Returns IFootprintFactor object pointer.

Implemented in QSpecScan, and AngularSpecScan.

generateSimulationElements()

virtual std::vector<SpecularSimulationElement> ISpecularScan::generateSimulationElements ( const Instrument &  instrument ) const

pure virtual

Generates simulation elements for specular simulations.

Implemented in QSpecScan, and AngularSpecScan.

numberOfSimulationElements()

virtual size_t ISpecularScan::numberOfSimulationElements ( ) const

pure virtual

Returns the number of simulation elements.

Implemented in QSpecScan, and AngularSpecScan.

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

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

Definition at line 34 of file ICloneable.h.

---

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

• /home/www/ba/Core/Scan/ISpecularScan.h