CoordSystem2D Class Reference

Description

Interface for objects that provide axis translations to different units for IDetector objects.

Definition at line 32 of file CoordSystem2D.h.

Inheritance diagram for CoordSystem2D:

Collaboration diagram for CoordSystem2D:

Public Member Functions
	CoordSystem2D (const Direction &direction, double wavelength=0)
	CoordSystem2D (const OwningVector< IAxis > &axes, const Direction &direction, double wavelength=0)
	~CoordSystem2D () override=default
std::vector< Coords >	availableUnits () const override
	Returns list of units that are available for all 2D detectors. Further units may be added by child classes. More...
std::string	axisName (size_t i_axis, Coords units=Coords::UNDEFINED) const
size_t	axisSize (size_t i_axis) const override
double	calculateMax (size_t i_axis, Coords units) const override
double	calculateMin (size_t i_axis, Coords units) const override
ICoordSystem *	clone () const override=0
std::vector< IAxis * >	convertedAxes (Coords units) const
IAxis *	createConvertedAxis (size_t i_axis, Coords units) const override
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
size_t	rank () const override
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Protected Member Functions
	CoordSystem2D (const CoordSystem2D &other)
void	addAxisData (std::string name, double min, double max, size_t nbins)
Coords	substituteDefaultUnits (Coords units) const
void	throwUnitsError (std::string method, std::vector< Coords > available) const

Protected Attributes
double	m_alpha_i
OwningVector< IAxis >	m_axes
double	m_phi_i
double	m_wavelength

Private Member Functions
virtual double	calculateValue (size_t i_axis, Coords units, double value) const =0
virtual std::vector< std::map< Coords, std::string > >	createNameMaps () const =0

Constructor & Destructor Documentation

CoordSystem2D() [1/3]

CoordSystem2D::CoordSystem2D	(	const Direction &	direction,
		double	wavelength = 0
	)

Definition at line 48 of file CoordSystem2D.cpp.

    : CoordSystem2D({}, direction, wavelength)
{
}

CoordSystem2D() [2/3]

CoordSystem2D::CoordSystem2D	(	const OwningVector< IAxis > &	axes,
		const Direction &	direction,
		double	wavelength = 0
	)

Definition at line 53 of file CoordSystem2D.cpp.

    : m_axes(axes)
    , m_wavelength(wavelength)
    , m_alpha_i(-direction.alpha())
    , m_phi_i(direction.phi())
{
}

~CoordSystem2D()

CoordSystem2D::~CoordSystem2D ( )

overridedefault

CoordSystem2D() [3/3]

CoordSystem2D::CoordSystem2D ( const CoordSystem2D &  other )

protected

Definition at line 62 of file CoordSystem2D.cpp.

    : m_axes(other.m_axes)
    , m_wavelength(other.m_wavelength)
    , m_alpha_i(other.m_alpha_i)
    , m_phi_i(other.m_phi_i)
{
}

Member Function Documentation

addAxisData()

void CoordSystem2D::addAxisData ( std::string  name, double  min, double  max, size_t  nbins  )

protected

Definition at line 70 of file CoordSystem2D.cpp.

{
    m_axes.emplace_back(new FixedBinAxis(name, min, max, nbins));
}

References OwningVector< T >::emplace_back(), and m_axes.

Here is the call graph for this function:

availableUnits()

std::vector< Coords > CoordSystem2D::availableUnits ( ) const

overridevirtual

Returns list of units that are available for all 2D detectors. Further units may be added by child classes.

Implements ICoordSystem.

Reimplemented in DepthProbeCoordinates, ImageCoords, and SphericalCoords.

Definition at line 99 of file CoordSystem2D.cpp.

{
    return {Coords::NBINS, Coords::RADIANS, Coords::DEGREES};
}

References DEGREES, NBINS, and RADIANS.

Referenced by SphericalCoords::availableUnits(), ImageCoords::availableUnits(), and DepthProbeCoordinates::availableUnits().

axisName()

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

inherited

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, ICoordSystem::createNameMaps(), ICoordSystem::defaultUnits(), and UNDEFINED.

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

Here is the call graph for this function:

axisSize()

size_t CoordSystem2D::axisSize ( size_t  i_axis ) const

overridevirtual

Implements ICoordSystem.

Definition at line 93 of file CoordSystem2D.cpp.

{
    ASSERT(i_axis < rank());
    return m_axes[i_axis]->size();
}

References ASSERT, m_axes, rank(), and OwningVector< T >::size().

Referenced by createConvertedAxis().

Here is the call graph for this function:

calculateMax()

double CoordSystem2D::calculateMax ( size_t  i_axis, Coords  units  ) const

overridevirtual

Implements ICoordSystem.

Definition at line 84 of file CoordSystem2D.cpp.

{
    ASSERT(i_axis < rank());
    units = substituteDefaultUnits(units);
    if (units == Coords::NBINS)
        return m_axes[i_axis]->size();
    return calculateValue(i_axis, units, m_axes[i_axis]->max());
}

References ASSERT, calculateValue(), m_axes, NBINS, rank(), OwningVector< T >::size(), and ICoordSystem::substituteDefaultUnits().

Referenced by createConvertedAxis().

Here is the call graph for this function:

calculateMin()

double CoordSystem2D::calculateMin ( size_t  i_axis, Coords  units  ) const

overridevirtual

Implements ICoordSystem.

Definition at line 75 of file CoordSystem2D.cpp.

{
    ASSERT(i_axis < rank());
    units = substituteDefaultUnits(units);
    if (units == Coords::NBINS)
        return 0.0;
    return calculateValue(i_axis, units, m_axes[i_axis]->min());
}

References ASSERT, calculateValue(), m_axes, NBINS, rank(), and ICoordSystem::substituteDefaultUnits().

Referenced by createConvertedAxis().

Here is the call graph for this function:

calculateValue()

virtual double CoordSystem2D::calculateValue ( size_t  i_axis, Coords  units, double  value  ) const

privatepure virtual

Implemented in DepthProbeCoordinates, OffspecCoordinates, ImageCoords, and SphericalCoords.

Referenced by calculateMax(), and calculateMin().

clone()

ICoordSystem* ICoordSystem::clone ( ) const

overridepure virtualinherited

Implements ICloneable.

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

convertedAxes()

std::vector< IAxis * > ICoordSystem::convertedAxes ( Coords  units ) const

inherited

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 ICoordSystem::createConvertedAxis(), and ICoordSystem::rank().

Referenced by ICoordSystem::defaultAxes().

Here is the call graph for this function:

createConvertedAxis()

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

overridevirtual

Implements ICoordSystem.

Definition at line 104 of file CoordSystem2D.cpp.

{
    const double min = calculateMin(i_axis, units);
    const double max = calculateMax(i_axis, units);
    const auto& axis_name = axisName(i_axis, units);
    const auto axis_size = axisSize(i_axis);
    return new FixedBinAxis(axis_name, axis_size, min, max);
}

References ICoordSystem::axisName(), axisSize(), calculateMax(), and calculateMin().

Here is the call graph for this function:

createConvertedData()

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

virtualinherited

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 ICoordSystem::createConvertedAxis(), Datafield::flatVector(), ICoordSystem::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 virtualinherited

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

Referenced by ICoordSystem::axisName().

defaultAxes()

std::vector< IAxis * > ICoordSystem::defaultAxes ( ) const

inherited

Definition at line 23 of file ICoordSystem.cpp.

{
    return convertedAxes(defaultUnits());
}

References ICoordSystem::convertedAxes(), and ICoordSystem::defaultUnits().

Referenced by SimDataPair::execSimulation().

Here is the call graph for this function:

defaultUnits()

virtual Coords ICoordSystem::defaultUnits ( ) const

pure virtualinherited

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

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

rank()

size_t CoordSystem2D::rank ( ) const

inlineoverridevirtual

Implements ICoordSystem.

Definition at line 39 of file CoordSystem2D.h.

{ return m_axes.size(); }

References m_axes, and OwningVector< T >::size().

Referenced by axisSize(), calculateMax(), and calculateMin().

Here is the call graph for this function:

substituteDefaultUnits()

Coords ICoordSystem::substituteDefaultUnits ( Coords  units ) const

protectedinherited

Definition at line 69 of file ICoordSystem.cpp.

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

References ICoordSystem::defaultUnits(), and UNDEFINED.

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

Here is the call graph for this function:

throwUnitsError()

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

protectedinherited

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.

Member Data Documentation

m_alpha_i

double CoordSystem2D::m_alpha_i

protected

Definition at line 58 of file CoordSystem2D.h.

Referenced by SphericalCoords::calculateValue(), and ImageCoords::calculateValue().

m_axes

OwningVector<IAxis> CoordSystem2D::m_axes

protected

Definition at line 56 of file CoordSystem2D.h.

Referenced by addAxisData(), axisSize(), calculateMax(), calculateMin(), ImageCoords::calculateValue(), and rank().

m_phi_i

double CoordSystem2D::m_phi_i

protected

Definition at line 59 of file CoordSystem2D.h.

Referenced by SphericalCoords::calculateValue(), and ImageCoords::calculateValue().

m_wavelength

double CoordSystem2D::m_wavelength

protected

Definition at line 57 of file CoordSystem2D.h.

Referenced by SphericalCoords::calculateValue(), ImageCoords::calculateValue(), and DepthProbeCoordinates::calculateValue().

---

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

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