BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
DetectorMask Class Reference

Collection of detector masks. More...

Public Member Functions

 DetectorMask (const DetectorMask &other)
 
DetectorMaskoperator= (const DetectorMask &other)
 
void addMask (const IShape2D &shape, bool mask_value)
 Add mask to the stack of detector masks. More...
 
void initMaskData (const IDetector2D &detector)
 Init the map of masks for the given detector plane.
 
void initMaskData (const OutputData< double > &data)
 
bool isMasked (size_t index) const
 
const OutputData< bool > * getMaskData () const
 
Histogram2DcreateHistogram () const
 
void removeMasks ()
 remove all masks and return object to initial state
 
bool hasMasks () const
 returns true if has masks
 
int numberOfMaskedChannels () const
 
size_t numberOfMasks () const
 
const IShape2DgetMaskShape (size_t mask_index, bool &mask_value) const
 

Detailed Description

Collection of detector masks.

Definition at line 28 of file DetectorMask.h.

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
shapeThe shape of mask.
mask_valueThe value of mask

Definition at line 41 of file DetectorMask.cpp.


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