resistics.project.mask module¶
-
resistics.project.mask.calculateMask(projData: resistics.project.data.ProjectData, maskData: resistics.mask.data.MaskData, **kwargs)[source]¶ Calculate masks sites
- Parameters
- projDataprojectData
A project instance
- maskDataMaskData
A mask data instance
- sitesList[str], optional
A list of sites to calculate masks for
- specdirstr, optional
The spectra directory for which to calculate statistics
-
resistics.project.mask.getMaskData(projData: resistics.project.data.ProjectData, site: str, maskName: str, sampleFreq: Union[float, int], **kwargs) → resistics.mask.data.MaskData[source]¶ Get a mask data object
- Parameters
- projDataprojectData
A project instance
- sitestr
The site for which to get the mask
- maskNamestr
The name of the mask
- sampleFreqint, float
The sampling frequency for which the mask was created
- specdirstr
The spectra directory for which the mask was created
- Returns
- MaskData
A mask data object with the mask information
-
resistics.project.mask.newMaskData(projData: resistics.project.data.ProjectData, sampleFreq: float) → resistics.mask.data.MaskData[source]¶ Get a mask data object that can then be passed onto calculateMask
- Parameters
- projDataProjectData
A ProjectData instance
- sampleFreqfloat
The sampling frequency to mask
- Returns
- MaskData
A mask data object with parameters set