API reference¶
Resistics is made up of a number of sub packages that deal with different functions or data types, such as time data, frequency data, statistic data and more. Detailed information about each can be found in the relevant sections.
For most users, the API functionality of interest will be in project, which holds methods for interacting with resistics projects.
common¶
Methods in the common are used across the package. They include utility functions for print, checking io, plotting and more.
time¶
Methods and classes in time relate to reading, writing, holding and processing of time data.
- resistics.time package
- Submodules
- resistics.time.clean module
- resistics.time.data module
- resistics.time.filter module
- resistics.time.interp module
- resistics.time.math module
- resistics.time.reader module
- resistics.time.reader_ascii module
- resistics.time.reader_ats module
- resistics.time.reader_internal module
- resistics.time.reader_lemib423 module
- resistics.time.reader_lemib423e module
- resistics.time.reader_phoenix module
- resistics.time.reader_spam module
- resistics.time.utils module
- resistics.time.writer module
- resistics.time.writer_ascii module
- resistics.time.writer_internal module
- Module contents
- Submodules
spectra¶
Methods and classes in spectra deal with calculating fourier spectra, frequency data reading and writing and spectra data objects.
statistics¶
statistics provides functionality for calculating local site and remote reference statistics, statistic reading and writing and statistic data objects.
mask¶
mask data in resistics is used to remove windows from further processing. It provides classes for taking in statistic data together with constraints and finding the windows which fail the constraints.
regression¶
Methods and classes in regression use the frequency data to estimate transfer functions.
transfunc¶
Methods and classes in transfunc deal with the input and output of transfer function data and provide data objects for transfer function data.
project¶
project provides methods for interacting with resistics projects. For most users, these are the most interesting methods and APIs.
- resistics.project package
- Submodules
- resistics.project.data module
- resistics.project.io module
- resistics.project.mask module
- resistics.project.preprocess module
- resistics.project.shortcuts module
- resistics.project.spectra module
- resistics.project.statistics module
- resistics.project.time module
- resistics.project.transfunc module
- resistics.project.utils module
- Module contents
- Submodules
window¶
Window parameters, timeseries windowing and window selection functionality is provided in window.