API doc¶

Classes¶

Main Classes¶

`Pulse`	Represents a general experimental pulse.
`Criteria`	A class for defining criteria for terminating experiments. This should
`Parameter`	Represents a sequence or pulse parameter.
`Sequence`	Represents an experimental pulse sequence.

Analysis Modules¶

`FieldSweepAnalysis`	Analysis and calculation of FieldSweep Experiment.
`ResonatorProfileAnalysis`	Analysis and calculation of resonator profiles.
`CarrPurcellAnalysis`	Analysis and calculation of Carr Purcell decay.
`ReptimeAnalysis`	Analysis and calculation of Reptime based saturation recovery.
`RefocusedEcho2DAnalysis`	Analysis and calculation of Refocused Echo 2D data.
`DEERanalysis`(dataset[, compactness, model, ROI, ...])

Sequences¶

`DEERSequence`	Represents a DEER/PELDOR sequence.
`HahnEchoSequence`	Represents a Hahn-Echo sequence.
`T2RelaxationSequence`	Represents a T2 relaxation sequence. A Hahn Echo where the interpulse delay increases
`FieldSweepSequence`	Represents a Field Sweep (EDFS) sequence.
`ReptimeScan`	Represents a reptime scan of a Hahn Echo Sequence.
`CarrPurcellSequence`	Represents a Carr-Purcell sequence.
`RefocusedEcho2DSequence`	Represents a 2D Refocused-echo Sequence.
`ResonatorProfileSequence`	Builds nutation based Resonator Profile sequence.
`TWTProfileSequence`	Builds TWT based Resonator Profile sequence.

Pulses¶

`Pulse`	Represents a general experimental pulse.
`Detection`	Represents a detection pulse.
`Delay`	DEPRECATION WARNING: THIS WILL BE REMOVED SOON.
`RectPulse`	Represents a rectangular monochromatic pulse.
`GaussianPulse`	Represents a Gaussian monochromatic pulse.
`HSPulse`	Represents a hyperboilc secant frequency-swept pulse.
`ChirpPulse`	Represents a linear frequency-swept pulse.
`SincPulse`	Represents a general experimental pulse.

Termination Criteria¶

`Criteria`	A class for defining criteria for terminating experiments. This should
`TimeCriteria`	A class for defining criteria for terminating experiments. This should
`SNRCriteria`	A class for defining criteria for terminating experiments. This should
`DEERCriteria`	A class for defining criteria for terminating experiments. This should

Utilities¶

`EPRAccessor`
`Reporter`

Interfaces¶

`Interface`	Represents the interface connection from autoEPR to the spectrometer.
`BrukerAWG`	Represents the interface for connecting to AWG based Bruker ELEXSYS-II
`BrukerMPFU`	Represents the interface for connecting to MPFU based Bruker ELEXSYS-II
`XeprAPILink`
`ETH_awg_interface`	Represents the interface for connecting to Andrin Doll style spectrometers.

Functions¶

Plotting¶

`DEERanalysis_plot`(fit, background[, ROI, axs, fig, text])	DEERanalysis_plot Generates a figure showing both the time domain and
`DEERanalysis_plot_pub`(results[, ROI, fig, axs])	Generates a vertical plot of the DEER analysis results, ready for publication.
`plot_overlap`(Fieldsweep, pump_pulse, exc_pulse, ref_pulse)	Plots the pump and excitation profiles as well as the fieldsweep and filter profile.

Optimisation¶

`optimise_pulses`(Fieldsweep, pump_pulse, exc_pulse[, ...])	Optimise the pulse positions to maximise the pump-exc overlap.
`calc_deer_settings`(experiment[, CPdecay, Refocused2D, ...])	Calculates the optimal DEER settings based on the avaliable relaxation data
`calc_correction_factor`(fit_result[, aim_MNR, aim_time])	Calculate the correction factor for the number of averages required to achieve a given MNR in a given time.
`build_default_pulses`([AWG, SPFU, tp])
`optimise_spectra_position`(resonator_profile, fieldsweep)

I/O¶

`eprload`(path[, experiment, type])	A general versions of eprload
`save_file`(path, str)
`create_dataset_from_sequence`(data, sequence[, ...])
`create_dataset_from_axes`(data, axes[, params, axes_labels])
`create_dataset_from_bruker`(filepath)

Utilities¶

`transpose_dict_of_list`(d)	Turns a dictionary of lists into a list of dictionaries.
`transpose_list_of_dicts`(d)	Turns a list of dictionaries into a dictionary of lists.
`round_step`(value, step)
`normalise_01`(A)	Normalizes the input vector A to be between 0 and 1.
`gcd`(values)	Generates the greatest common dividor on a list of floats
`sop`(spins, comps)	Spin Operator Matricies.
`write_pulsespel_file`(sequence, d0[, AWG, MPFU, MaxGate])	Write the pulsespel file for a given sequence.