RegionOfInterest Class Reference

Inheritance diagram for RegionOfInterest:

Collaboration diagram for RegionOfInterest:

Public Member Functions
	RegionOfInterest (const IDetector2D &detector, double xlow, double ylow, double xup, double yup)
	RegionOfInterest (const OutputData< double > &data, double xlow, double ylow, double xup, double yup)
RegionOfInterest &	operator= (const RegionOfInterest &other)=delete
RegionOfInterest *	clone () const
	~RegionOfInterest ()
double	getXlow () const
double	getYlow () const
double	getXup () const
double	getYup () const
size_t	detectorIndex (size_t roiIndex) const
size_t	roiIndex (size_t detectorIndex) const
size_t	roiSize () const
size_t	detectorSize () const
bool	isInROI (size_t detectorIndex) const
std::unique_ptr< IAxis >	clipAxisToRoi (size_t axis_index, const IAxis &axis) const
virtual void	transferToCPP ()

Private Member Functions
	RegionOfInterest (double xlow, double ylow, double xup, double yup)
	RegionOfInterest (const RegionOfInterest &other)
size_t	xcoord (size_t index, const std::vector< size_t > &dims) const
size_t	ycoord (size_t index, const std::vector< size_t > &dims) const
void	initFrom (const IAxis &x_axis, const IAxis &y_axis)

Private Attributes
std::unique_ptr< Rectangle >	m_rectangle
size_t	m_ax1
size_t	m_ay1
size_t	m_ax2
size_t	m_ay2
size_t	m_glob_index0
std::vector< size_t >	m_detector_dims
std::vector< size_t >	m_roi_dims

Detailed Description

Defines rectangular area for the detector which will be simulated/fitted.

Definition at line 30 of file RegionOfInterest.h.

Constructor & Destructor Documentation

RegionOfInterest() [1/4]

RegionOfInterest::RegionOfInterest	(	const IDetector2D &	detector,
		double	xlow,
		double	ylow,
		double	xup,
		double	yup
	)

Definition at line 19 of file RegionOfInterest.cpp.

    : RegionOfInterest(xlow, ylow, xup, yup)
{
    initFrom(detector.getAxis(0), detector.getAxis(1));
}

References IDetector::getAxis(), and initFrom().

Referenced by clone().

Here is the call graph for this function:

RegionOfInterest() [2/4]

RegionOfInterest::RegionOfInterest	(	const OutputData< double > &	data,
		double	xlow,
		double	ylow,
		double	xup,
		double	yup
	)

Definition at line 26 of file RegionOfInterest.cpp.

    : RegionOfInterest(xlow, ylow, xup, yup)
{
    if (data.getRank() != 2)
        throw Exceptions::RuntimeErrorException("RegionOfInterest::RegionOfInterest() -> Error. "
                                                "Data is not two-dimensional.");
 
    initFrom(data.getAxis(0), data.getAxis(1));
}

References OutputData< T >::getAxis(), OutputData< T >::getRank(), and initFrom().

Here is the call graph for this function:

~RegionOfInterest()

RegionOfInterest::~RegionOfInterest ( )

default

RegionOfInterest() [3/4]

RegionOfInterest::RegionOfInterest ( double  xlow, double  ylow, double  xup, double  yup  )

private

Definition at line 37 of file RegionOfInterest.cpp.

    : m_rectangle(new Rectangle(xlow, ylow, xup, yup)), m_ax1(0), m_ay1(0), m_ax2(0), m_ay2(0),
      m_glob_index0(0)
{
}

RegionOfInterest() [4/4]

RegionOfInterest::RegionOfInterest ( const RegionOfInterest &  other )

private

Definition at line 50 of file RegionOfInterest.cpp.

    : ICloneable(), m_rectangle(other.m_rectangle->clone()), m_ax1(other.m_ax1), m_ay1(other.m_ay1),
      m_ax2(other.m_ax2), m_ay2(other.m_ay2), m_glob_index0(other.m_glob_index0),
      m_detector_dims(other.m_detector_dims), m_roi_dims(other.m_roi_dims)
{
}

Member Function Documentation

operator=()

RegionOfInterest& RegionOfInterest::operator= ( const RegionOfInterest &  other )

delete

clone()

RegionOfInterest * RegionOfInterest::clone ( ) const

virtual

Implements ICloneable.

Definition at line 43 of file RegionOfInterest.cpp.

{
    return new RegionOfInterest(*this);
}

References RegionOfInterest().

Referenced by IDetector2D::IDetector2D().

Here is the call graph for this function:

getXlow()

double RegionOfInterest::getXlow

(

)

const

Definition at line 57 of file RegionOfInterest.cpp.

{
    return m_rectangle->getXlow();
}

References m_rectangle.

Referenced by SimulationToPython::defineDetector(), and initFrom().

getYlow()

double RegionOfInterest::getYlow

(

)

const

Definition at line 62 of file RegionOfInterest.cpp.

{
    return m_rectangle->getYlow();
}

References m_rectangle.

Referenced by SimulationToPython::defineDetector(), and initFrom().

getXup()

double RegionOfInterest::getXup

(

)

const

Definition at line 67 of file RegionOfInterest.cpp.

{
    return m_rectangle->getXup();
}

References m_rectangle.

Referenced by SimulationToPython::defineDetector(), and initFrom().

getYup()

double RegionOfInterest::getYup

(

)

const

Definition at line 72 of file RegionOfInterest.cpp.

{
    return m_rectangle->getYup();
}

References m_rectangle.

Referenced by SimulationToPython::defineDetector(), and initFrom().

detectorIndex()

size_t RegionOfInterest::detectorIndex

(

size_t

roiIndex

)

const

Converts roi index to the detector index.

Definition at line 77 of file RegionOfInterest.cpp.

{
    return m_glob_index0 + ycoord(roiIndex, m_roi_dims)
           + xcoord(roiIndex, m_roi_dims) * m_detector_dims[1];
}

References m_detector_dims, m_glob_index0, m_roi_dims, roiIndex(), xcoord(), and ycoord().

Referenced by SimulationArea::detectorIndex(), and isInROI().

Here is the call graph for this function:

roiIndex()

size_t RegionOfInterest::roiIndex

(

size_t

detectorIndex

)

const

Converts global detector index to ROI index.

Definition at line 83 of file RegionOfInterest.cpp.

{
    size_t ny = ycoord(globalIndex, m_detector_dims);
    if (ny < m_ay1 || ny > m_ay2)
        throw Exceptions::RuntimeErrorException("RegionOfInterest::roiIndex() -> Error.");
 
    size_t nx = xcoord(globalIndex, m_detector_dims);
    if (nx < m_ax1 || nx > m_ax2)
        throw Exceptions::RuntimeErrorException("RegionOfInterest::roiIndex() -> Error.");
 
    return ny - m_ay1 + (nx - m_ax1) * m_roi_dims[1];
}

References m_ax1, m_ax2, m_ay1, m_ay2, m_detector_dims, m_roi_dims, xcoord(), and ycoord().

Referenced by detectorIndex().

Here is the call graph for this function:

roiSize()

size_t RegionOfInterest::roiSize

(

)

const

Number of detector bins in ROI area.

Definition at line 96 of file RegionOfInterest.cpp.

{
    return m_roi_dims[0] * m_roi_dims[1];
}

References m_roi_dims.

Referenced by SimulationArea::SimulationArea().

detectorSize()

size_t RegionOfInterest::detectorSize

(

)

const

Number of detector bins.

Definition at line 101 of file RegionOfInterest.cpp.

{
    return m_detector_dims[0] * m_detector_dims[1];
}

References m_detector_dims.

isInROI()

bool RegionOfInterest::isInROI

(

size_t

detectorIndex

)

const

Definition at line 106 of file RegionOfInterest.cpp.

{
    size_t ny = ycoord(detectorIndex, m_detector_dims);
    if (ny < m_ay1 || ny > m_ay2)
        return false;
    size_t nx = xcoord(detectorIndex, m_detector_dims);
    if (nx < m_ax1 || nx > m_ax2)
        return false;
    return true;
}

References detectorIndex(), m_ax2, m_ay2, m_detector_dims, xcoord(), and ycoord().

Here is the call graph for this function:

clipAxisToRoi()

std::unique_ptr< IAxis > RegionOfInterest::clipAxisToRoi	(	size_t	axis_index,
		const IAxis &	axis
	)		const

Definition at line 117 of file RegionOfInterest.cpp.

{
    size_t nbin1 = (axis_index == 0 ? m_ax1 : m_ay1);
    size_t nbin2 = (axis_index == 0 ? m_ax2 : m_ay2);
    return std::unique_ptr<IAxis>(new FixedBinAxis(
        axis.getName(), nbin2 - nbin1 + 1, axis.getBin(nbin1).m_lower, axis.getBin(nbin2).m_upper));
}

References IAxis::getBin(), IAxis::getName(), m_ax1, m_ax2, m_ay1, m_ay2, Bin1D::m_lower, and Bin1D::m_upper.

Here is the call graph for this function:

xcoord()

size_t RegionOfInterest::xcoord ( size_t  index, const std::vector< size_t > &  dims  ) const

inlineprivate

Definition at line 80 of file RegionOfInterest.h.

{
    return index / dims[1] % dims[0];
}

Referenced by detectorIndex(), isInROI(), and roiIndex().

ycoord()

size_t RegionOfInterest::ycoord ( size_t  index, const std::vector< size_t > &  dims  ) const

inlineprivate

Definition at line 85 of file RegionOfInterest.h.

{
    return index % dims[1];
}

Referenced by detectorIndex(), isInROI(), and roiIndex().

initFrom()

void RegionOfInterest::initFrom ( const IAxis &  x_axis, const IAxis &  y_axis  )

private

Definition at line 125 of file RegionOfInterest.cpp.

{
    m_detector_dims.push_back(x_axis.size());
    m_detector_dims.push_back(y_axis.size());
 
    m_ax1 = x_axis.findClosestIndex(getXlow());
    m_ax2 = x_axis.findClosestIndex(getXup());
    m_ay1 = y_axis.findClosestIndex(getYlow());
    m_ay2 = y_axis.findClosestIndex(getYup());
 
    m_roi_dims.push_back(m_ax2 - m_ax1 + 1);
    m_roi_dims.push_back(m_ay2 - m_ay1 + 1);
 
    m_glob_index0 = m_ay1 + m_ax1 * m_detector_dims[1];
}

References IAxis::findClosestIndex(), getXlow(), getXup(), getYlow(), getYup(), m_ax1, m_ax2, m_ay1, m_ay2, m_detector_dims, m_glob_index0, m_roi_dims, and IAxis::size().

Referenced by RegionOfInterest().

Here is the call graph for this function:

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 34 of file ICloneable.h.

Member Data Documentation

m_rectangle

std::unique_ptr<Rectangle> RegionOfInterest::m_rectangle

private

Definition at line 71 of file RegionOfInterest.h.

Referenced by getXlow(), getXup(), getYlow(), and getYup().

m_ax1

size_t RegionOfInterest::m_ax1

private

Number of bins on detector axes corresponding to roi-rectangle.

Definition at line 73 of file RegionOfInterest.h.

Referenced by clipAxisToRoi(), initFrom(), and roiIndex().

m_ay1

size_t RegionOfInterest::m_ay1

private

Definition at line 73 of file RegionOfInterest.h.

Referenced by clipAxisToRoi(), initFrom(), and roiIndex().

m_ax2

size_t RegionOfInterest::m_ax2

private

Definition at line 73 of file RegionOfInterest.h.

Referenced by clipAxisToRoi(), initFrom(), isInROI(), and roiIndex().

m_ay2

size_t RegionOfInterest::m_ay2

private

Definition at line 73 of file RegionOfInterest.h.

Referenced by clipAxisToRoi(), initFrom(), isInROI(), and roiIndex().

m_glob_index0

size_t RegionOfInterest::m_glob_index0

private

Detector global index corresponding to the lower left corner of ROI.

Definition at line 75 of file RegionOfInterest.h.

Referenced by detectorIndex(), and initFrom().

m_detector_dims

std::vector<size_t> RegionOfInterest::m_detector_dims

private

Definition at line 76 of file RegionOfInterest.h.

Referenced by detectorIndex(), detectorSize(), initFrom(), isInROI(), and roiIndex().

m_roi_dims

std::vector<size_t> RegionOfInterest::m_roi_dims

private

Definition at line 77 of file RegionOfInterest.h.

Referenced by detectorIndex(), initFrom(), roiIndex(), and roiSize().

---

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

• /home/www/ba/Device/Detector/RegionOfInterest.h
• /home/www/ba/Device/Detector/RegionOfInterest.cpp