BornAgain  1.19.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)
 
void addMask (const IShape2D &shape, bool mask_value)
 Add mask to the stack of detector masks. More...
 
Histogram2DcreateHistogram () const
 
const OutputData< bool > * getMaskData () const
 
const IShape2D * getMaskShape (size_t mask_index, bool &mask_value) const
 
bool hasMasks () const
 returns true if has masks
 
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
 
int numberOfMaskedChannels () const
 
size_t numberOfMasks () const
 
DetectorMaskoperator= (const DetectorMask &other)
 

Detailed Description

Collection of detector masks.

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