Inheritance diagram for IAxis:

Collaboration diagram for IAxis:

Public Member Functions
	IAxis (const std::string &name)

virtual IAxis *	clone () const =0

virtual	~IAxis ()

virtual size_t	size () const =0

std::string	getName () const

void	setName (std::string name)

virtual double	operator[] (size_t index) const =0

virtual Bin1D	getBin (size_t index) const =0

virtual double	getMin () const =0

virtual double	getMax () const =0

virtual double	getBinCenter (size_t index) const =0

virtual size_t	findClosestIndex (double value) const =0

bool	operator== (const IAxis &right) const

bool	operator!= (const IAxis &right) const

virtual std::vector< double >	getBinCenters () const

virtual std::vector< double >	getBinBoundaries () const

virtual IAxis *	createClippedAxis (double left, double right) const

virtual bool	contains (double value) const

virtual std::string	pyString (const std::string &units, size_t offset) const =0

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

virtual bool	equals (const IAxis &other) const

Private Member Functions
	IAxis (const IAxis &)

IAxis &	operator= (const IAxis &)

Private Attributes
std::string	m_name

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

Detailed Description

Interface for one-dimensional axes.

Definition at line 24 of file IAxis.h.

Constructor & Destructor Documentation

◆ IAxis() [1/2]

IAxis::IAxis ( const std::string & name )

inline

constructors

Definition at line 28 of file IAxis.h.

28 : m_name(name) {}

IAxis::m_name

std::string m_name

axis name

Definition: IAxis.h:92

◆ ~IAxis()

virtual IAxis::~IAxis ( )

inlinevirtual

destructor

Definition at line 34 of file IAxis.h.

34 {}

◆ IAxis() [2/2]

IAxis::IAxis ( const IAxis & )

private

Member Function Documentation

◆ clone()

virtual IAxis* IAxis::clone ( ) const

pure virtual

clone function

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

Referenced by IDetector::addAxis(), OutputData< T >::addAxis(), DepthProbeSimulation::setBeamParameters(), OffSpecSimulation::setBeamParameters(), and OutputDataWriteINTStrategy::writeOutputData().

◆ size()

virtual size_t IAxis::size ( ) const

pure virtual

retrieve the number of bins

Implemented in PointwiseAxis, VariableBinAxis, and FixedBinAxis.

Referenced by OutputData< T >::addAxis(), Histogram2D::addContent(), ConvolutionDetectorResolution::apply1dConvolution(), ConvolutionDetectorResolution::apply2dConvolution(), DepthProbeComputationTerm::compute(), IntensityDataFunctions::coordinateFromBinf(), IntensityDataFunctions::create2DArrayfromOutputData(), DepthProbeSimulation::createIntensityData(), IntensityDataFunctions::createRearrangedDataSet(), DepthProbeConverter::DepthProbeConverter(), DepthProbeElement::DepthProbeElement(), anonymous_namespace{Simulation.cpp}::detHasSameDimensions(), SpectrumUtils::FindPeaks(), DepthProbeSimulation::generateSimulationElements(), IDetector2D::getGlobalIndex(), RectangularDetector::getNbinsX(), IHistogram::getNbinsX(), RectangularDetector::getNbinsY(), IHistogram::getNbinsY(), OutputData< T >::hasSameDimensions(), RegionOfInterest::initFrom(), OffSpecSimulation::intensityMapSize(), DepthProbeSimulation::numberOfSimulationElements(), OffSpecularConverter::OffSpecularConverter(), DepthProbeSimulation::rawResults(), DepthProbeSimulation::setBeamParameters(), OffSpecSimulation::setBeamParameters(), DepthProbeSimulation::setRawResults(), OffSpecSimulation::transferDetectorImage(), OffSpecSimulation::transferResultsToIntensityMap(), anonymous_namespace{OutputDataWriteStrategy.cpp}::Write2DRepresentation(), and OutputDataWriteINTStrategy::writeOutputData().

◆ getName()

std::string IAxis::getName ( ) const

inline

retrieve the label of the axis

Definition at line 40 of file IAxis.h.

40 { return m_name; }

References m_name.

Referenced by OutputData< T >::addAxis(), RegionOfInterest::clipAxisToRoi(), CustomBinAxis::clone(), FixedBinAxis::clone(), VariableBinAxis::clone(), ConstKBinAxis::clone(), PointwiseAxis::clone(), FixedBinAxis::createClippedAxis(), VariableBinAxis::createClippedAxis(), ConstKBinAxis::createClippedAxis(), PointwiseAxis::createClippedAxis(), equals(), CustomBinAxis::print(), FixedBinAxis::print(), VariableBinAxis::print(), ConstKBinAxis::print(), PointwiseAxis::print(), and FixedBinAxis::pyString().

◆ setName()

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

inline

Sets the axis label.

Definition at line 43 of file IAxis.h.

43 { m_name = name; }

References m_name.

◆ operator[]()

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

pure virtual

indexed accessor retrieves a sample

Implemented in PointwiseAxis, VariableBinAxis, and FixedBinAxis.

◆ getBin()

virtual Bin1D IAxis::getBin ( size_t index ) const

pure virtual

retrieve a 1d bin for the given index

Implemented in PointwiseAxis, VariableBinAxis, FixedBinAxis, and CustomBinAxis.

Referenced by RegionOfInterest::clipAxisToRoi(), IntensityDataFunctions::coordinateFromBinf(), IntensityDataFunctions::coordinateToBinf(), RectangularDetector::createPixel(), SphericalDetector::createPixel(), and SpectrumUtils::FindPeaks().

◆ getMin()

virtual double IAxis::getMin ( ) const

pure virtual

Returns value of first point of axis.

Implemented in PointwiseAxis, VariableBinAxis, and FixedBinAxis.

Referenced by contains(), DepthProbeConverter::DepthProbeConverter(), Histogram1D::fill(), RectangularDetector::getHeight(), RectangularDetector::getWidth(), IHistogram::getXmin(), IHistogram::getYmin(), OffSpecularConverter::OffSpecularConverter(), RectangularDetector::regionOfInterestPixel(), DepthProbeSimulation::setBeamParameters(), OffSpecSimulation::setBeamParameters(), and SpecularSimulation::setScan().

◆ getMax()

virtual double IAxis::getMax ( ) const

pure virtual

Returns value of last point of axis.

Implemented in PointwiseAxis, VariableBinAxis, and FixedBinAxis.

Referenced by contains(), DepthProbeConverter::DepthProbeConverter(), Histogram1D::fill(), RectangularDetector::getHeight(), RectangularDetector::getWidth(), IHistogram::getXmax(), IHistogram::getYmax(), OffSpecularConverter::OffSpecularConverter(), and DepthProbeSimulation::setBeamParameters().

◆ getBinCenter()

virtual double IAxis::getBinCenter ( size_t index ) const

pure virtual

Implemented in PointwiseAxis, VariableBinAxis, and FixedBinAxis.

◆ findClosestIndex()

virtual size_t IAxis::findClosestIndex ( double value ) const

pure virtual

find bin index which is best match for given value

Implemented in PointwiseAxis, VariableBinAxis, and FixedBinAxis.

Referenced by IntensityDataFunctions::coordinateToBinf(), Histogram1D::fill(), RectangularDetector::indexOfSpecular(), SphericalDetector::indexOfSpecular(), RegionOfInterest::initFrom(), Histogram2D::projectionX(), and Histogram2D::projectionY().

◆ operator==()

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

inline

test for equality

Definition at line 63 of file IAxis.h.

63 { return equals(right); }

IAxis::equals

virtual bool equals(const IAxis &other) const

Definition: IAxis.cpp:18

References equals().

Here is the call graph for this function:

◆ operator!=()

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

inline

Definition at line 64 of file IAxis.h.

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

◆ getBinCenters()

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

virtual

Reimplemented in PointwiseAxis, VariableBinAxis, FixedBinAxis, and CustomBinAxis.

Definition at line 23 of file IAxis.cpp.

 {
     throw Exceptions::NotImplementedException("IAxis::getBinCenters() -> Error. Not implemented.");
 }

Referenced by anonymous_namespace{UnitConverter1D.cpp}::createTranslatedAxis(), Histogram1D::getBinCenters(), anonymous_namespace{SpecularSimulation.cpp}::mangledScan(), and anonymous_namespace{OutputDataWriteStrategy.cpp}::Write1DRepresentation().

◆ getBinBoundaries()

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

virtual

Reimplemented in PointwiseAxis, VariableBinAxis, and FixedBinAxis.

Definition at line 28 of file IAxis.cpp.

 {
     throw Exceptions::NotImplementedException(
         "IAxis::getBinBoundaries() -> Error. Not implemented.");
 }

◆ createClippedAxis()

IAxis * IAxis::createClippedAxis	(	double	left,
		double	right
	)		const

virtual

Creates a new clipped axis.

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

Definition at line 34 of file IAxis.cpp.

 {
     throw Exceptions::NotImplementedException(
         "IAxis::createClippedAxis() -> Error. Not implemented.");
 }

Referenced by IntensityDataFunctions::createClippedDataSet().

◆ contains()

bool IAxis::contains ( double value ) const

virtual

Returns true if axis contains given point.

Definition at line 40 of file IAxis.cpp.

 {
     return value >= getMin() && value < getMax();
 }

References getMax(), and getMin().

Referenced by Histogram1D::crop(), Histogram2D::crop(), RectangularDetector::indexOfSpecular(), and SphericalDetector::indexOfSpecular().

Here is the call graph for this function:

◆ pyString()

virtual std::string IAxis::pyString	(	const std::string &	units,
		size_t	offset
	)		const

pure virtual

Implemented in FixedBinAxis, VariableBinAxis, and PointwiseAxis.

Referenced by SimulationToPython::defineOffSpecBeam(), AngularSpecScan::print(), and QSpecScan::print().

◆ print()

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

protectedpure virtual

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

◆ equals()

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

protectedvirtual

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

Definition at line 18 of file IAxis.cpp.

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

References getName().

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

Here is the call graph for this function:

◆ operator=()

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

private

Friends And Related Function Documentation

◆ operator<<

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

friend

Definition at line 66 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 92 of file IAxis.h.

Referenced by getName(), and setName().

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

/home/www/ba/Base/Axis/IAxis.h
/home/www/ba/Base/Axis/IAxis.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ IAxis() [1/2]

◆ ~IAxis()

◆ IAxis() [2/2]

Member Function Documentation

◆ clone()

◆ size()

◆ getName()

◆ setName()

◆ operator[]()

◆ getBin()

◆ getMin()

◆ getMax()

◆ getBinCenter()

◆ findClosestIndex()

◆ operator==()

◆ operator!=()

◆ getBinCenters()

◆ getBinBoundaries()

◆ createClippedAxis()

◆ contains()

◆ pyString()

◆ print()

◆ equals()

◆ operator=()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ m_name