SimulationAreaIterator Class Reference

Description

An iterator for SimulationArea.

Definition at line 30 of file SimulationAreaIterator.h.

Collaboration diagram for SimulationAreaIterator:

Public Types
enum	Mode { regionOfInterest , notMasked }
	Mode how the points shall be traversed. More...

Public Member Functions
SimulationAreaIterator	createEnd () const
	Convenience function to create an end-iterator matching to this iterator. More...
size_t	detectorIndex () const
bool	operator!= (const SimulationAreaIterator &right) const
SimulationAreaIterator &	operator++ ()
	prefix increment More...
bool	operator== (const SimulationAreaIterator &other) const
size_t	roiIndex () const

Static Public Member Functions
static SimulationAreaIterator	createBegin (const IDetector *detector, Mode mode)
	Create begin-iterator to iterate over all points according to the given mode. More...
static SimulationAreaIterator	createEnd (const IDetector *detector, Mode mode)
	Create end-iterator to iterate over all points according to the given mode. More...

Private Member Functions
	SimulationAreaIterator (const IDetector *detector, Mode mode, size_t start_at_index)
bool	isMasked (size_t index) const
	Check whether masked according to the actual mode (always false if mode is regionOfInterest). index is an ROI index. More...
size_t	nextIndex (size_t currentIndex)

Private Attributes
const IDetector *	m_detector
size_t	m_index
	ROI related index. More...
size_t	m_maxIndex
	ROI related maximum index. More...
Mode	m_mode

Member Enumeration Documentation

Mode

enum SimulationAreaIterator::Mode

Mode how the points shall be traversed.

Enumerator
regionOfInterest	iterate over all points in "region of interest", no matter whether masked
notMasked	iterate over all points in "region of interest" and not masked

Definition at line 33 of file SimulationAreaIterator.h.

              {
        regionOfInterest, //!< iterate over all points in "region of interest", no matter whether
                          //!< masked
        notMasked         //!< iterate over all points in "region of interest" and not masked
    };

Constructor & Destructor Documentation

SimulationAreaIterator()

SimulationAreaIterator::SimulationAreaIterator ( const IDetector *  detector, Mode  mode, size_t  start_at_index  )

explicitprivate

Definition at line 18 of file SimulationAreaIterator.cpp.

    : m_detector(detector)
    , m_index(start_at_index)
    , m_maxIndex(m_detector->sizeOfRegionOfInterest())
    , m_mode(mode)
{
    if (m_index > m_maxIndex)
        throw std::runtime_error("SimulationAreaIterator::SimulationAreaIterator() "
                                 "-> Error. Invalid initial index");
 
    if (m_index != m_maxIndex && isMasked(m_index))
        m_index = nextIndex(m_index);
}

References isMasked(), m_index, m_maxIndex, and nextIndex().

Referenced by createBegin(), and createEnd().

Here is the call graph for this function:

Member Function Documentation

createBegin()

SimulationAreaIterator SimulationAreaIterator::createBegin ( const IDetector *  detector, Mode  mode  )

static

Create begin-iterator to iterate over all points according to the given mode.

Definition at line 33 of file SimulationAreaIterator.cpp.

{
    return SimulationAreaIterator(detector, mode, 0);
}

References SimulationAreaIterator().

Referenced by IDetector::beginNonMaskedPoints(), and IDetector::beginRegionOfInterestPoints().

Here is the call graph for this function:

createEnd() [1/2]

SimulationAreaIterator SimulationAreaIterator::createEnd

(

)

const

Convenience function to create an end-iterator matching to this iterator.

Definition at line 43 of file SimulationAreaIterator.cpp.

{
    return createEnd(m_detector, m_mode);
}

References m_detector, and m_mode.

Referenced by IDetector::endNonMaskedPoints(), and IDetector::endRegionOfInterestPoints().

createEnd() [2/2]

SimulationAreaIterator SimulationAreaIterator::createEnd ( const IDetector *  detector, Mode  mode  )

static

Create end-iterator to iterate over all points according to the given mode.

Definition at line 38 of file SimulationAreaIterator.cpp.

{
    return SimulationAreaIterator(detector, mode, detector->sizeOfRegionOfInterest());
}

References SimulationAreaIterator(), and IDetector::sizeOfRegionOfInterest().

Here is the call graph for this function:

detectorIndex()

size_t SimulationAreaIterator::detectorIndex

(

)

const

Definition at line 53 of file SimulationAreaIterator.cpp.

{
    return m_detector->regionOfInterestIndexToDetectorIndex(m_index);
}

References m_detector, m_index, and IDetector::regionOfInterestIndexToDetectorIndex().

Referenced by IDetector::active_indices(), and isMasked().

Here is the call graph for this function:

isMasked()

bool SimulationAreaIterator::isMasked ( size_t  index ) const

private

Check whether masked according to the actual mode (always false if mode is regionOfInterest). index is an ROI index.

Definition at line 84 of file SimulationAreaIterator.cpp.

{
    if (m_mode == regionOfInterest)
        return false;
 
    const auto* masks = m_detector->detectorMask();
    const auto detectorIndex = m_detector->regionOfInterestIndexToDetectorIndex(index);
    return (masks && masks->isMasked(detectorIndex));
}

References detectorIndex(), IDetector::detectorMask(), m_detector, m_mode, regionOfInterest, and IDetector::regionOfInterestIndexToDetectorIndex().

Referenced by SimulationAreaIterator(), and nextIndex().

Here is the call graph for this function:

nextIndex()

size_t SimulationAreaIterator::nextIndex ( size_t  currentIndex )

private

Definition at line 67 of file SimulationAreaIterator.cpp.

{
    // #baROI + this can be optimized: Check whether a RegionOfInterest is present, then do not
    // check every single point
 
    size_t result = ++currentIndex;
    if (result >= m_maxIndex)
        return m_maxIndex;
 
    while (isMasked(result)) {
        ++result;
        if (result == m_maxIndex)
            break;
    }
    return result;
}

References isMasked(), and m_maxIndex.

Referenced by SimulationAreaIterator(), and operator++().

Here is the call graph for this function:

operator!=()

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

inline

Definition at line 79 of file SimulationAreaIterator.h.

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

operator++()

SimulationAreaIterator & SimulationAreaIterator::operator++

(

)

prefix increment

Definition at line 58 of file SimulationAreaIterator.cpp.

{
    size_t index = nextIndex(m_index);
    if (index != m_index)
        m_index = index;
 
    return *this;
}

References m_index, and nextIndex().

Here is the call graph for this function:

operator==()

bool SimulationAreaIterator::operator== ( const SimulationAreaIterator &  other ) const

inline

Definition at line 74 of file SimulationAreaIterator.h.

{
    return m_detector == other.m_detector && m_index == other.m_index && m_mode == other.m_mode;
}

References m_detector, m_index, and m_mode.

roiIndex()

size_t SimulationAreaIterator::roiIndex

(

)

const

Definition at line 48 of file SimulationAreaIterator.cpp.

{
    return m_index;
}

References m_index.

Referenced by IDetector::applyDetectorResolution().

Member Data Documentation

m_detector

const IDetector* SimulationAreaIterator::m_detector

private

Definition at line 68 of file SimulationAreaIterator.h.

Referenced by createEnd(), detectorIndex(), isMasked(), and operator==().

m_index

size_t SimulationAreaIterator::m_index

private

ROI related index.

Definition at line 69 of file SimulationAreaIterator.h.

Referenced by SimulationAreaIterator(), detectorIndex(), operator++(), operator==(), and roiIndex().

m_maxIndex

size_t SimulationAreaIterator::m_maxIndex

private

ROI related maximum index.

Definition at line 70 of file SimulationAreaIterator.h.

Referenced by SimulationAreaIterator(), and nextIndex().

m_mode

Mode SimulationAreaIterator::m_mode

private

Definition at line 71 of file SimulationAreaIterator.h.

Referenced by createEnd(), isMasked(), and operator==().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Detector/SimulationAreaIterator.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Detector/SimulationAreaIterator.cpp