BornAgain  1.19.79
Open-source research software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering
DetectorMask Class Reference

Description

Collection of detector masks.

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
 
DetectorMaskoperator= (const DetectorMask &other)
 
const MaskPatternpatternAt (size_t iMask) const
 

Constructor & Destructor Documentation

◆ DetectorMask() [1/2]

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

◆ ~DetectorMask()

DetectorMask::~DetectorMask ( )

◆ DetectorMask() [2/2]

DetectorMask::DetectorMask ( const DetectorMask other)

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

◆ hasMasks()

bool DetectorMask::hasMasks ( ) const

Returns true if has masks.

◆ isMasked()

bool DetectorMask::isMasked ( size_t  index) const

◆ numberOfMaskedChannels()

int DetectorMask::numberOfMaskedChannels ( ) const

◆ numberOfMasks()

size_t DetectorMask::numberOfMasks ( ) const

◆ operator=()

DetectorMask& DetectorMask::operator= ( const DetectorMask other)

◆ patternAt()

const MaskPattern* DetectorMask::patternAt ( size_t  iMask) const