Axis with fixed bin size in sin(angle) space. More...

Inheritance diagram for ConstKBinAxis:

Collaboration diagram for ConstKBinAxis:

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

	~ConstKBinAxis () override

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...

ConstKBinAxis *	clone () const override
	clone function More...

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

ConstKBinAxis *	createClippedAxis (double left, double right) const override
	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
	ConstKBinAxis (const std::string &name, size_t nbins)

bool	equals (const IAxis &other) const override

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

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

Protected Attributes
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.

Definition at line 23 of file ConstKBinAxis.h.

Constructor & Destructor Documentation

◆ ConstKBinAxis() [1/2]

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

ConstKBinAxis constructor.

Parameters

name	Axis name
nbins	number of bins
start	low edge of first bin
end	upper edge of last bin

Definition at line 24 of file ConstKBinAxis.cpp.

     : VariableBinAxis(name, nbins), m_start(start), m_end(end)
 {
     if (m_start >= m_end)
         throw std::runtime_error(
             "ConstKBinAxis::ConstKBinAxis() -> Error. start >= end is not allowed.");
  
     double start_sin = std::sin(m_start);
     double end_sin = std::sin(m_end);
     double step = (end_sin - start_sin) / (m_nbins);
  
     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 * i);
     }
     setBinBoundaries(bin_boundaries);
 }

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

Referenced by clone(), and createClippedAxis().

Here is the call graph for this function:

◆ ~ConstKBinAxis()

ConstKBinAxis::~ConstKBinAxis ( )

inlineoverride

Definition at line 31 of file ConstKBinAxis.h.

31 {}

◆ ConstKBinAxis() [2/2]

ConstKBinAxis::ConstKBinAxis	(	const std::string &	name,
		size_t	nbins
	)

protected

Definition at line 19 of file ConstKBinAxis.cpp.

     : VariableBinAxis(name, nbins), m_start(0), m_end(0)
 {
 }

Member Function Documentation

◆ bin()

Bin1D VariableBinAxis::bin ( size_t index ) const

virtualinherited

retrieve a 1d bin for the given index

Implements IAxis.

Definition at line 47 of file VariableBinAxis.cpp.

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

References VariableBinAxis::m_bin_boundaries, and VariableBinAxis::m_nbins.

Referenced by VariableBinAxis::binCenter(), VariableBinAxis::binCenters(), VariableBinAxis::createClippedAxis(), createClippedAxis(), and VariableBinAxis::operator[]().

◆ binBoundaries()

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

inlinevirtualinherited

Reimplemented from IAxis.

Definition at line 50 of file VariableBinAxis.h.

50 { return m_bin_boundaries; }

References VariableBinAxis::m_bin_boundaries.

Referenced by 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 > VariableBinAxis::binCenters ( ) const

virtualinherited

Reimplemented from IAxis.

Definition at line 90 of file VariableBinAxis.cpp.

 {
     std::vector<double> result;
     result.resize(size(), 0.0);
     for (size_t i = 0; i < size(); ++i) {
         result[i] = bin(i).center();
     }
     return result;
 }

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

Here is the call graph for this function:

◆ 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()

ConstKBinAxis * ConstKBinAxis::clone ( ) const

overridevirtual

clone function

Implements IAxis.

Definition at line 43 of file ConstKBinAxis.cpp.

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

References ConstKBinAxis(), 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()

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

overridevirtual

Creates a new clipped axis.

Reimplemented from VariableBinAxis.

Definition at line 48 of file ConstKBinAxis.cpp.

 {
     if (left >= right)
         throw std::runtime_error(
             "ConstKBinAxis::createClippedAxis() -> Error. 'left'' should be smaller than 'right'");
  
     if (left < lowerBound())
         left = bin(0).center();
     if (right >= upperBound())
         right = bin(size() - 1).center();
  
     size_t nbin1 = findClosestIndex(left);
     size_t nbin2 = findClosestIndex(right);
  
     size_t new_nbins = nbin2 - nbin1 + 1;
     std::vector<double> new_boundaries;
     std::vector<double> old_boundaries = binBoundaries();
     for (size_t i = 0; i < new_nbins + 1; ++i) {
         new_boundaries.push_back(old_boundaries[nbin1 + i]);
     }
  
     ConstKBinAxis* result = new ConstKBinAxis(getName(), new_nbins);
     result->m_start = new_boundaries.front();
     result->m_end = new_boundaries.back();
     result->setBinBoundaries(new_boundaries);
     return result;
 }

References ConstKBinAxis(), VariableBinAxis::bin(), VariableBinAxis::binBoundaries(), Bin1D::center(), VariableBinAxis::findClosestIndex(), IAxis::getName(), VariableBinAxis::lowerBound(), m_end, m_start, VariableBinAxis::setBinBoundaries(), VariableBinAxis::size(), and VariableBinAxis::upperBound().

Here is the call graph for this function:

◆ equals()

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

overrideprotectedvirtual

Reimplemented from VariableBinAxis.

Definition at line 76 of file ConstKBinAxis.cpp.

 {
     if (!IAxis::equals(other))
         return false;
     if (const ConstKBinAxis* otherAxis = dynamic_cast<const ConstKBinAxis*>(&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 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(), CustomBinAxis::clone(), FixedBinAxis::clone(), VariableBinAxis::clone(), clone(), PointwiseAxis::clone(), FixedBinAxis::createClippedAxis(), VariableBinAxis::createClippedAxis(), createClippedAxis(), PointwiseAxis::createClippedAxis(), ImportDataUtils::CreateSimplifiedOutputData(), IAxis::equals(), CustomBinAxis::print(), FixedBinAxis::print(), VariableBinAxis::print(), 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(), 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 ConstKBinAxis::print ( std::ostream & ostr ) const

overrideprotectedvirtual

Reimplemented from VariableBinAxis.

Definition at line 92 of file ConstKBinAxis.cpp.

 {
     ostr << "ConstKBinAxis(\"" << 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(), CustomBinAxis::CustomBinAxis(), VariableBinAxis::VariableBinAxis(), and 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(), createClippedAxis(), CustomBinAxis::equals(), VariableBinAxis::equals(), equals(), CustomBinAxis::print(), VariableBinAxis::print(), and 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(), 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_end

double ConstKBinAxis::m_end

protected

Definition at line 44 of file ConstKBinAxis.h.

Referenced by ConstKBinAxis(), clone(), createClippedAxis(), 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(), CustomBinAxis::CustomBinAxis(), VariableBinAxis::VariableBinAxis(), CustomBinAxis::bin(), VariableBinAxis::bin(), CustomBinAxis::clone(), VariableBinAxis::clone(), clone(), VariableBinAxis::findClosestIndex(), and VariableBinAxis::size().

◆ m_start

double ConstKBinAxis::m_start

protected

Definition at line 43 of file ConstKBinAxis.h.

Referenced by ConstKBinAxis(), clone(), createClippedAxis(), equals(), and print().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ConstKBinAxis() [1/2]

◆ ~ConstKBinAxis()

◆ ConstKBinAxis() [2/2]

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_end

◆ m_name

◆ m_nbins

◆ m_start