AngularReflectometryCoordinates Class Reference

Description

Conversion of axis units for the case of conventional (angle-based) reflectometry.

Definition at line 69 of file CoordSystem1D.h.

Inheritance diagram for AngularReflectometryCoordinates:

Collaboration diagram for AngularReflectometryCoordinates:

Public Member Functions
	AngularReflectometryCoordinates (double wavelength, const IAxis &axis, Coords axis_units=Coords::RADIANS)
	Constructs the object for unit conversion. More...
	~AngularReflectometryCoordinates () override
std::vector< Coords >	availableUnits () const override
	Returns the list of all available units. More...
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...
AngularReflectometryCoordinates *	clone () const override
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
Coords	defaultUnits () const override
	Returns default units to convert to. More...
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
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
	AngularReflectometryCoordinates (const AngularReflectometryCoordinates &other)
std::vector< std::map< Coords, std::string > >	createNameMaps () const override
	Creates name map for axis in various units. More...
std::function< double(double)>	getTraslatorTo (Coords units) const override
	Returns translating functional (rads --> desired units) More...

Private Attributes
double	m_wavelength
	basic wavelength in nm (for translation to q-space). More...

Constructor & Destructor Documentation

AngularReflectometryCoordinates() [1/2]

AngularReflectometryCoordinates::AngularReflectometryCoordinates	(	double	wavelength,
		const IAxis &	axis,
		Coords	axis_units = Coords::RADIANS
	)

Constructs the object for unit conversion.

Definition at line 147 of file CoordSystem1D.cpp.

    : CoordSystem1D(createAxisFrom(axis, axis_units, angularAxisName(axis_units), wavelength))
    , m_wavelength(wavelength)
{
    if (m_axis->min() < 0 || m_axis->max() > M_PI_2)
        throw std::runtime_error("Error in CoordSystem1D: input axis range is out of bounds");
}

References CoordSystem1D::m_axis, and M_PI_2.

Referenced by clone().

~AngularReflectometryCoordinates()

AngularReflectometryCoordinates::~AngularReflectometryCoordinates ( )

overridedefault

AngularReflectometryCoordinates() [2/2]

AngularReflectometryCoordinates::AngularReflectometryCoordinates ( const AngularReflectometryCoordinates &  other )

private

Definition at line 157 of file CoordSystem1D.cpp.

    : CoordSystem1D(other.m_axis->clone())
    , m_wavelength(other.m_wavelength)
{
}

Member Function Documentation

availableUnits()

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

overridevirtual

Returns the list of all available units.

Implements ICoordSystem.

Definition at line 171 of file CoordSystem1D.cpp.

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

References DEGREES, NBINS, QSPACE, RADIANS, and RQ4.

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

Here is the call graph for this function:

axisSize()

size_t CoordSystem1D::axisSize ( size_t  i_axis ) const

overridevirtualinherited

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, CoordSystem1D::coordinateAxis(), and IAxis::size().

Here is the call graph for this function:

calculateMax()

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

overridevirtualinherited

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(), CoordSystem1D::coordinateAxis(), CoordSystem1D::getTraslatorTo(), NBINS, IAxis::size(), and ICoordSystem::substituteDefaultUnits().

Referenced by CoordSystem1D::createConvertedAxis().

Here is the call graph for this function:

calculateMin()

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

overridevirtualinherited

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, CoordSystem1D::coordinateAxis(), CoordSystem1D::getTraslatorTo(), NBINS, and ICoordSystem::substituteDefaultUnits().

Referenced by CoordSystem1D::createConvertedAxis().

Here is the call graph for this function:

clone()

AngularReflectometryCoordinates * AngularReflectometryCoordinates::clone ( ) const

overridevirtual

Implements CoordSystem1D.

Definition at line 166 of file CoordSystem1D.cpp.

{
    return new AngularReflectometryCoordinates(*this);
}

References AngularReflectometryCoordinates().

Here is the call graph for this function:

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

inlineprotectedinherited

Definition at line 62 of file CoordSystem1D.h.

{ return m_axis.get(); }

References CoordSystem1D::m_axis.

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

createConvertedAxis()

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

overridevirtualinherited

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(), CoordSystem1D::calculateMax(), CoordSystem1D::calculateMin(), CoordSystem1D::coordinateAxis(), CoordSystem1D::getTraslatorTo(), NBINS, and ICoordSystem::substituteDefaultUnits().

Referenced by CoordSystem1D::createConvertedData().

Here is the call graph for this function:

createConvertedData()

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

overridevirtualinherited

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, CoordSystem1D::createConvertedAxis(), Datafield::flatVector(), Datafield::rank(), RQ4, Datafield::setVector(), and Datafield::size().

Here is the call graph for this function:

createNameMaps()

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

overrideprivatevirtual

Creates name map for axis in various units.

Implements ICoordSystem.

Definition at line 176 of file CoordSystem1D.cpp.

{
    return {DataUtils::AxisNames::specAxis};
}

References DataUtils::AxisNames::specAxis.

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

Coords AngularReflectometryCoordinates::defaultUnits ( ) const

inlineoverridevirtual

Returns default units to convert to.

Implements ICoordSystem.

Definition at line 82 of file CoordSystem1D.h.

{ return Coords::DEGREES; }

References DEGREES.

getTraslatorTo()

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

overrideprivatevirtual

Returns translating functional (rads --> desired units)

Implements CoordSystem1D.

Definition at line 181 of file CoordSystem1D.cpp.

{
    switch (units) {
    case Coords::RADIANS:
        return [](double value) { return value; };
    case Coords::DEGREES:
        return [](double value) { return Units::rad2deg(value); };
    case Coords::QSPACE:
        return [wl = m_wavelength](double value) { return getQ(wl, value); };
    case Coords::RQ4:
        return [wl = m_wavelength](double value) { return getQ(wl, value); };
    default:
        ASSERT(0);
    }
}

References ASSERT, DEGREES, m_wavelength, QSPACE, Units::rad2deg(), RADIANS, and RQ4.

Here is the call graph for this function:

rank()

size_t CoordSystem1D::rank ( ) const

inlineoverridevirtualinherited

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 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

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

protectedinherited

semantics depends on subclass

Definition at line 64 of file CoordSystem1D.h.

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

m_wavelength

double AngularReflectometryCoordinates::m_wavelength

private

basic wavelength in nm (for translation to q-space).

Definition at line 94 of file CoordSystem1D.h.

Referenced by getTraslatorTo().

---

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