resistics.project.transfunc module

resistics.project.transfunc.getTransferFunctionData(projData: resistics.project.data.ProjectData, site: str, sampleFreq: float, **kwargs) → resistics.transfunc.data.TransferFunctionData

Get transfer function data

Parameters

projDataprojecData

The project data

sitestr

Site to get the transfer functiond data for

sampleFreqint, float

The sampling frequency for which to get the transfer function data

specdirstr, optional

The spectra directories used

postpendstr, optional

The postpend on the transfer function files

resistics.project.transfunc.processProject(projData: resistics.project.data.ProjectData, **kwargs) → None

Process a project

Parameters

projDataProjectData

The project data instance for the project

sitesList[str], optional

List of sites

sampleFreqsList[float], optional

List of sample frequencies to process

specdirstr, optional

The spectra directories to use

inchansList[str], optional

Channels to use as the input of the linear system

inputsitestr, optional

Site from which to take the input channels. The default is to use input and output channels from the same site

outchansList[str], optional

Channels to use as the output of the linear system

remotesitestr, optional

The site to use as the remote site

remotechansList[str], optional

Channels to use from the remote reference site

crosschannelsList[str], optional

List of channels to use for cross powers

masksDict, optional

Masks dictionary for passing mask data. The key should be a site name and the value should either be a string for a single mask or a list of multiple masks.

datetimesList, optional

List of datetime constraints, each one as a dictionary. For example [{“type”: “datetime”, “start”: 2018-08-08 00:00:00, “end”: 2018-08-08 16:00:00, “levels”: [0,1]}]. Note that levels is optional.

postpendstr, optional

String to postpend to the transfer function output

ncoresint, optional

The number of cores to run the transfer function calculations on

resistics.project.transfunc.processSite(projData: resistics.project.data.ProjectData, site: str, sampleFreq: Union[int, float], **kwargs)

Process a single sampling frequency for a site

The site passed is assumed to be the output site (the output channels will come from this site). If channels from a different site are desired to be used as the input channels, this can be done by specifying the optional inputsite argument.

Todo

Give a few different examples here

Parameters

projDataProjectData

The project data instance for the project

sitestr

Site to process

sampleFreqfloat, int

Sample frequency to process

specdirstr, optional

The spectra directories to use

inchansList[str], optional

Channels to use as the input of the linear system

inputsitestr, optional

Site from which to take the input channels. The default is to use input and output channels from the same site

outchansList[str], optional

Channels to use as the output of the linear system

remotesitestr, optional

The site to use as the remote site

remotechansList[str], optional

Channels to use from the remote reference site

crosschannelsList[str], optional

List of channels to use for cross powers

masksDict, optional

Masks dictionary for passing mask data. The key should be a site name and the value should either be a string for a single mask or a list of multiple masks.

datetimesList, optional

List of datetime constraints, each one as a dictionary. For example [{“type”: “datetime”, “start”: 2018-08-08 00:00:00, “end”: 2018-08-08 16:00:00, “levels”: [0,1]}]. Note that levels is optional.

postpendstr, optional

String to postpend to the transfer function output

ncoresint, optional

The number of cores to run the transfer function calculations on

resistics.project.transfunc.viewImpedance(projData: resistics.project.data.ProjectData, **kwargs) → List[matplotlib.figure.Figure]

View impedance tensor data

Parameters

projDataprojecData

The project data

sitesList[str], optional

List of sites to plot transfer functions for

sampleFreqsList[float], optional

List of samples frequencies for which to plot transfer functions

polarisationsList[str], optional

A list of polarisations to plot. For example, [“ExHx”, “ExHy”, “EyHx”, “EyHy”]

specdirstr, optional

The spectra directories used

postpendstr, optional

The postpend on the transfer function files

oneplotbool, optional

Plot the polarisation on a single plot

showbool, optional

Show the spectra plot

savebool, optional

Save the plot to the images directory

plotoptionsDict

A dictionary of plot options. For example, set the resistivity y limits using res_ylim, set the phase y limits using phase_ylim and set the xlimits using xlim

resistics.project.transfunc.viewTipper(projData: resistics.project.data.ProjectData, **kwargs) → List[matplotlib.figure.Figure]

View transfer function data

Parameters

projDataprojecData

The project data

sitesList[str], optional

List of sites to plot transfer functions for

sampleFreqsList[float], optional

List of samples frequencies for which to plot transfer functions

specdirstr, optional

The spectra directories used

postpendstr, optional

The postpend on the transfer function files

colsbool, optional

Boolean flag, True to arrange tipper plot as 1 row with 3 columns

showbool, optional

Show the spectra plot

savebool, optional

Save the plot to the images directory

plotoptionsDict

A dictionary of plot options. For example, set the resistivity y limits using res_ylim, set the phase y limits using phase_ylim and set the xlimits using xlim