OffSpecularConverter Class Reference

IUnitConverter class that handles the unit translations for off-specular simulations with a spherical detector Its default units are radians for both axes. More...

Inheritance diagram for OffSpecularConverter:

Collaboration diagram for OffSpecularConverter:

Public Member Functions
	OffSpecularConverter (const IDetector2D &detector, const Beam &beam, const IAxis &alpha_axis)
	~OffSpecularConverter () 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
double	calculateMax (size_t i_axis, Axes::Units units_type) const override
double	calculateMin (size_t i_axis, Axes::Units units_type) const override
OffSpecularConverter *	clone () const override
std::unique_ptr< IAxis >	createConvertedAxis (size_t i_axis, Axes::Units units) const override
virtual std::unique_ptr< OutputData< double > >	createConvertedData (const OutputData< double > &data, Axes::Units units) const
	Creates OutputData array in converter units. More...
Axes::Units	defaultUnits () const override
virtual size_t	dimension () const override
Axes::Units	substituteDefaultUnits (Axes::Units units) const
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

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

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

Private Member Functions
	OffSpecularConverter (const OffSpecularConverter &other)
void	addDetectorYAxis (const IDetector2D &detector)
double	calculateValue (size_t i_axis, Axes::Units units_type, double value) const override
std::vector< std::map< Axes::Units, std::string > >	createNameMaps () const override

Detailed Description

IUnitConverter class that handles the unit translations for off-specular simulations with a spherical detector Its default units are radians for both axes.

Definition at line 129 of file SimpleUnitConverters.h.

Constructor & Destructor Documentation

OffSpecularConverter() [1/2]

OffSpecularConverter::OffSpecularConverter	(	const IDetector2D &	detector,
		const Beam &	beam,
		const IAxis &	alpha_axis
	)

Definition at line 319 of file SimpleUnitConverters.cpp.

    : UnitConverterSimple(beam)
{
    if (detector.dimension() != 2)
        throw std::runtime_error("Error in OffSpecularConverter constructor: "
                                 "detector has wrong dimension: "
                                 + std::to_string(static_cast<int>(detector.dimension())));
    addAxisData(axisName(0), alpha_axis.lowerBound(), alpha_axis.upperBound(), defaultUnits(),
                alpha_axis.size());
    addDetectorYAxis(detector);
}

References UnitConverterSimple::addAxisData(), addDetectorYAxis(), IUnitConverter::axisName(), defaultUnits(), IDetector::dimension(), IAxis::lowerBound(), IAxis::size(), and IAxis::upperBound().

Referenced by clone().

Here is the call graph for this function:

~OffSpecularConverter()

OffSpecularConverter::~OffSpecularConverter ( )

overridedefault

OffSpecularConverter() [2/2]

OffSpecularConverter::OffSpecularConverter ( const OffSpecularConverter &  other )

private

Definition at line 344 of file SimpleUnitConverters.cpp.

    : UnitConverterSimple(other)
{
}

Member Function Documentation

addAxisData()

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

protectedinherited

Definition at line 51 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, and RealSpace::Particles::name().

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

Here is the call graph for this function:

addDetectorAxis()

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

protectedinherited

Definition at line 107 of file SimpleUnitConverters.cpp.

{
    const auto& axis = detector.axis(i_axis);
    const auto* p_roi = detector.regionOfInterest();
    const auto& axis_name = axisName(i_axis);
    if (!p_roi) {
        addAxisData(axis_name, axis.lowerBound(), axis.upperBound(), defaultUnits(), axis.size());
        return;
    }
    auto P_roi_axis = p_roi->clipAxisToRoi(i_axis, axis);
    addAxisData(axis_name, P_roi_axis->lowerBound(), P_roi_axis->upperBound(), defaultUnits(),
                P_roi_axis->size());
}

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

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

Here is the call graph for this function:

addDetectorYAxis()

void OffSpecularConverter::addDetectorYAxis ( const IDetector2D &  detector )

private

Definition at line 369 of file SimpleUnitConverters.cpp.

{
    const auto& axis = detector.axis(1);
    const auto* p_roi = detector.regionOfInterest();
    const auto& axis_name = axisName(1);
    std::unique_ptr<IAxis> P_new_axis;
    if (p_roi) {
        P_new_axis = p_roi->clipAxisToRoi(1, axis);
    } else {
        P_new_axis.reset(axis.clone());
    }
    if (!P_new_axis)
        throw std::runtime_error("Error in OffSpecularConverter::addDetectorYAxis: "
                                 "could not retrieve the y-axis of the detector");
    if (const auto* P_rect_det = dynamic_cast<const RectangularDetector*>(&detector)) {
        std::unique_ptr<RectangularPixel> P_det_pixel(P_rect_det->regionOfInterestPixel());
        const auto k00 = P_det_pixel->getPosition(0.0, 0.0);
        const auto k01 = P_det_pixel->getPosition(0.0, 1.0);
        const double alpha_f_min = M_PI_2 - k00.theta();
        const double alpha_f_max = M_PI_2 - k01.theta();
        addAxisData(axis_name, alpha_f_min, alpha_f_max, defaultUnits(), P_new_axis->size());
    } else if (dynamic_cast<const SphericalDetector*>(&detector)) {
        const double alpha_f_min = P_new_axis->lowerBound();
        const double alpha_f_max = P_new_axis->upperBound();
        addAxisData(axis_name, alpha_f_min, alpha_f_max, defaultUnits(), P_new_axis->size());
    } else {
        throw std::runtime_error("Error in OffSpecularConverter::addDetectorYAxis: "
                                 "wrong detector type");
    }
}

References UnitConverterSimple::addAxisData(), IDetector::axis(), IUnitConverter::axisName(), defaultUnits(), M_PI_2, and IDetector2D::regionOfInterest().

Referenced by OffSpecularConverter().

Here is the call graph for this function:

availableUnits()

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

overridevirtualinherited

Returns the list of all available units.

Implements IUnitConverter.

Reimplemented in DepthProbeConverter, RectangularConverter, and SphericalConverter.

Definition at line 84 of file SimpleUnitConverters.cpp.

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

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

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

Here is the call graph for this function:

axisSize()

size_t UnitConverterSimple::axisSize ( size_t  i_axis ) const

overridevirtualinherited

Implements IUnitConverter.

Definition at line 78 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:

calculateMax()

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

overridevirtualinherited

Implements IUnitConverter.

Definition at line 68 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:

calculateMin()

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

overridevirtualinherited

Implements IUnitConverter.

Definition at line 58 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:

calculateValue()

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

overrideprivatevirtual

Implements UnitConverterSimple.

Definition at line 349 of file SimpleUnitConverters.cpp.

{
    switch (units_type) {
    case Axes::Units::RADIANS:
        return value;
    case Axes::Units::DEGREES:
        return Units::rad2deg(value);
    default:
        throwUnitsError("OffSpecularConverter::calculateValue", availableUnits());
    }
}

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

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

OffSpecularConverter * OffSpecularConverter::clone ( ) const

overridevirtual

Implements IUnitConverter.

Definition at line 334 of file SimpleUnitConverters.cpp.

{
    return new OffSpecularConverter(*this);
}

References OffSpecularConverter().

Here is the call graph for this function:

createConvertedAxis()

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

overridevirtualinherited

Implements IUnitConverter.

Definition at line 89 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:

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.rank();
    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 >::getRawDataVector(), and OutputData< T >::rank().

Here is the call graph for this function:

createNameMaps()

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

overrideprivatevirtual

Implements IUnitConverter.

Definition at line 361 of file SimpleUnitConverters.cpp.

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

References AxisNames::InitOffSpecularAxis0(), and AxisNames::InitOffSpecularAxis1().

Here is the call graph for this function:

defaultUnits()

Axes::Units OffSpecularConverter::defaultUnits ( ) const

overridevirtual

Implements IUnitConverter.

Definition at line 339 of file SimpleUnitConverters.cpp.

{
    return Axes::Units::DEGREES;
}

Referenced by OffSpecularConverter(), and addDetectorYAxis().

dimension()

size_t UnitConverterSimple::dimension ( ) const

overridevirtualinherited

Implements IUnitConverter.

Definition at line 46 of file SimpleUnitConverters.cpp.

{
    return m_axis_data_table.size();
}

References UnitConverterSimple::m_axis_data_table.

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(), calculateValue(), DepthProbeConverter::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_alpha_i

double UnitConverterSimple::m_alpha_i

protectedinherited

Definition at line 69 of file SimpleUnitConverters.h.

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

m_axis_data_table

std::vector<AxisData> UnitConverterSimple::m_axis_data_table

protectedinherited

Definition at line 66 of file SimpleUnitConverters.h.

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

m_phi_i

double UnitConverterSimple::m_phi_i

protectedinherited

Definition at line 70 of file SimpleUnitConverters.h.

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

m_wavelength

double UnitConverterSimple::m_wavelength

protectedinherited

Definition at line 68 of file SimpleUnitConverters.h.

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

---

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