resistics.project.shortcuts module

resistics.project.shortcuts.getCalibrator(calPath: str, config: Union[resistics.config.data.ConfigData, NoneType] = None) → resistics.calibrate.calibrator.Calibrator

Create a Calibnator object from calibration path and configuration information

Parameters

calPathstr

Path to calibration directory

configConfigData

Configuration data

Returns

Calibrator

A calibrator object

resistics.project.shortcuts.getDecimationParameters(sampleFreq: float, config: Union[resistics.config.data.ConfigData, NoneType] = None) → resistics.decimate.parameters.DecimationParameters

Create a DecimationParams object from sampling frequency and configuration information

Parameters

sampleFreqfloat

Sampling frequency of the data

configConfigData

Configuration data

Returns

DecimationParams

A decimation parameters object

resistics.project.shortcuts.getLocalRegressor(winSelector: resistics.window.selector.WindowSelector, outPath: str, config: Union[resistics.config.data.ConfigData, NoneType] = None) → resistics.regression.local.LocalRegressor

Create a ProcessorSingleSite object from a windowSelector object, outPath and config data

Parameters

winSelectorWindowSelector

Window selector with sites, masks etc already specified

tfPathstr

Path to output transfer function data

configConfigData, optional

Configuration data

Returns

LocalRegressor

local, single site regression

resistics.project.shortcuts.getRemoteRegressor(winSelector: resistics.window.selector.WindowSelector, outPath: str, config: Union[resistics.config.data.ConfigData, NoneType] = None) → resistics.regression.remote.RemoteRegressor

Create a ProcessorRemoteReference object from a windowSelector object, outPath and config data

Parameters

winSelectorWindowSelector

Window selector with sites, masks etc already specified

outPathstr

Path to output transfer function data

configConfigData, optional

Configuration data

Returns

RemoteRegression

Regression including a remote reference

resistics.project.shortcuts.getWindowParameters(decParams: resistics.decimate.parameters.DecimationParameters, config: Union[resistics.config.data.ConfigData, NoneType] = None) → resistics.window.parameters.WindowParameters

Create a WindowParams object from decimationParams and configuration data

Parameters

decParamsDecimationParams

DecimationParams object to hold the decimation parameters

configConfigData

Configuration data

Returns

WindowParams

A window parameters object

resistics.project.shortcuts.getWindowSelector(projData: resistics.project.data.ProjectData, decParams: resistics.decimate.parameters.DecimationParameters, winParams: resistics.window.parameters.WindowParameters, specdir: Union[str, NoneType] = None) → resistics.window.selector.WindowSelector

Create a WindowSelector object from projectData, decimationParams, windowParams

Parameters

projDataProjectData

A project data object

decParamsDecimationParams

DecimationParams object to hold the decimation parameters

winParamsWindowparams

WindowParams object to hold the windowing parameters

specdirstr

The spectra directory

Returns

WindowSelector

A window selector object