Skip to main content

Analysis package for QUAK/ESR runs

Project description

QUAK/ESR analysis utility

This is work in progress.

This repository contains a collection of classes and utilities to handle and work with QUAK/ESR data files.

Installation

pip install quakesranalysis-tspspi

Upgrading

pip install --upgrade quakesranalysis-tspspi

Utilities

quakesrplot

The quakesrplot is capable of generating standard plots for single peak scans and 1D scans. Those include:

  • iqmean is just a standard plot of the mean values and standard deviations of all captured I/Q samples in scan, zero scan and difference
  • apmean calculated amplitude and phase out of I/Q samples and plots them for scan, zero scan and difference
  • wndnoise provides a sliding window noise calculation by calculating the standard deviation inside this configurable sliding window to show how noise changes over time.
  • offsettime plots the offset of all three captured signal types over time
  • allan calculates the Allan deviation of the system for all samples points along the main axis (frequency, B0, ...) as well as a worst case Allan deviation
  • decompose decomposes the found signal, zero signal and difference signal into a mixture of Gaussians (this can be inspected by setting decomposedebug)
  • mixfit does the same as decompose but for more different function types (Gaussian, Cauchy, Difference of Gaussian, Difference of Cauchy, Constant, ...). Inspection of the fitting behaviour is also possible using mixfitdebug
  • metrics outputs collected metrics into a JSON data file. This should be run at the end.

All plots are stored along the source datafile and named with the same prefix.

Example usage:

quakesrplot -iqmean -apmean -wndnoise 10 -wndnoise 3 -offsettime -mixfit -allan *_peak.npz 

To see a list of all supported features execute without arguments:

quakesrplot

When outputting debug plots for decompose or mixfit the QtAgg backend of matplotlib tends to crash sometimes. One can then launch the application using a different backend such as TkAgg on via the MPLBACKEND environment variable:

env MPLBACKEND=tkagg quakesrplot -iqmean -apmean -wndnoise 10 -wndnoise 3 -offsettime -mixfitdebug -allan *_peak.npz 

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quakesranalysis-tspspi-0.0.6.tar.gz (23.0 kB view hashes)

Uploaded Source

Built Distribution

quakesranalysis_tspspi-0.0.6-py3-none-any.whl (24.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page