CoordSystem1D Class Reference

Description

Abstract base class to support coordinate transforms and axis labels for 1D scans. Inherited by AngularReflectometryCoordinates and WavenumberReflectometryCoordinates.

Definition at line 33 of file CoordSystem1D.h.

Inheritance diagram for CoordSystem1D:

Collaboration diagram for CoordSystem1D:

Public Member Functions
	CoordSystem1D (const IAxis *&&axis)
	Takes ownership of axis. More...
	~CoordSystem1D () override=default
virtual std::vector< Coords >	availableUnits () const =0
std::string	axisName (size_t i_axis, Coords units=Coords::UNDEFINED) const
size_t	axisSize (size_t i_axis) const override
	Returns the size of underlying axis. More...
double	calculateMax (size_t i_axis, Coords units) const override
	Calculates maximum on-axis value in given units. More...
double	calculateMin (size_t i_axis, Coords units) const override
	Calculates minimum on-axis value in given units. More...
CoordSystem1D *	clone () const override=0
std::vector< IAxis * >	convertedAxes (Coords units) const
IAxis *	createConvertedAxis (size_t i_axis, Coords units) const override
	Creates axis in converted units. More...
Datafield *	createConvertedData (const Datafield &data, Coords units) const override
	Creates Datafield array in converter units. More...
std::vector< IAxis * >	defaultAxes () const
virtual Coords	defaultUnits () const =0
size_t	rank () const override
	Returns dimensionality of converted canvas. More...
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Protected Member Functions
const IAxis *	coordinateAxis () const
virtual std::function< double(double)>	getTraslatorTo (Coords units) const =0
	Returns translating functional (rads --> output units) More...
Coords	substituteDefaultUnits (Coords units) const
void	throwUnitsError (std::string method, std::vector< Coords > available) const

Protected Attributes
std::unique_ptr< const IAxis >	m_axis
	semantics depends on subclass More...

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

Constructor & Destructor Documentation

CoordSystem1D()

CoordSystem1D::CoordSystem1D

(

const IAxis *&&

axis

)

Takes ownership of axis.

Definition at line 77 of file CoordSystem1D.cpp.

    : m_axis(axis)
{
}

~CoordSystem1D()

CoordSystem1D::~CoordSystem1D ( )

overridedefault

Member Function Documentation

availableUnits()

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

pure virtualinherited

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

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

Here is the call graph for this function:

axisSize()

size_t CoordSystem1D::axisSize ( size_t  i_axis ) const

overridevirtual

Returns the size of underlying axis.

Implements ICoordSystem.

Definition at line 83 of file CoordSystem1D.cpp.

{
    ASSERT(i_axis == 0);
    return coordinateAxis()->size();
}

References ASSERT, coordinateAxis(), and IAxis::size().

Here is the call graph for this function:

calculateMax()

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

overridevirtual

Calculates maximum on-axis value in given units.

Implements ICoordSystem.

Definition at line 99 of file CoordSystem1D.cpp.

{
    ASSERT(i_axis == 0);
    units = substituteDefaultUnits(units);
    const IAxis* const coordinate_axis = coordinateAxis();
    if (units == Coords::NBINS)
        return static_cast<double>(coordinate_axis->size());
    auto translator = getTraslatorTo(units);
    return translator(coordinate_axis->binCenter(coordinate_axis->size() - 1));
}

References ASSERT, IAxis::binCenter(), coordinateAxis(), getTraslatorTo(), NBINS, IAxis::size(), and ICoordSystem::substituteDefaultUnits().

Referenced by createConvertedAxis().

Here is the call graph for this function:

calculateMin()

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

overridevirtual

Calculates minimum on-axis value in given units.

Implements ICoordSystem.

Definition at line 89 of file CoordSystem1D.cpp.

{
    ASSERT(i_axis == 0);
    units = substituteDefaultUnits(units);
    if (units == Coords::NBINS)
        return 0.0;
    auto translator = getTraslatorTo(units);
    return translator(coordinateAxis()->binCenter(0));
}

References ASSERT, coordinateAxis(), getTraslatorTo(), NBINS, and ICoordSystem::substituteDefaultUnits().

Referenced by createConvertedAxis().

Here is the call graph for this function:

clone()

CoordSystem1D* CoordSystem1D::clone ( ) const

overridepure virtual

Implements ICoordSystem.

Implemented in 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:

coordinateAxis()

const IAxis* CoordSystem1D::coordinateAxis ( ) const

inlineprotected

Definition at line 62 of file CoordSystem1D.h.

{ return m_axis.get(); }

References m_axis.

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

createConvertedAxis()

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

overridevirtual

Creates axis in converted units.

Implements ICoordSystem.

Definition at line 110 of file CoordSystem1D.cpp.

{
    ASSERT(i_axis == 0);
    units = substituteDefaultUnits(units);
    if (units == Coords::NBINS)
        return new FixedBinAxis(axisName(0, units), coordinateAxis()->size(),
                                calculateMin(0, units), calculateMax(0, units));
 
    std::function<double(double)> translator = getTraslatorTo(units);
    auto coords = coordinateAxis()->binCenters();
    for (size_t i = 0, size = coords.size(); i < size; ++i)
        coords[i] = translator(coords[i]);
    return new PointwiseAxis(axisName(0, units), coords);
}

References ASSERT, ICoordSystem::axisName(), IAxis::binCenters(), calculateMax(), calculateMin(), coordinateAxis(), getTraslatorTo(), NBINS, and ICoordSystem::substituteDefaultUnits().

Referenced by createConvertedData().

Here is the call graph for this function:

createConvertedData()

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

overridevirtual

Creates Datafield array in converter units.

Reimplemented from ICoordSystem.

Definition at line 125 of file CoordSystem1D.cpp.

{
    ASSERT(data.rank() == 1);
 
    auto q_axis = createConvertedAxis(0, units);
    Datafield* result = new Datafield({q_axis});
 
    if (units != Coords::RQ4) {
        result->setVector(data.flatVector());
        return result;
    }
 
    for (size_t i = 0, size = result->size(); i < size; ++i)
        (*result)[i] = data[i] * std::pow((*q_axis)[i], 4);
    return result;
}

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

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().

getTraslatorTo()

virtual std::function<double(double)> CoordSystem1D::getTraslatorTo ( Coords  units ) const

protectedpure virtual

Returns translating functional (rads --> output units)

Implemented in WavenumberReflectometryCoordinates, and AngularReflectometryCoordinates.

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

rank()

size_t CoordSystem1D::rank ( ) const

inlineoverridevirtual

Returns dimensionality of converted canvas.

Implements ICoordSystem.

Definition at line 41 of file CoordSystem1D.h.

{ return 1u; }

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 calculateMax(), CoordSystem2D::calculateMax(), calculateMin(), CoordSystem2D::calculateMin(), and 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_axis

std::unique_ptr<const IAxis> CoordSystem1D::m_axis

protected

semantics depends on subclass

Definition at line 64 of file CoordSystem1D.h.

Referenced by AngularReflectometryCoordinates::AngularReflectometryCoordinates(), and coordinateAxis().

---

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

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