DetectorMask Class Reference

Description

Collection of detector masks.

Definition at line 42 of file DetectorMask.h.

Collaboration diagram for DetectorMask:

Public Member Functions
	DetectorMask (const DetectorMask &other)
	DetectorMask (const IAxis &xAxis, const IAxis &yAxis)
	~DetectorMask ()
void	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. More...
bool	hasMasks () const
	Returns true if has masks. More...
bool	isMasked (size_t index) const
int	numberOfMaskedChannels () const
size_t	numberOfMasks () const
DetectorMask &	operator= (const DetectorMask &other)
const MaskPattern *	patternAt (size_t iMask) const

Private Member Functions
void	process_masks ()

Private Attributes
std::vector< bool >	m_masked
int	m_number_of_masked_channels
OwningVector< MaskPattern >	m_stack
const IAxis *	m_xAxis
const IAxis *	m_yAxis

Constructor & Destructor Documentation

DetectorMask() [1/2]

DetectorMask::DetectorMask	(	const IAxis &	xAxis,
		const IAxis &	yAxis
	)

Definition at line 35 of file DetectorMask.cpp.

    : m_xAxis(xAxis.clone())
    , m_yAxis(yAxis.clone())
    , m_masked(xAxis.size() * yAxis.size(), false)
{
}

~DetectorMask()

DetectorMask::~DetectorMask ( )

default

DetectorMask() [2/2]

DetectorMask::DetectorMask

(

const DetectorMask &

other

)

Definition at line 44 of file DetectorMask.cpp.

    : m_xAxis(other.m_xAxis->clone())
    , m_yAxis(other.m_yAxis->clone())
    , m_stack(other.m_stack)
    , m_masked(other.m_masked)
    , m_number_of_masked_channels(other.m_number_of_masked_channels)
{
}

Member Function Documentation

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 63 of file DetectorMask.cpp.

{
    m_stack.emplace_back(new MaskPattern(shape.clone(), mask_value));
    process_masks();
}

References IShape2D::clone(), OwningVector< T >::emplace_back(), m_stack, and process_masks().

Here is the call graph for this function:

hasMasks()

bool DetectorMask::hasMasks

(

)

const

Returns true if has masks.

Definition at line 74 of file DetectorMask.cpp.

{
    return !m_stack.empty();
}

References OwningVector< T >::empty(), and m_stack.

Here is the call graph for this function:

isMasked()

bool DetectorMask::isMasked

(

size_t

index

)

const

Definition at line 69 of file DetectorMask.cpp.

{
    return m_number_of_masked_channels == 0 ? false : m_masked[i_flat];
}

References m_masked, and m_number_of_masked_channels.

numberOfMaskedChannels()

int DetectorMask::numberOfMaskedChannels ( ) const

inline

Definition at line 60 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 79 of file DetectorMask.cpp.

{
    return m_stack.size();
}

References m_stack, and OwningVector< T >::size().

Here is the call graph for this function:

operator=()

DetectorMask & DetectorMask::operator=

(

const DetectorMask &

other

)

Definition at line 53 of file DetectorMask.cpp.

{
    if (this != &other) {
        m_stack = other.m_stack;
        m_masked = other.m_masked;
        m_number_of_masked_channels = other.m_number_of_masked_channels;
    }
    return *this;
}

References m_masked, m_number_of_masked_channels, and m_stack.

patternAt()

const MaskPattern * DetectorMask::patternAt

(

size_t

iMask

)

const

Definition at line 84 of file DetectorMask.cpp.

{
    return m_stack.at(iMask);
}

References OwningVector< T >::at(), and m_stack.

Here is the call graph for this function:

process_masks()

void DetectorMask::process_masks ( )

private

Definition at line 89 of file DetectorMask.cpp.

{
    m_number_of_masked_channels = 0;
    m_masked.clear();
    m_masked.resize(m_xAxis->size() * m_yAxis->size(), false);
 
    if (m_stack.empty())
        return;
 
    m_number_of_masked_channels = 0;
    for (size_t i_flat = 0; i_flat < m_masked.size(); ++i_flat) {
        Bin1D binx = m_xAxis->bin((i_flat / m_yAxis->size()) % m_xAxis->size());
        Bin1D biny = m_yAxis->bin(i_flat % m_yAxis->size());
        // setting mask to the data starting from last shape added
        bool is_masked(false);
        for (int k = m_stack.size() - 1; k >= 0; --k) {
            const MaskPattern* const pat = m_stack[k];
            if (pat->shape->contains(binx, biny)) {
                if (pat->doMask)
                    is_masked = true;
                m_masked[i_flat] = pat->doMask;
                break; // i_flat is covered by the shape, stop looking further
            }
        }
        if (is_masked)
            ++m_number_of_masked_channels;
    }
}

References IAxis::bin(), IShape2D::contains(), MaskPattern::doMask, OwningVector< T >::empty(), m_masked, m_number_of_masked_channels, m_stack, m_xAxis, m_yAxis, MaskPattern::shape, OwningVector< T >::size(), and IAxis::size().

Referenced by addMask().

Here is the call graph for this function:

Member Data Documentation

m_masked

std::vector<bool> DetectorMask::m_masked

private

Definition at line 77 of file DetectorMask.h.

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

m_number_of_masked_channels

int DetectorMask::m_number_of_masked_channels

private

Definition at line 78 of file DetectorMask.h.

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

m_stack

OwningVector<MaskPattern> DetectorMask::m_stack

private

Definition at line 73 of file DetectorMask.h.

Referenced by addMask(), hasMasks(), numberOfMasks(), operator=(), patternAt(), and process_masks().

m_xAxis

const IAxis* DetectorMask::m_xAxis

private

Definition at line 71 of file DetectorMask.h.

Referenced by process_masks().

m_yAxis

const IAxis* DetectorMask::m_yAxis

private

Definition at line 72 of file DetectorMask.h.

Referenced by process_masks().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Mask/DetectorMask.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Mask/DetectorMask.cpp