ICoordSystem Class Reference

Description

Interface to provide axis translations to different units for simulation output.

Child classes are currently declared in

• Device/Detector/CoordSystem2D.h,
• Core/Scan/CoordSystem1D.h.

Definition at line 40 of file ICoordSystem.h.

Inheritance diagram for ICoordSystem:

Collaboration diagram for ICoordSystem:

Public Member Functions
	~ICoordSystem () override
virtual std::vector< Coords >	availableUnits () const =0
std::string	axisName (size_t i_axis, Coords units=Coords::UNDEFINED) const
virtual size_t	axisSize (size_t i_axis) const =0
virtual double	calculateMax (size_t i_axis, Coords units) const =0
virtual double	calculateMin (size_t i_axis, Coords units) const =0
ICoordSystem *	clone () const override=0
std::vector< IAxis * >	convertedAxes (Coords units) const
virtual IAxis *	createConvertedAxis (size_t i_axis, Coords units) const =0
virtual Datafield *	createConvertedData (const Datafield &data, Coords units) const
	Creates Datafield array in converter units. More...
std::vector< IAxis * >	defaultAxes () const
virtual Coords	defaultUnits () const =0
virtual size_t	rank () const =0
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Protected Member Functions
Coords	substituteDefaultUnits (Coords units) const
void	throwUnitsError (std::string method, std::vector< Coords > available) const

Private Member Functions
virtual std::vector< std::map< Coords, std::string > >	createNameMaps () const =0

Constructor & Destructor Documentation

~ICoordSystem()

ICoordSystem::~ICoordSystem ( )

overridedefault

Member Function Documentation

availableUnits()

virtual std::vector<Coords> ICoordSystem::availableUnits ( ) const

pure virtual

Implemented in DepthProbeCoordinates, ImageCoords, SphericalCoords, CoordSystem2D, WavenumberReflectometryCoordinates, and AngularReflectometryCoordinates.

axisName()

std::string ICoordSystem::axisName	(	size_t	i_axis,
		Coords	units = Coords::UNDEFINED
	)		const

Definition at line 36 of file ICoordSystem.cpp.

{
    const auto& name_maps = createNameMaps();
    ASSERT(i_axis < name_maps.size());
    const auto& name_map = name_maps[i_axis];
    const auto& it = name_map.find(units == Coords::UNDEFINED ? defaultUnits() : units);
    ASSERT(it != name_map.cend());
    return it->second;
}

References ASSERT, createNameMaps(), defaultUnits(), and UNDEFINED.

Referenced by CoordSystem1D::createConvertedAxis(), and CoordSystem2D::createConvertedAxis().

Here is the call graph for this function:

axisSize()

virtual size_t ICoordSystem::axisSize ( size_t  i_axis ) const

pure virtual

Implemented in CoordSystem2D, and CoordSystem1D.

calculateMax()

virtual double ICoordSystem::calculateMax ( size_t  i_axis, Coords  units  ) const

pure virtual

Implemented in CoordSystem2D, and CoordSystem1D.

calculateMin()

virtual double ICoordSystem::calculateMin ( size_t  i_axis, Coords  units  ) const

pure virtual

Implemented in CoordSystem2D, and CoordSystem1D.

clone()

ICoordSystem* ICoordSystem::clone ( ) const

overridepure virtual

Implements ICloneable.

Implemented in CoordSystem1D, DepthProbeCoordinates, OffspecCoordinates, ImageCoords, SphericalCoords, WavenumberReflectometryCoordinates, and AngularReflectometryCoordinates.

convertedAxes()

std::vector< IAxis * > ICoordSystem::convertedAxes

(

Coords

units

)

const

Definition at line 28 of file ICoordSystem.cpp.

{
    std::vector<IAxis*> result;
    for (size_t i = 0; i < rank(); ++i)
        result.emplace_back(createConvertedAxis(i, units));
    return result;
}

References createConvertedAxis(), and rank().

Referenced by defaultAxes().

Here is the call graph for this function:

createConvertedAxis()

virtual IAxis* ICoordSystem::createConvertedAxis ( size_t  i_axis, Coords  units  ) const

pure virtual

Implemented in CoordSystem2D, and CoordSystem1D.

Referenced by convertedAxes(), and createConvertedData().

createConvertedData()

Datafield * ICoordSystem::createConvertedData ( const Datafield &  data, Coords  units  ) const

virtual

Creates Datafield array in converter units.

Reimplemented in CoordSystem1D.

Definition at line 46 of file ICoordSystem.cpp.

{
    std::vector<IAxis*> axes;
    for (size_t i = 0; i < rank(); ++i)
        axes.emplace_back(createConvertedAxis(i, units));
 
    Datafield* result = new Datafield(axes);
 
    result->setVector(data.flatVector());
    return result;
}

References createConvertedAxis(), Datafield::flatVector(), rank(), and Datafield::setVector().

Here is the call graph for this function:

createNameMaps()

virtual std::vector<std::map<Coords, std::string> > ICoordSystem::createNameMaps ( ) const

privatepure virtual

Implemented in DepthProbeCoordinates, OffspecCoordinates, ImageCoords, SphericalCoords, WavenumberReflectometryCoordinates, and AngularReflectometryCoordinates.

Referenced by axisName().

defaultAxes()

std::vector< IAxis * > ICoordSystem::defaultAxes

(

)

const

Definition at line 23 of file ICoordSystem.cpp.

{
    return convertedAxes(defaultUnits());
}

References convertedAxes(), and defaultUnits().

Referenced by SimDataPair::execSimulation().

Here is the call graph for this function:

defaultUnits()

virtual Coords ICoordSystem::defaultUnits ( ) const

pure virtual

Implemented in DepthProbeCoordinates, OffspecCoordinates, ImageCoords, SphericalCoords, WavenumberReflectometryCoordinates, and AngularReflectometryCoordinates.

Referenced by axisName(), defaultAxes(), and substituteDefaultUnits().

rank()

virtual size_t ICoordSystem::rank ( ) const

pure virtual

Implemented in CoordSystem2D, and CoordSystem1D.

Referenced by convertedAxes(), and createConvertedData().

substituteDefaultUnits()

Coords ICoordSystem::substituteDefaultUnits ( Coords  units ) const

protected

Definition at line 69 of file ICoordSystem.cpp.

{
    return units == Coords::UNDEFINED ? defaultUnits() : units;
}

References defaultUnits(), and UNDEFINED.

Referenced by CoordSystem1D::calculateMax(), CoordSystem2D::calculateMax(), CoordSystem1D::calculateMin(), CoordSystem2D::calculateMin(), and CoordSystem1D::createConvertedAxis().

Here is the call graph for this function:

throwUnitsError()

void ICoordSystem::throwUnitsError ( std::string  method, std::vector< Coords >  available  ) const

protected

Definition at line 58 of file ICoordSystem.cpp.

{
    std::stringstream ss;
    ss << "Unit type error in " << method
       << ": unknown or unsupported unit type. Available units "
          "are:\n";
    for (auto unit : available)
        ss << axisUnitLabel.at(unit) << "\n";
    throw std::runtime_error(ss.str());
}

References axisUnitLabel.

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

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

Definition at line 32 of file ICloneable.h.

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Coord/ICoordSystem.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Coord/ICoordSystem.cpp