Axis with fixed bin size in sin(angle) space used for numerical comparison with IsGisaxs. More...

Inheritance diagram for CustomBinAxis:

Collaboration diagram for CustomBinAxis:

Public Member Functions
	CustomBinAxis (const std::string &name, size_t nbins, double start, double end)
	CustomBinAxis constructor. More...

virtual	~CustomBinAxis ()

Bin1D	bin (size_t index) const
	retrieve a 1d bin for the given index More...

std::vector< double >	binBoundaries () const

double	binCenter (size_t index) const

std::vector< double >	binCenters () const

double	center () const
	Returns midpoint of axis. More...

CustomBinAxis *	clone () const
	clone function More...

virtual bool	contains (double value) const
	Returns true if axis contains given point. More...

CustomBinAxis *	createClippedAxis (double left, double right) const
	Creates a new clipped axis. More...

size_t	findClosestIndex (double value) const
	find bin index which is best match for given value More...

std::string	getName () const
	retrieve the label of the axis More...

double	lowerBound () const
	Returns value of first point of axis. More...

bool	operator!= (const IAxis &right) const

bool	operator== (const IAxis &right) const
	test for equality More...

double	operator[] (size_t index) const
	indexed accessor retrieves a sample More...

void	setName (std::string name)
	Sets the axis label. More...

size_t	size () const
	retrieve the number of bins More...

double	span () const
	Returns distance from first to last point. More...

double	upperBound () const
	Returns value of last point of axis. More...

Protected Member Functions
bool	equals (const IAxis &other) const

void	print (std::ostream &ostr) const

void	setBinBoundaries (const std::vector< double > &bin_boundaries)

Protected Attributes
std::vector< double >	m_bin_centers

double	m_end

size_t	m_nbins

double	m_start

Private Attributes
std::vector< double >	m_bin_boundaries
	vector containing the bin limits More...

std::string	m_name
	axis name More...

Detailed Description

Axis with fixed bin size in sin(angle) space used for numerical comparison with IsGisaxs.

The main feature of the axis is that it produces zero bin sizes.

Definition at line 24 of file CustomBinAxis.h.

Constructor & Destructor Documentation

◆ CustomBinAxis()

CustomBinAxis::CustomBinAxis	(	const std::string &	name,
		size_t	nbins,
		double	start,
		double	end
	)

CustomBinAxis constructor.

Parameters

name	Axis name
nbins	number of bins
start	center of first bin (IsGisaxs convention)
end	center of last bin (IsGisaxs convention)

Definition at line 20 of file CustomBinAxis.cpp.

     : VariableBinAxis(name, nbins), m_start(start), m_end(end)
 {
     if (m_start >= m_end)
         throw std::runtime_error("CustomBinAxis::CustomBinAxis() -> Error."
                                  " start >= end is not allowed.");
  
     double start_sin = std::sin(start);
     double end_sin = std::sin(end);
     double step = (end_sin - start_sin) / (m_nbins - 1); // m_nbins-1 is intentionally
  
     m_bin_centers.resize(m_nbins, 0.0);
     for (size_t i = 0; i < m_bin_centers.size(); ++i) {
         m_bin_centers[i] = std::asin(start_sin + i * step);
     }
  
     std::vector<double> bin_boundaries;
     bin_boundaries.resize(m_nbins + 1, 0.0);
     for (size_t i = 0; i < bin_boundaries.size(); ++i) {
         bin_boundaries[i] = std::asin(start_sin - step / 2. + step * i);
     }
     setBinBoundaries(bin_boundaries);
 }

References m_bin_centers, m_end, VariableBinAxis::m_nbins, m_start, and VariableBinAxis::setBinBoundaries().

Referenced by clone().

Here is the call graph for this function:

◆ ~CustomBinAxis()

virtual CustomBinAxis::~CustomBinAxis ( )

inlinevirtual

Definition at line 32 of file CustomBinAxis.h.

32 {}

Member Function Documentation

◆ bin()

Bin1D CustomBinAxis::bin ( size_t index ) const

virtual

retrieve a 1d bin for the given index

Implements IAxis.

Definition at line 49 of file CustomBinAxis.cpp.

 {
     if (index >= m_nbins)
         throw std::runtime_error("CustomBinAxis::bin() -> Error. Wrong index.");
  
     Bin1D result(m_bin_centers[index], m_bin_centers[index]);
     return result;
 }

References m_bin_centers, and VariableBinAxis::m_nbins.

◆ binBoundaries()

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

inlinevirtualinherited

Reimplemented from IAxis.

Definition at line 50 of file VariableBinAxis.h.

50 { return m_bin_boundaries; }

VariableBinAxis::m_bin_boundaries

std::vector< double > m_bin_boundaries

vector containing the bin limits

Definition: VariableBinAxis.h:63

References VariableBinAxis::m_bin_boundaries.

Referenced by ConstKBinAxis::createClippedAxis().

◆ binCenter()

double VariableBinAxis::binCenter ( size_t index ) const

virtualinherited

Implements IAxis.

Definition at line 66 of file VariableBinAxis.cpp.

 {
     return bin(index).center();
 }

References VariableBinAxis::bin(), and Bin1D::center().

Here is the call graph for this function:

◆ binCenters()

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

virtual

Reimplemented from IAxis.

Definition at line 58 of file CustomBinAxis.cpp.

 {
     return m_bin_centers;
 }

References m_bin_centers.

◆ center()

double IAxis::center ( ) const

inherited

Returns midpoint of axis.

Definition at line 47 of file IAxis.cpp.

 {
     return (upperBound() + lowerBound()) / 2;
 }

References IAxis::lowerBound(), and IAxis::upperBound().

Here is the call graph for this function:

◆ clone()

CustomBinAxis * CustomBinAxis::clone ( ) const

virtual

clone function

Implements IAxis.

Definition at line 44 of file CustomBinAxis.cpp.

 {
     return new CustomBinAxis(getName(), m_nbins, m_start, m_end);
 }

References CustomBinAxis(), IAxis::getName(), m_end, VariableBinAxis::m_nbins, and m_start.

Here is the call graph for this function:

◆ contains()

bool IAxis::contains ( double value ) const

virtualinherited

Returns true if axis contains given point.

Definition at line 37 of file IAxis.cpp.

 {
     return value >= lowerBound() && value < upperBound();
 }

References IAxis::lowerBound(), and IAxis::upperBound().

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

Here is the call graph for this function:

◆ createClippedAxis()

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

virtual

Creates a new clipped axis.

Reimplemented from VariableBinAxis.

Definition at line 63 of file CustomBinAxis.cpp.

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

◆ equals()

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

protectedvirtual

Reimplemented from VariableBinAxis.

Definition at line 76 of file CustomBinAxis.cpp.

 {
     if (!IAxis::equals(other))
         return false;
     if (const CustomBinAxis* otherAxis = dynamic_cast<const CustomBinAxis*>(&other)) {
         if (size() != otherAxis->size())
             return false;
         if (!algo::almostEqual(m_start, otherAxis->m_start))
             return false;
         if (!algo::almostEqual(m_end, otherAxis->m_end))
             return false;
         return true;
     }
     return false;
 }

References algo::almostEqual(), IAxis::equals(), m_end, m_start, and VariableBinAxis::size().

Here is the call graph for this function:

◆ findClosestIndex()

size_t VariableBinAxis::findClosestIndex ( double value ) const

virtualinherited

find bin index which is best match for given value

Implements IAxis.

Definition at line 71 of file VariableBinAxis.cpp.

 {
     if (m_bin_boundaries.size() < 2)
         throw std::runtime_error("VariableBinAxis::findClosestIndex() -> Error! "
                                  "VariableBinAxis not  correctly initialized");
     if (value < lowerBound()) {
         return 0;
     } else if (value >= upperBound()) {
         return m_nbins - 1;
     }
  
     std::vector<double>::const_iterator top_limit =
         std::lower_bound(m_bin_boundaries.begin(), m_bin_boundaries.end(), value);
     if (*top_limit != value)
         --top_limit;
     size_t nbin = top_limit - m_bin_boundaries.begin();
     return nbin;
 }

References VariableBinAxis::lowerBound(), VariableBinAxis::m_bin_boundaries, VariableBinAxis::m_nbins, and VariableBinAxis::upperBound().

Referenced by VariableBinAxis::createClippedAxis(), and ConstKBinAxis::createClippedAxis().

Here is the call graph for this function:

◆ getName()

std::string IAxis::getName ( ) const

inlineinherited

retrieve the label of the axis

Definition at line 40 of file IAxis.h.

40 { return m_name; }

IAxis::m_name

std::string m_name

axis name

Definition: IAxis.h:96

References IAxis::m_name.

Referenced by OutputData< T >::addAxis(), RegionOfInterest::clipAxisToRoi(), clone(), FixedBinAxis::clone(), VariableBinAxis::clone(), ConstKBinAxis::clone(), PointwiseAxis::clone(), FixedBinAxis::createClippedAxis(), VariableBinAxis::createClippedAxis(), ConstKBinAxis::createClippedAxis(), PointwiseAxis::createClippedAxis(), ImportDataUtils::CreateSimplifiedOutputData(), IAxis::equals(), print(), FixedBinAxis::print(), VariableBinAxis::print(), ConstKBinAxis::print(), PointwiseAxis::print(), and TransformFromDomain::setAxisItem().

◆ lowerBound()

double VariableBinAxis::lowerBound ( ) const

virtualinherited

Returns value of first point of axis.

Implements IAxis.

Definition at line 56 of file VariableBinAxis.cpp.

 {
     return m_bin_boundaries.front();
 }

References VariableBinAxis::m_bin_boundaries.

Referenced by VariableBinAxis::createClippedAxis(), ConstKBinAxis::createClippedAxis(), and VariableBinAxis::findClosestIndex().

◆ operator!=()

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

inlineinherited

Definition at line 70 of file IAxis.h.

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

◆ operator==()

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

inlineinherited

test for equality

Definition at line 69 of file IAxis.h.

69 { return equals(right); }

References IAxis::equals().

Here is the call graph for this function:

◆ operator[]()

double VariableBinAxis::operator[] ( size_t index ) const

virtualinherited

indexed accessor retrieves a sample

Implements IAxis.

Definition at line 42 of file VariableBinAxis.cpp.

 {
     return bin(index).center();
 }

References VariableBinAxis::bin(), and Bin1D::center().

Here is the call graph for this function:

◆ print()

void CustomBinAxis::print ( std::ostream & ostr ) const

protectedvirtual

Reimplemented from VariableBinAxis.

Definition at line 69 of file CustomBinAxis.cpp.

 {
     ostr << "CustomBinAxis(\"" << getName() << "\", " << size() << ", "
          << std::setprecision(std::numeric_limits<double>::digits10 + 2) << m_start << ", " << m_end
          << ")";
 }

References IAxis::getName(), m_end, m_start, and VariableBinAxis::size().

Here is the call graph for this function:

◆ setBinBoundaries()

void VariableBinAxis::setBinBoundaries ( const std::vector< double > & bin_boundaries )

protectedinherited

Definition at line 152 of file VariableBinAxis.cpp.

 {
     // checking that values are sorted
     std::vector<double> vec_sorted = bin_boundaries;
     std::sort(vec_sorted.begin(), vec_sorted.end());
     for (size_t i = 0; i < bin_boundaries.size(); ++i) {
         if (vec_sorted[i] != bin_boundaries[i])
             throw std::runtime_error("VariableBinAxis::VariableBinAxis() -> Error. "
                                      "Array with bin edges is not sorted.");
     }
  
     std::vector<double> vec = bin_boundaries;
     vec.erase(std::unique(vec.begin(), vec.end()), vec.end());
  
     if (vec.size() != bin_boundaries.size())
         throw std::runtime_error("VariableBinAxis::VariableBinAxis() -> Error. "
                                  "Array with bin edges contains repeating values.");
  
     m_bin_boundaries = bin_boundaries;
 }

References VariableBinAxis::m_bin_boundaries.

Referenced by ConstKBinAxis::ConstKBinAxis(), CustomBinAxis(), VariableBinAxis::VariableBinAxis(), and ConstKBinAxis::createClippedAxis().

◆ setName()

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

inlineinherited

Sets the axis label.

Definition at line 43 of file IAxis.h.

43 { m_name = name; }

References IAxis::m_name, and RealSpace::Particles::name().

Here is the call graph for this function:

◆ size()

size_t VariableBinAxis::size ( ) const

inlinevirtualinherited

retrieve the number of bins

Implements IAxis.

Definition at line 36 of file VariableBinAxis.h.

36 { return m_nbins; }

References VariableBinAxis::m_nbins.

Referenced by VariableBinAxis::binCenters(), VariableBinAxis::createClippedAxis(), ConstKBinAxis::createClippedAxis(), equals(), VariableBinAxis::equals(), ConstKBinAxis::equals(), print(), VariableBinAxis::print(), and ConstKBinAxis::print().

◆ span()

double IAxis::span ( ) const

inherited

Returns distance from first to last point.

Definition at line 42 of file IAxis.cpp.

 {
     return upperBound() - lowerBound();
 }

References IAxis::lowerBound(), and IAxis::upperBound().

Referenced by RectangularDetector::getHeight(), RectangularDetector::getWidth(), and DetectorUtils::isQuadratic().

Here is the call graph for this function:

◆ upperBound()

double VariableBinAxis::upperBound ( ) const

virtualinherited

Returns value of last point of axis.

Implements IAxis.

Definition at line 61 of file VariableBinAxis.cpp.

 {
     return m_bin_boundaries.back();
 }

References VariableBinAxis::m_bin_boundaries.

Referenced by VariableBinAxis::createClippedAxis(), ConstKBinAxis::createClippedAxis(), and VariableBinAxis::findClosestIndex().

Member Data Documentation

◆ m_bin_boundaries

std::vector<double> VariableBinAxis::m_bin_boundaries

privateinherited

vector containing the bin limits

Definition at line 63 of file VariableBinAxis.h.

Referenced by VariableBinAxis::bin(), VariableBinAxis::binBoundaries(), VariableBinAxis::clone(), VariableBinAxis::createClippedAxis(), VariableBinAxis::equals(), VariableBinAxis::findClosestIndex(), VariableBinAxis::lowerBound(), VariableBinAxis::print(), VariableBinAxis::setBinBoundaries(), and VariableBinAxis::upperBound().

◆ m_bin_centers

std::vector<double> CustomBinAxis::m_bin_centers

protected

Definition at line 48 of file CustomBinAxis.h.

Referenced by CustomBinAxis(), bin(), and binCenters().

◆ m_end

double CustomBinAxis::m_end

protected

Definition at line 47 of file CustomBinAxis.h.

Referenced by CustomBinAxis(), clone(), equals(), and print().

◆ m_name

std::string IAxis::m_name

privateinherited

axis name

Definition at line 96 of file IAxis.h.

Referenced by IAxis::getName(), and IAxis::setName().

◆ m_nbins

size_t VariableBinAxis::m_nbins

protectedinherited

Definition at line 60 of file VariableBinAxis.h.

Referenced by ConstKBinAxis::ConstKBinAxis(), CustomBinAxis(), VariableBinAxis::VariableBinAxis(), bin(), VariableBinAxis::bin(), clone(), VariableBinAxis::clone(), ConstKBinAxis::clone(), VariableBinAxis::findClosestIndex(), and VariableBinAxis::size().

◆ m_start

double CustomBinAxis::m_start

protected

Definition at line 46 of file CustomBinAxis.h.

Referenced by CustomBinAxis(), clone(), equals(), and print().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CustomBinAxis()

◆ ~CustomBinAxis()

Member Function Documentation

◆ bin()

◆ binBoundaries()

◆ binCenter()

◆ binCenters()

◆ center()

◆ clone()

◆ contains()

◆ createClippedAxis()

◆ equals()

◆ findClosestIndex()

◆ getName()

◆ lowerBound()

◆ operator!=()

◆ operator==()

◆ operator[]()

◆ print()

◆ setBinBoundaries()

◆ setName()

◆ size()

◆ span()

◆ upperBound()

Member Data Documentation

◆ m_bin_boundaries

◆ m_bin_centers

◆ m_end

◆ m_name

◆ m_nbins

◆ m_start