API Reference#

Objects#

Parameter

Analogous to the parameters used by MeaVis.

File

Defines a loaded HDF file.

Dataset

Data container.

Fitter

Fitting object.

FitResult

Fit results container for a single file.

PPMSAnalysis

Loads PPMS data and implements methods to analyse the data.

Resonator

Container of a CPW resonator's parameter.

ResonatorAttribution

Resonator attribution takes the fit results and tries to attribute the resonance peaks to physical resonators present on the feedline.

Plotting functions#

Plot results quickly using these plotting helper functions.

plot_triptych

Plots the magnitude vs frequency, the phase vs frequency and the complex data in a single figure.

plot_quality_factors

Plots the quality factors \(Q_i\) and \(Q_c\) as a function of average photon number in the resonator \((\tilde n)\).

plot_losses

Plots the losses \(\delta_i\) and \(\delta_c\) as a function of average photon number in the resonator \((\tilde n)\).

plot_magnetic_field

Plots the internal quality factor (\(Q_i\)) as a function of the parallel magnetic field (\(B_\parallel\)).

Utils#

convert_complex_to_magphase

Converts real and imaginary data into magnitude (dBm) and phase.

convert_magphase_to_complex

Converts magnitude and phase data into real and imaginary.

str_to_time

Converts the time format from the MeaVis' HDF5 files into a datetime timestamp.