DetectorMask Class Reference

Collaboration diagram for DetectorMask:

Public Member Functions
	DetectorMask ()
	DetectorMask (const DetectorMask &other)
DetectorMask &	operator= (const DetectorMask &other)
void	addMask (const IShape2D &shape, bool mask_value)
void	initMaskData (const IDetector2D &detector)
void	initMaskData (const OutputData< double > &data)
bool	isMasked (size_t index) const
const OutputData< bool > *	getMaskData () const
Histogram2D *	createHistogram () const
void	removeMasks ()
bool	hasMasks () const
int	numberOfMaskedChannels () const
size_t	numberOfMasks () const
const IShape2D *	getMaskShape (size_t mask_index, bool &mask_value) const

Private Member Functions
void	process_masks ()

Private Attributes
SafePointerVector< IShape2D >	m_shapes
std::vector< bool >	m_mask_of_shape
OutputData< bool >	m_mask_data
int	m_number_of_masked_channels

Detailed Description

Collection of detector masks.

Definition at line 28 of file DetectorMask.h.

Constructor & Destructor Documentation

DetectorMask() [1/2]

DetectorMask::DetectorMask

(

)

Definition at line 19 of file DetectorMask.cpp.

: m_number_of_masked_channels(0) {}

DetectorMask() [2/2]

DetectorMask::DetectorMask

(

const DetectorMask &

other

)

Definition at line 21 of file DetectorMask.cpp.

    : m_shapes(other.m_shapes), m_mask_of_shape(other.m_mask_of_shape),
      m_number_of_masked_channels(other.m_number_of_masked_channels)
{
    m_mask_data.copyFrom(other.m_mask_data);
}

References OutputData< T >::copyFrom(), and m_mask_data.

Here is the call graph for this function:

Member Function Documentation

operator=()

DetectorMask & DetectorMask::operator=

(

const DetectorMask &

other

)

Definition at line 28 of file DetectorMask.cpp.

{
    if (this != &other) {
        m_shapes = other.m_shapes;
        m_mask_of_shape = other.m_mask_of_shape;
        m_mask_data.copyFrom(other.m_mask_data);
        m_number_of_masked_channels = other.m_number_of_masked_channels;
        //        DetectorMask tmp(other);
        //        tmp.swapContent(*this);
    }
    return *this;
}

References OutputData< T >::copyFrom(), m_mask_data, m_mask_of_shape, m_number_of_masked_channels, and m_shapes.

Here is the call graph for this function:

addMask()

void DetectorMask::addMask	(	const IShape2D &	shape,
		bool	mask_value
	)

Add mask to the stack of detector masks.

The value "true" means that the area will be excluded from the analysis.

Parameters

shape	The shape of mask.
mask_value	The value of mask

Definition at line 41 of file DetectorMask.cpp.

{
    m_shapes.push_back(shape.clone());
    m_mask_of_shape.push_back(mask_value);
    m_mask_data.clear();
    m_number_of_masked_channels = 0;
}

References OutputData< T >::clear(), IShape2D::clone(), m_mask_data, m_mask_of_shape, m_number_of_masked_channels, m_shapes, and SafePointerVector< T >::push_back().

Referenced by IDetector2D::addMask().

Here is the call graph for this function:

initMaskData() [1/2]

void DetectorMask::initMaskData

(

const IDetector2D &

detector

)

Init the map of masks for the given detector plane.

Definition at line 49 of file DetectorMask.cpp.

{
    if (detector.dimension() != 2)
        throw Exceptions::RuntimeErrorException("DetectorMask::initMaskData() -> Error. Attempt "
                                                "to add masks to uninitialized detector.");
 
    ASSERT(m_shapes.size() == m_mask_of_shape.size());
    m_mask_data.clear();
 
    for (size_t dim = 0; dim < detector.dimension(); ++dim) {
        const IAxis& axis = detector.getAxis(dim);
        m_mask_data.addAxis(axis);
    }
 
    process_masks();
}

References OutputData< T >::addAxis(), ASSERT, OutputData< T >::clear(), IDetector::dimension(), IDetector::getAxis(), m_mask_data, m_mask_of_shape, m_shapes, process_masks(), and SafePointerVector< T >::size().

Referenced by IDetector2D::addMask(), IDetector2D::resetRegionOfInterest(), and IDetector2D::setRegionOfInterest().

Here is the call graph for this function:

initMaskData() [2/2]

void DetectorMask::initMaskData

(

const OutputData< double > &

data

)

Definition at line 66 of file DetectorMask.cpp.

{
    ASSERT(m_shapes.size() == m_mask_of_shape.size());
    m_mask_data.clear();
 
    for (size_t dim = 0; dim < data.getRank(); ++dim)
        m_mask_data.addAxis(data.getAxis(dim));
 
    process_masks();
}

References OutputData< T >::addAxis(), ASSERT, OutputData< T >::clear(), OutputData< T >::getAxis(), OutputData< T >::getRank(), m_mask_data, m_mask_of_shape, m_shapes, process_masks(), and SafePointerVector< T >::size().

Here is the call graph for this function:

isMasked()

bool DetectorMask::isMasked

(

size_t

index

)

const

Definition at line 77 of file DetectorMask.cpp.

{
    return m_number_of_masked_channels == 0 ? false : m_mask_data[index];
}

References m_mask_data, and m_number_of_masked_channels.

getMaskData()

const OutputData<bool>* DetectorMask::getMaskData ( ) const

inline

Definition at line 48 of file DetectorMask.h.

{ return &m_mask_data; }

References m_mask_data.

createHistogram()

Histogram2D * DetectorMask::createHistogram

(

)

const

Definition at line 82 of file DetectorMask.cpp.

{
    OutputData<double> data;
    data.copyShapeFrom(m_mask_data);
    for (size_t i = 0; i < m_mask_data.getAllocatedSize(); ++i)
        data[i] = static_cast<double>(m_mask_data[i]);
    return dynamic_cast<Histogram2D*>(IHistogram::createHistogram(data));
}

References OutputData< T >::copyShapeFrom(), IHistogram::createHistogram(), OutputData< T >::getAllocatedSize(), and m_mask_data.

Here is the call graph for this function:

removeMasks()

void DetectorMask::removeMasks

(

)

remove all masks and return object to initial state

Definition at line 91 of file DetectorMask.cpp.

{
    m_shapes.clear();
    m_mask_of_shape.clear();
    m_mask_data.clear();
}

References SafePointerVector< T >::clear(), OutputData< T >::clear(), m_mask_data, m_mask_of_shape, and m_shapes.

Referenced by IDetector2D::maskAll(), and IDetector2D::removeMasks().

Here is the call graph for this function:

hasMasks()

bool DetectorMask::hasMasks ( ) const

inline

returns true if has masks

Definition at line 56 of file DetectorMask.h.

{ return !m_shapes.empty(); }

References SafePointerVector< T >::empty(), and m_shapes.

Here is the call graph for this function:

numberOfMaskedChannels()

int DetectorMask::numberOfMaskedChannels ( ) const

inline

Definition at line 58 of file DetectorMask.h.

{ return m_number_of_masked_channels; }

References m_number_of_masked_channels.

numberOfMasks()

size_t DetectorMask::numberOfMasks

(

)

const

Definition at line 98 of file DetectorMask.cpp.

{
    return m_shapes.size();
}

References m_shapes, and SafePointerVector< T >::size().

Referenced by SimulationToPython::defineMasks(), and getMaskShape().

Here is the call graph for this function:

getMaskShape()

const IShape2D * DetectorMask::getMaskShape	(	size_t	mask_index,
		bool &	mask_value
	)		const

Definition at line 103 of file DetectorMask.cpp.

{
    if (mask_index >= numberOfMasks())
        return nullptr;
    mask_value = m_mask_of_shape[mask_index];
    return m_shapes[mask_index];
}

References m_mask_of_shape, m_shapes, and numberOfMasks().

Referenced by SimulationToPython::defineMasks().

Here is the call graph for this function:

process_masks()

void DetectorMask::process_masks ( )

private

Definition at line 111 of file DetectorMask.cpp.

{
    m_mask_data.setAllTo(false);
    if (!!m_shapes.empty())
        return;
 
    m_number_of_masked_channels = 0;
    for (size_t index = 0; index < m_mask_data.getAllocatedSize(); ++index) {
        Bin1D binx = m_mask_data.getAxisBin(index, 0);
        Bin1D biny = m_mask_data.getAxisBin(index, 1);
        // setting mask to the data starting from last shape added
        bool is_masked(false);
        for (size_t i_shape = m_shapes.size(); i_shape > 0; --i_shape) {
            const IShape2D* shape = m_shapes[i_shape - 1];
            if (shape->contains(binx, biny)) {
                if (m_mask_of_shape[i_shape - 1])
                    is_masked = true;
                m_mask_data[index] = m_mask_of_shape[i_shape - 1];
                break; // index is covered by the shape, stop looking further
            }
        }
        if (is_masked)
            ++m_number_of_masked_channels;
    }
}

References IShape2D::contains(), SafePointerVector< T >::empty(), OutputData< T >::getAllocatedSize(), OutputData< T >::getAxisBin(), m_mask_data, m_mask_of_shape, m_number_of_masked_channels, m_shapes, OutputData< T >::setAllTo(), and SafePointerVector< T >::size().

Referenced by initMaskData().

Here is the call graph for this function:

Member Data Documentation

m_shapes

SafePointerVector<IShape2D> DetectorMask::m_shapes

private

Definition at line 67 of file DetectorMask.h.

Referenced by addMask(), getMaskShape(), hasMasks(), initMaskData(), numberOfMasks(), operator=(), process_masks(), and removeMasks().

m_mask_of_shape

std::vector<bool> DetectorMask::m_mask_of_shape

private

Definition at line 68 of file DetectorMask.h.

Referenced by addMask(), getMaskShape(), initMaskData(), operator=(), process_masks(), and removeMasks().

m_mask_data

OutputData<bool> DetectorMask::m_mask_data

private

Definition at line 69 of file DetectorMask.h.

Referenced by addMask(), createHistogram(), DetectorMask(), getMaskData(), initMaskData(), isMasked(), operator=(), process_masks(), and removeMasks().

m_number_of_masked_channels

int DetectorMask::m_number_of_masked_channels

private

Definition at line 70 of file DetectorMask.h.

Referenced by addMask(), isMasked(), numberOfMaskedChannels(), operator=(), and process_masks().

---

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

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