DepthProbeConverter Class Reference

Inheritance diagram for DepthProbeConverter:

Collaboration diagram for DepthProbeConverter:

Public Member Functions
	DepthProbeConverter (const Beam &beam, const IAxis &alpha_axis, const IAxis &z_axis)
	~DepthProbeConverter () final
DepthProbeConverter *	clone () const final
std::vector< Axes::Units >	availableUnits () const final
Axes::Units	defaultUnits () const final
virtual size_t	dimension () const final
double	calculateMin (size_t i_axis, Axes::Units units_type) const final
double	calculateMax (size_t i_axis, Axes::Units units_type) const final
size_t	axisSize (size_t i_axis) const final
std::unique_ptr< IAxis >	createConvertedAxis (size_t i_axis, Axes::Units units) const final
std::string	axisName (size_t i_axis, Axes::Units units_type=Axes::Units::DEFAULT) const
Axes::Units	substituteDefaultUnits (Axes::Units units) const
virtual std::unique_ptr< OutputData< double > >	createConvertedData (const OutputData< double > &data, Axes::Units units) const
virtual void	transferToCPP ()

Protected Member Functions
void	addDetectorAxis (const IDetector &detector, size_t i_axis)
void	addAxisData (std::string name, double min, double max, Axes::Units default_units, size_t nbins)
void	checkIndex (size_t i_axis) const
void	throwUnitsError (std::string method, std::vector< Axes::Units > available) const

Protected Attributes
std::vector< AxisData >	m_axis_data_table
double	m_wavelength
double	m_alpha_i
double	m_phi_i

Private Member Functions
	DepthProbeConverter (const DepthProbeConverter &other)
double	calculateValue (size_t, Axes::Units units_type, double value) const final
std::vector< std::map< Axes::Units, std::string > >	createNameMaps () const final
void	checkUnits (Axes::Units units_type) const

Detailed Description

DepthProbeConverter class handles the unit translations for depth probe simulations Its default units are radians for x-axis and nm for y-axis.

Definition at line 148 of file SimpleUnitConverters.h.

Constructor & Destructor Documentation

DepthProbeConverter() [1/2]

DepthProbeConverter::DepthProbeConverter	(	const Beam &	beam,
		const IAxis &	alpha_axis,
		const IAxis &	z_axis
	)

Definition at line 396 of file SimpleUnitConverters.cpp.

    : UnitConverterSimple(beam)
{
    const auto& alpha_axis_name = axisName(0);
    const auto& z_axis_name = axisName(1);
    addAxisData(alpha_axis_name, alpha_axis.getMin(), alpha_axis.getMax(), defaultUnits(),
                alpha_axis.size());
    addAxisData(z_axis_name, z_axis.getMin(), z_axis.getMax(), defaultUnits(), z_axis.size());
}

References UnitConverterSimple::addAxisData(), IUnitConverter::axisName(), defaultUnits(), IAxis::getMax(), IAxis::getMin(), IAxis::size(), and z_axis_name.

Referenced by clone().

Here is the call graph for this function:

~DepthProbeConverter()

DepthProbeConverter::~DepthProbeConverter ( )

finaldefault

DepthProbeConverter() [2/2]

DepthProbeConverter::DepthProbeConverter ( const DepthProbeConverter &  other )

private

Definition at line 421 of file SimpleUnitConverters.cpp.

    : UnitConverterSimple(other)
{
}

Member Function Documentation

clone()

DepthProbeConverter * DepthProbeConverter::clone ( ) const

finalvirtual

Implements IUnitConverter.

Definition at line 409 of file SimpleUnitConverters.cpp.

{
    return new DepthProbeConverter(*this);
}

References DepthProbeConverter().

Here is the call graph for this function:

availableUnits()

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

finalvirtual

Returns the list of all available units.

Reimplemented from UnitConverterSimple.

Definition at line 414 of file SimpleUnitConverters.cpp.

{
    auto result = UnitConverterSimple::availableUnits();
    result.push_back(Axes::Units::QSPACE);
    return result;
}

References UnitConverterSimple::availableUnits().

Referenced by checkUnits().

Here is the call graph for this function:

defaultUnits()

Axes::Units DepthProbeConverter::defaultUnits ( ) const

inlinefinalvirtual

Implements IUnitConverter.

Definition at line 159 of file SimpleUnitConverters.h.

{ return Axes::Units::DEGREES; }

Referenced by DepthProbeConverter().

calculateValue()

double DepthProbeConverter::calculateValue ( size_t  i_axis, Axes::Units  units_type, double  value  ) const

finalprivatevirtual

Implements UnitConverterSimple.

Definition at line 426 of file SimpleUnitConverters.cpp.

{
    checkUnits(units_type);
    if (i_axis == 1)
        return value; // unit conversions are not applied to sample position axis
    switch (units_type) {
    case Axes::Units::DEGREES:
        return Units::rad2deg(value);
    case Axes::Units::QSPACE:
        return getQ(m_wavelength, value);
    default:
        return value;
    }
}

References checkUnits(), anonymous_namespace{SimpleUnitConverters.cpp}::getQ(), UnitConverterSimple::m_wavelength, and Units::rad2deg().

Here is the call graph for this function:

createNameMaps()

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

finalprivatevirtual

Implements IUnitConverter.

Definition at line 442 of file SimpleUnitConverters.cpp.

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

References AxisNames::InitSampleDepthAxis(), and AxisNames::InitSpecAxis().

Here is the call graph for this function:

checkUnits()

void DepthProbeConverter::checkUnits ( Axes::Units  units_type ) const

private

Definition at line 450 of file SimpleUnitConverters.cpp.

{
    const auto& available_units = availableUnits();
    if (std::find(available_units.begin(), available_units.end(), units_type)
        == available_units.cend())
        throwUnitsError("DepthProbeConverter::checkUnits", available_units);
}

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

Referenced by calculateValue().

Here is the call graph for this function:

dimension()

size_t UnitConverterSimple::dimension ( ) const

finalvirtualinherited

Implements IUnitConverter.

Definition at line 41 of file SimpleUnitConverters.cpp.

{
    return m_axis_data_table.size();
}

References UnitConverterSimple::m_axis_data_table.

calculateMin()

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

finalvirtualinherited

Implements IUnitConverter.

Definition at line 53 of file SimpleUnitConverters.cpp.

{
    checkIndex(i_axis);
    units_type = substituteDefaultUnits(units_type);
    const auto& axis_data = m_axis_data_table[i_axis];
    if (units_type == Axes::Units::NBINS) {
        return 0.0;
    }
    return calculateValue(i_axis, units_type, axis_data.min);
}

References UnitConverterSimple::calculateValue(), IUnitConverter::checkIndex(), UnitConverterSimple::m_axis_data_table, and IUnitConverter::substituteDefaultUnits().

Referenced by UnitConverterSimple::createConvertedAxis().

Here is the call graph for this function:

calculateMax()

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

finalvirtualinherited

Implements IUnitConverter.

Definition at line 64 of file SimpleUnitConverters.cpp.

{
    checkIndex(i_axis);
    units_type = substituteDefaultUnits(units_type);
    const auto& axis_data = m_axis_data_table[i_axis];
    if (units_type == Axes::Units::NBINS) {
        return static_cast<double>(axis_data.nbins);
    }
    return calculateValue(i_axis, units_type, axis_data.max);
}

References UnitConverterSimple::calculateValue(), IUnitConverter::checkIndex(), UnitConverterSimple::m_axis_data_table, and IUnitConverter::substituteDefaultUnits().

Referenced by UnitConverterSimple::createConvertedAxis().

Here is the call graph for this function:

axisSize()

size_t UnitConverterSimple::axisSize ( size_t  i_axis ) const

finalvirtualinherited

Implements IUnitConverter.

Definition at line 75 of file SimpleUnitConverters.cpp.

{
    checkIndex(i_axis);
    return m_axis_data_table[i_axis].nbins;
}

References IUnitConverter::checkIndex(), and UnitConverterSimple::m_axis_data_table.

Referenced by UnitConverterSimple::createConvertedAxis().

Here is the call graph for this function:

createConvertedAxis()

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

finalvirtualinherited

Implements IUnitConverter.

Definition at line 86 of file SimpleUnitConverters.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 std::make_unique<FixedBinAxis>(axis_name, axis_size, min, max);
}

References IUnitConverter::axisName(), UnitConverterSimple::axisSize(), UnitConverterSimple::calculateMax(), and UnitConverterSimple::calculateMin().

Here is the call graph for this function:

addDetectorAxis()

void UnitConverterSimple::addDetectorAxis ( const IDetector &  detector, size_t  i_axis  )

protectedinherited

Definition at line 102 of file SimpleUnitConverters.cpp.

{
    const auto& axis = detector.getAxis(i_axis);
    const auto* p_roi = detector.regionOfInterest();
    const auto& axis_name = axisName(i_axis);
    if (p_roi) {
        auto P_roi_axis = p_roi->clipAxisToRoi(i_axis, axis);
        addAxisData(axis_name, P_roi_axis->getMin(), P_roi_axis->getMax(), defaultUnits(),
                    P_roi_axis->size());
    } else {
        addAxisData(axis_name, axis.getMin(), axis.getMax(), defaultUnits(), axis.size());
    }
}

References UnitConverterSimple::addAxisData(), IUnitConverter::axisName(), IUnitConverter::defaultUnits(), IDetector::getAxis(), and IDetector::regionOfInterest().

Referenced by RectangularConverter::RectangularConverter(), and SphericalConverter::SphericalConverter().

Here is the call graph for this function:

addAxisData()

void UnitConverterSimple::addAxisData ( std::string  name, double  min, double  max, Axes::Units  default_units, size_t  nbins  )

protectedinherited

Definition at line 46 of file SimpleUnitConverters.cpp.

{
    AxisData axis_data{name, min, max, default_units, nbins};
    m_axis_data_table.push_back(axis_data);
}

References UnitConverterSimple::m_axis_data_table.

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

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 UnitConverterSimple::addDetectorAxis(), OffSpecularConverter::addDetectorYAxis(), UnitConverterSimple::createConvertedAxis(), UnitConverter1D::createConvertedAxis(), DepthProbeConverter(), OffSpecularConverter::OffSpecularConverter(), and UnitConverterConvSpec::UnitConverterConvSpec().

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(), UnitConverterSimple::calculateMax(), UnitConverter1D::calculateMax(), UnitConverterSimple::calculateMin(), UnitConverter1D::calculateMin(), and UnitConverter1D::createConvertedAxis().

Here is the call graph for this function:

createConvertedData()

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

virtualinherited

Creates OutputData array in converter units.

Reimplemented in UnitConverter1D.

Definition at line 36 of file IUnitConverter.cpp.

{
    const size_t dim = data.getRank();
    std::unique_ptr<OutputData<double>> result(new OutputData<double>);
    for (size_t i = 0; i < dim; ++i)
        result->addAxis(*createConvertedAxis(i, units));
    result->setRawDataVector(data.getRawDataVector());
    return result;
}

References IUnitConverter::createConvertedAxis(), OutputData< T >::getRank(), and OutputData< T >::getRawDataVector().

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 UnitConverterSimple::axisSize(), UnitConverterConvSpec::axisSize(), UnitConverterQSpec::axisSize(), UnitConverterSimple::calculateMax(), UnitConverter1D::calculateMax(), UnitConverterSimple::calculateMin(), UnitConverter1D::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 << axisUnitName.at(unit) << "\n";
    throw std::runtime_error(ss.str());
}

References axisUnitName.

Referenced by IUnitConverter::axisName(), SphericalConverter::calculateValue(), RectangularConverter::calculateValue(), OffSpecularConverter::calculateValue(), checkUnits(), UnitConverterConvSpec::getTraslatorFrom(), UnitConverterConvSpec::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_data_table

std::vector<AxisData> UnitConverterSimple::m_axis_data_table

protectedinherited

Definition at line 62 of file SimpleUnitConverters.h.

Referenced by UnitConverterSimple::addAxisData(), UnitConverterSimple::axisSize(), UnitConverterSimple::calculateMax(), UnitConverterSimple::calculateMin(), RectangularConverter::calculateValue(), and UnitConverterSimple::dimension().

m_wavelength

double UnitConverterSimple::m_wavelength

protectedinherited

Definition at line 64 of file SimpleUnitConverters.h.

Referenced by SphericalConverter::calculateValue(), RectangularConverter::calculateValue(), calculateValue(), and RectangularConverter::normalizeToWavelength().

m_alpha_i

double UnitConverterSimple::m_alpha_i

protectedinherited

Definition at line 65 of file SimpleUnitConverters.h.

Referenced by SphericalConverter::calculateValue(), and RectangularConverter::calculateValue().

m_phi_i

double UnitConverterSimple::m_phi_i

protectedinherited

Definition at line 66 of file SimpleUnitConverters.h.

Referenced by SphericalConverter::calculateValue(), and RectangularConverter::calculateValue().

---

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

• /home/www/ba/Device/Detector/SimpleUnitConverters.h
• /home/www/ba/Device/Detector/SimpleUnitConverters.cpp