UnitConverterConvSpec Class Reference

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

Inheritance diagram for UnitConverterConvSpec:

Collaboration diagram for UnitConverterConvSpec:

Public Member Functions
	UnitConverterConvSpec (const AngularSpecScan &handler)
	UnitConverterConvSpec (const Beam &beam, const IAxis &axis, Axes::Units axis_units=Axes::Units::RADIANS)
	Constructs the object for unit conversion. More...
	~UnitConverterConvSpec () override
std::vector< Axes::Units >	availableUnits () const override
	Returns the list of all available units. More...
std::string	axisName (size_t i_axis, Axes::Units units_type=Axes::Units::DEFAULT) const
size_t	axisSize (size_t i_axis) const override
	Returns the size of underlying axis. More...
double	calculateMax (size_t i_axis, Axes::Units units_type) const override
	Calculates maximum on-axis value in given units. More...
double	calculateMin (size_t i_axis, Axes::Units units_type) const override
	Calculates minimum on-axis value in given units. More...
UnitConverterConvSpec *	clone () const override
std::unique_ptr< IAxis >	createConvertedAxis (size_t i_axis, Axes::Units units) const override
	Creates axis in converted units. More...
std::unique_ptr< OutputData< double > >	createConvertedData (const OutputData< double > &data, Axes::Units units) const override
	Creates OutputData array in converter units. More...
Axes::Units	defaultUnits () const override
	Returns default units to convert to. More...
size_t	dimension () const override
	Returns dimensionality of converted canvas. More...
Axes::Units	substituteDefaultUnits (Axes::Units units) const
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Static Public Member Functions
static std::unique_ptr< UnitConverter1D >	createUnitConverter (const ISpecularScan &handler)
	Factory function to create unit converter for particular type of specular data. More...

Protected Member Functions
	UnitConverterConvSpec (const UnitConverterConvSpec &other)
void	checkIndex (size_t i_axis) const
const IAxis *	coordinateAxis () const override
std::vector< std::map< Axes::Units, std::string > >	createNameMaps () const override
	Creates name map for axis in various units. More...
std::function< double(double)>	getTraslatorFrom (Axes::Units units_type) const
	Returns translating functional (input units --> rads) More...
std::function< double(double)>	getTraslatorTo (Axes::Units units_type) const override
	Returns translating functional (rads --> desired units) More...
void	throwUnitsError (std::string method, std::vector< Axes::Units > available) const

Protected Attributes
std::unique_ptr< IAxis >	m_axis
	basic inclination angles (in rads). More...
double	m_wavelength
	basic wavelength in nm (for translation to q-space). More...

Detailed Description

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

Definition at line 67 of file UnitConverter1D.h.

Constructor & Destructor Documentation

UnitConverterConvSpec() [1/3]

UnitConverterConvSpec::UnitConverterConvSpec	(	const Beam &	beam,
		const IAxis &	axis,
		Axes::Units	axis_units = Axes::Units::RADIANS
	)

Constructs the object for unit conversion.

Definition at line 102 of file UnitConverter1D.cpp.

    : m_wavelength(beam.wavelength())
{
    m_axis = createTranslatedAxis(axis, getTraslatorFrom(axis_units), axisName(0, axis_units));
    if (m_axis->lowerBound() < 0 || m_axis->upperBound() > M_PI_2)
        throw std::runtime_error("Error in UnitConverter1D: input axis range is out of bounds");
}

References IUnitConverter::axisName(), getTraslatorFrom(), m_axis, and M_PI_2.

Referenced by clone().

Here is the call graph for this function:

UnitConverterConvSpec() [2/3]

UnitConverterConvSpec::UnitConverterConvSpec

(

const AngularSpecScan &

handler

)

Definition at line 111 of file UnitConverter1D.cpp.

    : m_wavelength(handler.wavelength()), m_axis(handler.coordinateAxis()->clone())
{
}

~UnitConverterConvSpec()

UnitConverterConvSpec::~UnitConverterConvSpec ( )

overridedefault

UnitConverterConvSpec() [3/3]

UnitConverterConvSpec::UnitConverterConvSpec ( const UnitConverterConvSpec &  other )

protected

Definition at line 140 of file UnitConverter1D.cpp.

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

Member Function Documentation

availableUnits()

std::vector< Axes::Units > UnitConverterConvSpec::availableUnits ( ) const

overridevirtual

Returns the list of all available units.

Implements IUnitConverter.

Definition at line 129 of file UnitConverter1D.cpp.

{
    return {Axes::Units::NBINS, Axes::Units::RADIANS, Axes::Units::DEGREES, Axes::Units::QSPACE,
            Axes::Units::RQ4};
}

Referenced by getTraslatorTo().

axisName()

std::string IUnitConverter::axisName ( size_t  i_axis, Axes::Units  units_type = Axes::Units::DEFAULT  ) const

inherited

Definition at line 20 of file IUnitConverter.cpp.

{
    const auto& name_maps = createNameMaps();
    if (name_maps.size() <= i_axis)
        throw std::runtime_error("Error in IUnitConverter::axisName: the size of name map vector "
                                 "is smaller or equal to the axis index"
                                 + std::to_string(static_cast<int>(i_axis)));
    const auto& name_map = name_maps[i_axis];
    units_type = substituteDefaultUnits(units_type);
    const auto& it = name_map.find(units_type);
    if (it == name_map.cend())
        throwUnitsError("IUnitConverter::axisName", availableUnits());
    return it->second;
}

References IUnitConverter::availableUnits(), IUnitConverter::createNameMaps(), IUnitConverter::substituteDefaultUnits(), and IUnitConverter::throwUnitsError().

Referenced by DepthProbeConverter::DepthProbeConverter(), OffSpecularConverter::OffSpecularConverter(), UnitConverterConvSpec(), UnitConverterSimple::addDetectorAxis(), OffSpecularConverter::addDetectorYAxis(), UnitConverter1D::createConvertedAxis(), and UnitConverterSimple::createConvertedAxis().

Here is the call graph for this function:

axisSize()

size_t UnitConverterConvSpec::axisSize ( size_t  i_axis ) const

overridevirtual

Returns the size of underlying axis.

Implements IUnitConverter.

Definition at line 123 of file UnitConverter1D.cpp.

{
    checkIndex(i_axis);
    return m_axis->size();
}

References IUnitConverter::checkIndex(), and m_axis.

Here is the call graph for this function:

calculateMax()

double UnitConverter1D::calculateMax ( size_t  i_axis, Axes::Units  units_type  ) const

overridevirtualinherited

Calculates maximum on-axis value in given units.

Implements IUnitConverter.

Definition at line 60 of file UnitConverter1D.cpp.

{
    checkIndex(i_axis);
    units_type = substituteDefaultUnits(units_type);
    auto coordinate_axis = coordinateAxis();
    if (units_type == Axes::Units::NBINS)
        return static_cast<double>(coordinate_axis->size());
    auto translator = getTraslatorTo(units_type);
    return translator(coordinate_axis->binCenter(coordinate_axis->size() - 1));
}

References IUnitConverter::checkIndex(), UnitConverter1D::coordinateAxis(), UnitConverter1D::getTraslatorTo(), and IUnitConverter::substituteDefaultUnits().

Referenced by UnitConverter1D::createConvertedAxis().

Here is the call graph for this function:

calculateMin()

double UnitConverter1D::calculateMin ( size_t  i_axis, Axes::Units  units_type  ) const

overridevirtualinherited

Calculates minimum on-axis value in given units.

Implements IUnitConverter.

Definition at line 50 of file UnitConverter1D.cpp.

{
    checkIndex(i_axis);
    units_type = substituteDefaultUnits(units_type);
    if (units_type == Axes::Units::NBINS)
        return 0.0;
    auto translator = getTraslatorTo(units_type);
    return translator(coordinateAxis()->binCenter(0));
}

References IUnitConverter::checkIndex(), UnitConverter1D::coordinateAxis(), UnitConverter1D::getTraslatorTo(), and IUnitConverter::substituteDefaultUnits().

Referenced by UnitConverter1D::createConvertedAxis().

Here is the call graph for this function:

checkIndex()

void IUnitConverter::checkIndex ( size_t  i_axis ) const

protectedinherited

Definition at line 46 of file IUnitConverter.cpp.

{
    if (i_axis < dimension())
        return;
    throw std::runtime_error("Error in IUnitConverter::checkIndex: passed axis index too big: "
                             + std::to_string(static_cast<int>(i_axis)));
}

References IUnitConverter::dimension().

Referenced by axisSize(), UnitConverterQSpec::axisSize(), UnitConverterSimple::axisSize(), UnitConverter1D::calculateMax(), UnitConverterSimple::calculateMax(), UnitConverter1D::calculateMin(), UnitConverterSimple::calculateMin(), and UnitConverter1D::createConvertedAxis().

Here is the call graph for this function:

clone()

UnitConverterConvSpec * UnitConverterConvSpec::clone ( ) const

overridevirtual

Implements UnitConverter1D.

Definition at line 118 of file UnitConverter1D.cpp.

{
    return new UnitConverterConvSpec(*this);
}

References UnitConverterConvSpec().

Here is the call graph for this function:

coordinateAxis()

const IAxis* UnitConverterConvSpec::coordinateAxis ( ) const

inlineoverrideprotectedvirtual

Implements UnitConverter1D.

Definition at line 98 of file UnitConverter1D.h.

{ return m_axis.get(); }

References m_axis.

createConvertedAxis()

std::unique_ptr< IAxis > UnitConverter1D::createConvertedAxis ( size_t  i_axis, Axes::Units  units  ) const

overridevirtualinherited

Creates axis in converted units.

Implements IUnitConverter.

Definition at line 71 of file UnitConverter1D.cpp.

{
    checkIndex(i_axis);
    units = substituteDefaultUnits(units);
    if (units == Axes::Units::NBINS)
        return std::make_unique<FixedBinAxis>(axisName(0, units), coordinateAxis()->size(),
                                              calculateMin(0, units), calculateMax(0, units));
    return createTranslatedAxis(*coordinateAxis(), getTraslatorTo(units), axisName(0, units));
}

References IUnitConverter::axisName(), UnitConverter1D::calculateMax(), UnitConverter1D::calculateMin(), IUnitConverter::checkIndex(), UnitConverter1D::coordinateAxis(), UnitConverter1D::getTraslatorTo(), and IUnitConverter::substituteDefaultUnits().

Referenced by UnitConverter1D::createConvertedData().

Here is the call graph for this function:

createConvertedData()

std::unique_ptr< OutputData< double > > UnitConverter1D::createConvertedData ( const OutputData< double > &  data, Axes::Units  units  ) const

overridevirtualinherited

Creates OutputData array in converter units.

Reimplemented from IUnitConverter.

Definition at line 82 of file UnitConverter1D.cpp.

{
    if (data.rank() != 1)
        throw std::runtime_error("Error in UnitConverter1D::createConvertedData: unexpected "
                                 "dimensions of the input data");
 
    std::unique_ptr<OutputData<double>> result(new OutputData<double>);
    auto q_axis = createConvertedAxis(0, units);
    result->addAxis(*q_axis);
 
    if (units != Axes::Units::RQ4) {
        result->setRawDataVector(data.getRawDataVector());
        return result;
    }
 
    for (size_t i = 0, size = result->getAllocatedSize(); i < size; ++i)
        (*result)[i] = data[i] * std::pow((*q_axis)[i], 4);
    return result;
}

References UnitConverter1D::createConvertedAxis(), OutputData< T >::getRawDataVector(), and OutputData< T >::rank().

Here is the call graph for this function:

createNameMaps()

std::vector< std::map< Axes::Units, std::string > > UnitConverterConvSpec::createNameMaps ( ) const

overrideprotectedvirtual

Creates name map for axis in various units.

Implements IUnitConverter.

Definition at line 145 of file UnitConverter1D.cpp.

{
    std::vector<std::map<Axes::Units, std::string>> result;
    result.push_back(AxisNames::InitSpecAxis());
    return result;
}

References AxisNames::InitSpecAxis().

Here is the call graph for this function:

createUnitConverter()

std::unique_ptr< UnitConverter1D > UnitConverter1D::createUnitConverter ( const ISpecularScan &  handler )

staticinherited

Factory function to create unit converter for particular type of specular data.

Definition at line 34 of file UnitConverter1D.cpp.

{
    if (const auto* aScan = dynamic_cast<const AngularSpecScan*>(&scan))
        return std::make_unique<UnitConverterConvSpec>(*aScan);
 
    if (const auto* qScan = dynamic_cast<const QSpecScan*>(&scan))
        return std::make_unique<UnitConverterQSpec>(*qScan);
 
    throw std::runtime_error("Bug in UnitConverter1D::createUnitConverter: invalid case");
}

Referenced by UnitConverterUtils::createConverter(), and SpecularSimulation::result().

defaultUnits()

Axes::Units UnitConverterConvSpec::defaultUnits ( ) const

overridevirtual

Returns default units to convert to.

Implements IUnitConverter.

Definition at line 135 of file UnitConverter1D.cpp.

{
    return Axes::Units::DEGREES;
}

dimension()

size_t UnitConverter1D::dimension ( ) const

overridevirtualinherited

Returns dimensionality of converted canvas.

Implements IUnitConverter.

Definition at line 45 of file UnitConverter1D.cpp.

{
    return 1u;
}

getTraslatorFrom()

std::function< double(double)> UnitConverterConvSpec::getTraslatorFrom ( Axes::Units  units_type ) const

protected

Returns translating functional (input units --> rads)

Definition at line 152 of file UnitConverter1D.cpp.

{
    switch (units_type) {
    case Axes::Units::RADIANS:
        return [](double value) { return value; };
    case Axes::Units::DEGREES:
        return [](double value) { return Units::deg2rad(value); };
    case Axes::Units::QSPACE:
        return [this](double value) { return getInvQ(m_wavelength, value); };
    default:
        throwUnitsError("UnitConverterConvSpec::getTraslatorFrom",
                        {Axes::Units::RADIANS, Axes::Units::DEGREES, Axes::Units::QSPACE});
    }
}

References Units::deg2rad(), m_wavelength, and IUnitConverter::throwUnitsError().

Referenced by UnitConverterConvSpec().

Here is the call graph for this function:

getTraslatorTo()

std::function< double(double)> UnitConverterConvSpec::getTraslatorTo ( Axes::Units  units_type ) const

overrideprotectedvirtual

Returns translating functional (rads --> desired units)

Implements UnitConverter1D.

Definition at line 167 of file UnitConverter1D.cpp.

{
    switch (units_type) {
    case Axes::Units::RADIANS:
        return [](double value) { return value; };
    case Axes::Units::DEGREES:
        return [](double value) { return Units::rad2deg(value); };
    case Axes::Units::QSPACE:
        return [wl = m_wavelength](double value) { return getQ(wl, value); };
    case Axes::Units::RQ4:
        return [wl = m_wavelength](double value) { return getQ(wl, value); };
    default:
        throwUnitsError("UnitConverterConvSpec::getTraslatorTo", availableUnits());
    }
}

References availableUnits(), m_wavelength, Units::rad2deg(), and IUnitConverter::throwUnitsError().

Here is the call graph for this function:

substituteDefaultUnits()

Axes::Units IUnitConverter::substituteDefaultUnits ( Axes::Units  units ) const

inherited

Definition at line 65 of file IUnitConverter.cpp.

{
    return units == Axes::Units::DEFAULT ? defaultUnits() : units;
}

References IUnitConverter::defaultUnits().

Referenced by IUnitConverter::axisName(), UnitConverter1D::calculateMax(), UnitConverterSimple::calculateMax(), UnitConverter1D::calculateMin(), UnitConverterSimple::calculateMin(), and UnitConverter1D::createConvertedAxis().

Here is the call graph for this function:

throwUnitsError()

void IUnitConverter::throwUnitsError ( std::string  method, std::vector< Axes::Units >  available  ) const

protectedinherited

Definition at line 54 of file IUnitConverter.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.

Referenced by IUnitConverter::axisName(), SphericalConverter::calculateValue(), RectangularConverter::calculateValue(), OffSpecularConverter::calculateValue(), DepthProbeConverter::checkUnits(), getTraslatorFrom(), getTraslatorTo(), and UnitConverterQSpec::getTraslatorTo().

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

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

Definition at line 34 of file ICloneable.h.

Member Data Documentation

m_axis

std::unique_ptr<IAxis> UnitConverterConvSpec::m_axis

protected

basic inclination angles (in rads).

Definition at line 101 of file UnitConverter1D.h.

Referenced by UnitConverterConvSpec(), axisSize(), and coordinateAxis().

m_wavelength

double UnitConverterConvSpec::m_wavelength

protected

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

Definition at line 100 of file UnitConverter1D.h.

Referenced by getTraslatorFrom(), and getTraslatorTo().

---

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

• /home/www/ba/Core/Scan/UnitConverter1D.h
• /home/www/ba/Core/Scan/UnitConverter1D.cpp