resistics.mask.calculator module

class resistics.mask.calculator.MaskCalculator(projData: resistics.project.data.ProjectData, maskData: resistics.mask.data.MaskData, **kwargs)

Bases: resistics.common.base.ResisticsBase

Calculate window masking given constraints

Calculate masks for time windows. The window masker reads in statistics and writes out a file with windows which match the given constraints for each statistic. The masked file will then go into the window WindowSelector, which passes on shared windows to the processor.

Attributes

projProject

A Project object

maskDataMaskData

A MaskData object

specDirstr

The spectra directory

Methods

__init__(proj, maskData)	Initialise with a Project instance and MaskData instance
clearMaskWindows()	Clear calculated masks
applyConstraints(site)	Apply masking constraints
printList()	Class status returned as list of strings

applyConstraints(self, site: str) → None

Apply the masking constraints to find windows to be excluded

WindowsSelector will later exclude the masked windows before processing

Parameters

sitestr

The site in the project to mask

clearMaskWindows(self) → None

Clear mask windows in maskData object

printList(self) → List[str]

Class information as a list of strings

Returns

outlist

List of strings with information