DepthProbeCoordinates Class Reference

Description

DepthProbeCoordinates 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 133 of file CoordSystem2D.h.

Inheritance diagram for DepthProbeCoordinates:

Collaboration diagram for DepthProbeCoordinates:

Public Member Functions
	DepthProbeCoordinates (const OwningVector< IAxis > &axes, const Direction &direction, double wavelength)
	~DepthProbeCoordinates () override
std::vector< Coords >	availableUnits () const override
	Returns list of units that are available for all 2D detectors. Further units may be added by child classes. More...
std::string	axisName (size_t i_axis, Coords units=Coords::UNDEFINED) const
size_t	axisSize (size_t i_axis) const override
double	calculateMax (size_t i_axis, Coords units) const override
double	calculateMin (size_t i_axis, Coords units) const override
DepthProbeCoordinates *	clone () const override
std::vector< IAxis * >	convertedAxes (Coords units) const
IAxis *	createConvertedAxis (size_t i_axis, Coords units) const override
virtual Datafield *	createConvertedData (const Datafield &data, Coords units) const
	Creates Datafield array in converter units. More...
std::vector< IAxis * >	defaultAxes () const
Coords	defaultUnits () const override
size_t	rank () const override
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, size_t nbins)
Coords	substituteDefaultUnits (Coords units) const
void	throwUnitsError (std::string method, std::vector< Coords > available) const

Protected Attributes
double	m_alpha_i
OwningVector< IAxis >	m_axes
double	m_phi_i
double	m_wavelength

Private Member Functions
	DepthProbeCoordinates (const DepthProbeCoordinates &other)
	used by clone() More...
double	calculateValue (size_t, Coords units, double value) const override
std::vector< std::map< Coords, std::string > >	createNameMaps () const override

Constructor & Destructor Documentation

DepthProbeCoordinates() [1/2]

DepthProbeCoordinates::DepthProbeCoordinates	(	const OwningVector< IAxis > &	axes,
		const Direction &	direction,
		double	wavelength
	)

Definition at line 302 of file CoordSystem2D.cpp.

    : CoordSystem2D(axes, direction, wavelength)
{
}

Referenced by clone().

~DepthProbeCoordinates()

DepthProbeCoordinates::~DepthProbeCoordinates ( )

overridedefault

DepthProbeCoordinates() [2/2]

DepthProbeCoordinates::DepthProbeCoordinates ( const DepthProbeCoordinates &  other )

private

used by clone()

Definition at line 308 of file CoordSystem2D.cpp.

    : CoordSystem2D(other)
{
}

Member Function Documentation

addAxisData()

void CoordSystem2D::addAxisData ( std::string  name, double  min, double  max, size_t  nbins  )

protectedinherited

Definition at line 70 of file CoordSystem2D.cpp.

{
    m_axes.emplace_back(new FixedBinAxis(name, min, max, nbins));
}

References OwningVector< T >::emplace_back(), and CoordSystem2D::m_axes.

Here is the call graph for this function:

availableUnits()

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

overridevirtual

Returns list of units that are available for all 2D detectors. Further units may be added by child classes.

Reimplemented from CoordSystem2D.

Definition at line 320 of file CoordSystem2D.cpp.

{
    auto result = CoordSystem2D::availableUnits();
    result.push_back(Coords::QSPACE);
    return result;
}

References CoordSystem2D::availableUnits(), and QSPACE.

Referenced by calculateValue().

Here is the call graph for this function:

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 CoordSystem2D::axisSize ( size_t  i_axis ) const

overridevirtualinherited

Implements ICoordSystem.

Definition at line 93 of file CoordSystem2D.cpp.

{
    ASSERT(i_axis < rank());
    return m_axes[i_axis]->size();
}

References ASSERT, CoordSystem2D::m_axes, CoordSystem2D::rank(), and OwningVector< T >::size().

Referenced by CoordSystem2D::createConvertedAxis().

Here is the call graph for this function:

calculateMax()

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

overridevirtualinherited

Implements ICoordSystem.

Definition at line 84 of file CoordSystem2D.cpp.

{
    ASSERT(i_axis < rank());
    units = substituteDefaultUnits(units);
    if (units == Coords::NBINS)
        return m_axes[i_axis]->size();
    return calculateValue(i_axis, units, m_axes[i_axis]->max());
}

References ASSERT, CoordSystem2D::calculateValue(), CoordSystem2D::m_axes, NBINS, CoordSystem2D::rank(), OwningVector< T >::size(), and ICoordSystem::substituteDefaultUnits().

Referenced by CoordSystem2D::createConvertedAxis().

Here is the call graph for this function:

calculateMin()

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

overridevirtualinherited

Implements ICoordSystem.

Definition at line 75 of file CoordSystem2D.cpp.

{
    ASSERT(i_axis < rank());
    units = substituteDefaultUnits(units);
    if (units == Coords::NBINS)
        return 0.0;
    return calculateValue(i_axis, units, m_axes[i_axis]->min());
}

References ASSERT, CoordSystem2D::calculateValue(), CoordSystem2D::m_axes, NBINS, CoordSystem2D::rank(), and ICoordSystem::substituteDefaultUnits().

Referenced by CoordSystem2D::createConvertedAxis().

Here is the call graph for this function:

calculateValue()

double DepthProbeCoordinates::calculateValue ( size_t  i_axis, Coords  units, double  value  ) const

overrideprivatevirtual

Implements CoordSystem2D.

Definition at line 327 of file CoordSystem2D.cpp.

{
    const auto& available_units = availableUnits();
    if (std::find(available_units.begin(), available_units.end(), units) == available_units.cend())
        ASSERT(0);
 
    if (i_axis == 1)
        return value; // unit conversions are not applied to sample position axis
    switch (units) {
    case Coords::DEGREES:
        return Units::rad2deg(value);
    case Coords::QSPACE:
        return getQ(m_wavelength, value);
    default:
        return value;
    }
}

References ASSERT, availableUnits(), DEGREES, CoordSystem2D::m_wavelength, QSPACE, and Units::rad2deg().

Here is the call graph for this function:

clone()

DepthProbeCoordinates * DepthProbeCoordinates::clone ( ) const

overridevirtual

Implements ICoordSystem.

Definition at line 315 of file CoordSystem2D.cpp.

{
    return new DepthProbeCoordinates(*this);
}

References DepthProbeCoordinates().

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:

createConvertedAxis()

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

overridevirtualinherited

Implements ICoordSystem.

Definition at line 104 of file CoordSystem2D.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 new FixedBinAxis(axis_name, axis_size, min, max);
}

References ICoordSystem::axisName(), CoordSystem2D::axisSize(), CoordSystem2D::calculateMax(), and CoordSystem2D::calculateMin().

Here is the call graph for this function:

createConvertedData()

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

virtualinherited

Creates Datafield array in converter units.

Reimplemented in CoordSystem1D.

Definition at line 46 of file ICoordSystem.cpp.

{
    std::vector<IAxis*> axes;
    for (size_t i = 0; i < rank(); ++i)
        axes.emplace_back(createConvertedAxis(i, units));
 
    Datafield* result = new Datafield(axes);
 
    result->setVector(data.flatVector());
    return result;
}

References ICoordSystem::createConvertedAxis(), Datafield::flatVector(), ICoordSystem::rank(), and Datafield::setVector().

Here is the call graph for this function:

createNameMaps()

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

overrideprivatevirtual

Implements ICoordSystem.

Definition at line 345 of file CoordSystem2D.cpp.

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

References DataUtils::AxisNames::sampleDepthAxis, and 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 DepthProbeCoordinates::defaultUnits ( ) const

inlineoverridevirtual

Implements ICoordSystem.

Definition at line 143 of file CoordSystem2D.h.

{ return Coords::DEGREES; }

References DEGREES.

rank()

size_t CoordSystem2D::rank ( ) const

inlineoverridevirtualinherited

Implements ICoordSystem.

Definition at line 39 of file CoordSystem2D.h.

{ return m_axes.size(); }

References CoordSystem2D::m_axes, and OwningVector< T >::size().

Referenced by CoordSystem2D::axisSize(), CoordSystem2D::calculateMax(), and CoordSystem2D::calculateMin().

Here is the call graph for this function:

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_alpha_i

double CoordSystem2D::m_alpha_i

protectedinherited

Definition at line 58 of file CoordSystem2D.h.

Referenced by SphericalCoords::calculateValue(), and ImageCoords::calculateValue().

m_axes

OwningVector<IAxis> CoordSystem2D::m_axes

protectedinherited

Definition at line 56 of file CoordSystem2D.h.

Referenced by CoordSystem2D::addAxisData(), CoordSystem2D::axisSize(), CoordSystem2D::calculateMax(), CoordSystem2D::calculateMin(), ImageCoords::calculateValue(), and CoordSystem2D::rank().

m_phi_i

double CoordSystem2D::m_phi_i

protectedinherited

Definition at line 59 of file CoordSystem2D.h.

Referenced by SphericalCoords::calculateValue(), and ImageCoords::calculateValue().

m_wavelength

double CoordSystem2D::m_wavelength

protectedinherited

Definition at line 57 of file CoordSystem2D.h.

Referenced by SphericalCoords::calculateValue(), ImageCoords::calculateValue(), and calculateValue().

---

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

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