SimulationArea Class Reference

Inheritance diagram for SimulationArea:

Collaboration diagram for SimulationArea:

Public Types
using	iterator = SimulationAreaIterator

Public Member Functions
	SimulationArea (const IDetector *detector)
virtual	~SimulationArea ()
SimulationAreaIterator	begin ()
SimulationAreaIterator	end ()
virtual bool	isMasked (size_t index) const
size_t	totalSize () const
size_t	roiIndex (size_t index) const
size_t	detectorIndex (size_t index) const

Protected Attributes
const IDetector *	m_detector
size_t	m_max_index

Detailed Description

Holds iteration logic over active detector channels in the presence of masked areas and RegionOfInterest defined.

Definition at line 26 of file SimulationArea.h.

Member Typedef Documentation

iterator

using SimulationArea::iterator = SimulationAreaIterator

Definition at line 29 of file SimulationArea.h.

Constructor & Destructor Documentation

SimulationArea()

SimulationArea::SimulationArea ( const IDetector *  detector )

explicit

Definition at line 22 of file SimulationArea.cpp.

                                                        : m_detector(detector), m_max_index(0)
{
    if (m_detector == nullptr)
        throw std::runtime_error("SimulationArea::SimulationArea: null pointer passed"
                                 " as detector");
 
    if (m_detector->dimension() == 0)
        throw std::runtime_error(
            "SimulationArea::SimulationArea: detector of unspecified dimensionality");
 
    if (m_detector->regionOfInterest())
        m_max_index = m_detector->regionOfInterest()->roiSize();
    else
        m_max_index = m_detector->totalSize();
}

References IDetector::dimension(), m_detector, m_max_index, IDetector::regionOfInterest(), RegionOfInterest::roiSize(), and IDetector::totalSize().

Here is the call graph for this function:

~SimulationArea()

virtual SimulationArea::~SimulationArea ( )

inlinevirtual

Definition at line 31 of file SimulationArea.h.

{}

Member Function Documentation

begin()

SimulationAreaIterator SimulationArea::begin

(

)

Definition at line 38 of file SimulationArea.cpp.

{
    return SimulationAreaIterator(this, 0);
}

Referenced by IDetector2D::active_indices(), and IDetector::iterate().

end()

SimulationAreaIterator SimulationArea::end

(

)

Definition at line 43 of file SimulationArea.cpp.

{
    return SimulationAreaIterator(this, totalSize());
}

References totalSize().

Referenced by IDetector2D::active_indices(), and IDetector::iterate().

Here is the call graph for this function:

isMasked()

bool SimulationArea::isMasked ( size_t  index ) const

virtual

returns true if given iterator index correspond to masked detector channel

Reimplemented in SimulationRoiArea.

Definition at line 48 of file SimulationArea.cpp.

{
    auto masks = m_detector->detectorMask();
    return (masks && masks->hasMasks() && masks->isMasked(detectorIndex(index)));
}

References detectorIndex(), IDetector::detectorMask(), and m_detector.

Referenced by SimulationAreaIterator::nextIndex(), and SimulationAreaIterator::SimulationAreaIterator().

Here is the call graph for this function:

totalSize()

size_t SimulationArea::totalSize ( ) const

inline

Definition at line 52 of file SimulationArea.h.

{
    return m_max_index;
}

References m_max_index.

Referenced by end(), SimulationAreaIterator::nextIndex(), and SimulationAreaIterator::SimulationAreaIterator().

roiIndex()

size_t SimulationArea::roiIndex

(

size_t

index

)

const

Return index in ROI map from iterator index.

Definition at line 54 of file SimulationArea.cpp.

{
    return index;
}

Referenced by SimulationAreaIterator::roiIndex().

detectorIndex()

size_t SimulationArea::detectorIndex

(

size_t

index

)

const

Return detector index from iterator index.

Definition at line 59 of file SimulationArea.cpp.

{
    if (!m_detector->regionOfInterest())
        return index;
 
    return m_detector->regionOfInterest()->detectorIndex(index);
}

References RegionOfInterest::detectorIndex(), m_detector, and IDetector::regionOfInterest().

Referenced by SimulationAreaIterator::detectorIndex(), and isMasked().

Here is the call graph for this function:

Member Data Documentation

m_detector

const IDetector* SimulationArea::m_detector

protected

Definition at line 48 of file SimulationArea.h.

Referenced by detectorIndex(), isMasked(), and SimulationArea().

m_max_index

size_t SimulationArea::m_max_index

protected

Definition at line 49 of file SimulationArea.h.

Referenced by SimulationArea(), and totalSize().

---

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

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