BornAgain  1.19.79
Open-source research software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering
Public Member Functions | Public Attributes | List of all members
IDetector::RoiOfAxis Struct Reference

Description

Keeps RegionOfInterest (ROI) data of one axis.

Definition at line 228 of file IDetector.h.

Public Member Functions

 RoiOfAxis (const IAxis &axis, double lower, double upper)
 

Public Attributes

size_t detectorSize
 number of bins on axis of detector More...
 
double lower
 
size_t lowerIndex
 index corresponding to 'lower' More...
 
size_t roiSize
 number of bins on axis of ROI More...
 
double upper
 
size_t upperIndex
 index corresponding to 'upper' More...
 

Constructor & Destructor Documentation

◆ RoiOfAxis()

IDetector::RoiOfAxis::RoiOfAxis ( const IAxis &  axis,
double  lower,
double  upper 
)

Definition at line 315 of file IDetector.cpp.

316 {
317  lower = _lower;
318  upper = _upper;
319 
320  lowerIndex = axis.findClosestIndex(lower);
321  upperIndex = axis.findClosestIndex(upper);
322 
323  detectorSize = axis.size();
324  roiSize = upperIndex - lowerIndex + 1;
325 }
IAxis::findClosestIndex
virtual size_t findClosestIndex(double value) const =0
find bin index which is best match for given value
IAxis::size
virtual size_t size() const =0
Returns the number of bins.
IDetector::axis
const IAxis & axis(size_t index) const
One axis of the complete detector. Any region of interest is not taken into account.
Definition: IDetector.cpp:74
IDetector::RoiOfAxis::roiSize
size_t roiSize
number of bins on axis of ROI
Definition: IDetector.h:236
IDetector::RoiOfAxis::upperIndex
size_t upperIndex
index corresponding to 'upper'
Definition: IDetector.h:235
IDetector::RoiOfAxis::detectorSize
size_t detectorSize
number of bins on axis of detector
Definition: IDetector.h:237
IDetector::RoiOfAxis::lowerIndex
size_t lowerIndex
index corresponding to 'lower'
Definition: IDetector.h:234

References IDetector::axis(), detectorSize, IAxis::findClosestIndex(), lower, lowerIndex, roiSize, IAxis::size(), upper, and upperIndex.

Here is the call graph for this function:

Member Data Documentation

◆ detectorSize

size_t IDetector::RoiOfAxis::detectorSize

number of bins on axis of detector

Definition at line 237 of file IDetector.h.

Referenced by RoiOfAxis().

◆ lower

double IDetector::RoiOfAxis::lower

Definition at line 229 of file IDetector.h.

Referenced by RoiOfAxis().

◆ lowerIndex

size_t IDetector::RoiOfAxis::lowerIndex

index corresponding to 'lower'

Definition at line 234 of file IDetector.h.

Referenced by RoiOfAxis().

◆ roiSize

size_t IDetector::RoiOfAxis::roiSize

number of bins on axis of ROI

Definition at line 236 of file IDetector.h.

Referenced by RoiOfAxis().

◆ upper

double IDetector::RoiOfAxis::upper

Definition at line 230 of file IDetector.h.

Referenced by RoiOfAxis().

◆ upperIndex

size_t IDetector::RoiOfAxis::upperIndex

index corresponding to 'upper'

Definition at line 235 of file IDetector.h.

Referenced by RoiOfAxis().

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