IAxis Class Reference

Description

Abstract base class for one-dimensional axes.

Definition at line 27 of file IAxis.h.

Inheritance diagram for IAxis:

Collaboration diagram for IAxis:

Public Member Functions
	IAxis (const IAxis &)=delete
	IAxis (std::string name)
virtual	~IAxis ()
std::string	axisName () const
	Returns the label of the axis. More...
virtual Bin1D	bin (size_t index) const =0
	retrieve a 1d bin for the given index More...
virtual std::vector< double >	binBoundaries () const
virtual double	binCenter (size_t index) const =0
virtual std::vector< double >	binCenters () const
std::pair< double, double >	bounds () const
	Returns lower and upper bound in a pair. first is lower, second is upper. More...
double	center () const
	Returns midpoint of axis. More...
virtual void	clip (double lower, double upper)
	Clips this axis to the given values. More...
void	clip (std::pair< double, double > bounds)
	Convenience overload to clip this axis to the given values. bounds.first is lower, bounds.second is upper value. More...
virtual IAxis *	clone () const =0
virtual bool	contains (double value) const
	Returns true if axis contains given point. More...
virtual size_t	findClosestIndex (double value) const =0
	find bin index which is best match for given value More...
virtual double	max () const =0
	Returns value of last point of axis. More...
virtual double	min () const =0
	Returns value of first point of axis. More...
bool	operator!= (const IAxis &right) const
bool	operator== (const IAxis &right) const
	test for equality More...
virtual double	operator[] (size_t index) const =0
	indexed accessor retrieves a sample More...
void	setAxisName (std::string name)
	Sets the axis label. More...
virtual size_t	size () const =0
	Returns the number of bins. More...
double	span () const
	Returns distance from first to last point. More...

Protected Member Functions
virtual bool	equals (const IAxis &other) const
virtual void	print (std::ostream &ostr) const =0

Private Attributes
std::string	m_name
	axis name More...

Friends
std::ostream &	operator<< (std::ostream &ostr, const IAxis &m)

Constructor & Destructor Documentation

IAxis() [1/2]

IAxis::IAxis ( std::string  name )

inline

Definition at line 29 of file IAxis.h.

        : m_name(std::move(name))
    {
    }

IAxis() [2/2]

IAxis::IAxis ( const IAxis &  )

delete

~IAxis()

IAxis::~IAxis ( )

virtualdefault

Member Function Documentation

axisName()

std::string IAxis::axisName ( ) const

inline

Returns the label of the axis.

Definition at line 61 of file IAxis.h.

{ return m_name; }

References m_name.

Referenced by ConstKBinAxis::clone(), CustomBinAxis::clone(), FixedBinAxis::clone(), PointwiseAxis::clone(), VariableBinAxis::clone(), equals(), ConstKBinAxis::print(), CustomBinAxis::print(), FixedBinAxis::print(), PointwiseAxis::print(), and VariableBinAxis::print().

bin()

virtual Bin1D IAxis::bin ( size_t  index ) const

pure virtual

retrieve a 1d bin for the given index

Implemented in VariableBinAxis, PointwiseAxis, FixedBinAxis, and CustomBinAxis.

Referenced by FramUtil::coordinateFromBinf(), FramUtil::coordinateToBinf(), RectangularDetector::createPixel(), SphericalDetector::createPixel(), DataUtils::Data::FindPeaks(), and DetectorMask::process_masks().

binBoundaries()

std::vector< double > IAxis::binBoundaries ( ) const

virtual

Reimplemented in VariableBinAxis, PointwiseAxis, and FixedBinAxis.

Definition at line 30 of file IAxis.cpp.

{
    throw std::runtime_error("IAxis::binBoundaries() -> Error. Not implemented.");
}

binCenter()

virtual double IAxis::binCenter ( size_t  index ) const

pure virtual

Implemented in VariableBinAxis, PointwiseAxis, and FixedBinAxis.

Referenced by CoordSystem1D::calculateMax().

binCenters()

std::vector< double > IAxis::binCenters ( ) const

virtual

Reimplemented in VariableBinAxis, PointwiseAxis, FixedBinAxis, and CustomBinAxis.

Definition at line 25 of file IAxis.cpp.

{
    throw std::runtime_error("IAxis::binCenters() -> Error. Not implemented.");
}

Referenced by CoordSystem1D::createConvertedAxis(), and ReadWriteNumpyTXT::write1DRepresentation().

bounds()

std::pair< double, double > IAxis::bounds

(

)

const

Returns lower and upper bound in a pair. first is lower, second is upper.

Definition at line 50 of file IAxis.cpp.

{
    return {min(), max()};
}

References max(), and min().

Referenced by clip().

Here is the call graph for this function:

center()

double IAxis::center

(

)

const

Returns midpoint of axis.

Definition at line 60 of file IAxis.cpp.

{
    return (max() + min()) / 2;
}

References max(), and min().

Here is the call graph for this function:

clip() [1/2]

void IAxis::clip ( double  lower, double  upper  )

virtual

Clips this axis to the given values.

Reimplemented in VariableBinAxis, PointwiseAxis, FixedBinAxis, CustomBinAxis, and ConstKBinAxis.

Definition at line 35 of file IAxis.cpp.

{
    throw std::runtime_error("IAxis::clip() -> Error. Not implemented.");
}

Referenced by IDetector::axesClippedToRegionOfInterest(), clip(), IDetector::createDetectorMap(), and Datafield::crop().

clip() [2/2]

void IAxis::clip

(

std::pair< double, double >

bounds

)

Convenience overload to clip this axis to the given values. bounds.first is lower, bounds.second is upper value.

Definition at line 40 of file IAxis.cpp.

{
    return clip(bounds.first, bounds.second);
}

References bounds(), and clip().

Here is the call graph for this function:

clone()

virtual IAxis* IAxis::clone ( ) const

pure virtual

Implemented in VariableBinAxis, PointwiseAxis, FixedBinAxis, CustomBinAxis, and ConstKBinAxis.

Referenced by IDetector::addDetAxis(), Datafield::create_xProjection(), Datafield::create_yProjection(), IDetector::createDetectorMap(), DepthProbeSimulation::createIntensityData(), DataUtils::Data::createRearrangedDataSet(), Datafield::crop(), SphericalDetector::offspecCoords(), DepthProbeSimulation::setBeamParameters(), OffspecSimulation::setBeamParameters(), OffspecSimulation::transferDetectorImage(), and ReadWriteINT::writeDatafield().

contains()

bool IAxis::contains ( double  value ) const

virtual

Returns true if axis contains given point.

Definition at line 45 of file IAxis.cpp.

{
    return value >= min() && value < max();
}

References max(), and min().

Referenced by RectangularDetector::indexOfSpecular(), and SphericalDetector::indexOfSpecular().

Here is the call graph for this function:

equals()

bool IAxis::equals ( const IAxis &  other ) const

protectedvirtual

Reimplemented in VariableBinAxis, PointwiseAxis, FixedBinAxis, CustomBinAxis, and ConstKBinAxis.

Definition at line 20 of file IAxis.cpp.

{
    return axisName() == other.axisName();
}

References axisName().

Referenced by ConstKBinAxis::equals(), CustomBinAxis::equals(), FixedBinAxis::equals(), PointwiseAxis::equals(), VariableBinAxis::equals(), and operator==().

Here is the call graph for this function:

findClosestIndex()

virtual size_t IAxis::findClosestIndex ( double  value ) const

pure virtual

find bin index which is best match for given value

Implemented in VariableBinAxis, PointwiseAxis, and FixedBinAxis.

Referenced by IDetector::RoiOfAxis::RoiOfAxis(), FramUtil::coordinateToBinf(), Datafield::create_xProjection(), Datafield::create_yProjection(), RectangularDetector::indexOfSpecular(), SphericalDetector::indexOfSpecular(), Datafield::xProjection(), and Datafield::yProjection().

max()

virtual double IAxis::max ( ) const

pure virtual

Returns value of last point of axis.

Implemented in VariableBinAxis, PointwiseAxis, and FixedBinAxis.

Referenced by bounds(), center(), contains(), DepthProbeSimulation::setBeamParameters(), and span().

min()

virtual double IAxis::min ( ) const

pure virtual

Returns value of first point of axis.

Implemented in VariableBinAxis, PointwiseAxis, and FixedBinAxis.

Referenced by SpecularSimulation::SpecularSimulation(), bounds(), center(), contains(), DepthProbeSimulation::setBeamParameters(), OffspecSimulation::setBeamParameters(), and span().

operator!=()

bool IAxis::operator!= ( const IAxis &  right ) const

inline

Definition at line 90 of file IAxis.h.

{ return !(*this == right); }

operator==()

bool IAxis::operator== ( const IAxis &  right ) const

inline

test for equality

Definition at line 89 of file IAxis.h.

{ return equals(right); }

References equals().

Here is the call graph for this function:

operator[]()

virtual double IAxis::operator[] ( size_t  index ) const

pure virtual

indexed accessor retrieves a sample

Implemented in VariableBinAxis, PointwiseAxis, and FixedBinAxis.

print()

virtual void IAxis::print ( std::ostream &  ostr ) const

protectedpure virtual

Implemented in VariableBinAxis, PointwiseAxis, FixedBinAxis, CustomBinAxis, and ConstKBinAxis.

setAxisName()

void IAxis::setAxisName ( std::string  name )

inline

Sets the axis label.

Definition at line 39 of file IAxis.h.

{ m_name = name; }

References m_name.

size()

virtual size_t IAxis::size ( ) const

pure virtual

Returns the number of bins.

Implemented in VariableBinAxis, PointwiseAxis, and FixedBinAxis.

Referenced by DepthProbeElement::DepthProbeElement(), Frame::Frame(), IDetector::RoiOfAxis::RoiOfAxis(), ConvolutionDetectorResolution::apply1dConvolution(), ConvolutionDetectorResolution::apply2dConvolution(), CoordSystem1D::axisSize(), CoordSystem1D::calculateMax(), FramUtil::coordinateFromBinf(), DataUtils::Data::create2DArrayfromDatafield(), DataUtils::Data::createRearrangedDataSet(), DataUtils::Array::createVector2D(), DataUtils::Data::FindPeaks(), DepthProbeSimulation::generateElements(), IDetector::getGlobalIndex(), Frame::hasSameSizes(), OffspecSimulation::intensityMapSize(), Datafield::npArray(), DepthProbeSimulation::numberOfElements(), RectangularDetector::offspecCoords(), OffspecSimulation::pack_result(), DetectorMask::process_masks(), DepthProbeComputation::runProtected(), DepthProbeSimulation::setBeamParameters(), OffspecSimulation::setBeamParameters(), OffspecSimulation::transferDetectorImage(), ReadWriteNumpyTXT::write2DRepresentation(), ReadWriteINT::writeDatafield(), RectangularDetector::xSize(), and RectangularDetector::ySize().

span()

double IAxis::span

(

)

const

Returns distance from first to last point.

Definition at line 55 of file IAxis.cpp.

{
    return max() - min();
}

References max(), and min().

Referenced by RectangularDetector::height(), and RectangularDetector::width().

Here is the call graph for this function:

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  ostr, const IAxis &  m  )

friend

Definition at line 92 of file IAxis.h.

    {
        m.print(ostr);
        return ostr;
    }

Member Data Documentation

m_name

std::string IAxis::m_name

private

axis name

Definition at line 103 of file IAxis.h.

Referenced by axisName(), and setAxisName().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Base/Axis/IAxis.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Base/Axis/IAxis.cpp