Important

The Analysis and Diagnostic framework is in active development at the moment. For the foreseeable future, the API will be in continuous flux as functionality is added and modified. To follow the package development please visit our GitHub Project ( https://github.com/PlasmaPy/PlasmaPy/projects/19 ) and comment on any of the relevant issues and/or pull requests.

Swept Langmuir Analysis Module

Subpackage containing routines for analyzing swept Langmuir probe traces.

Example Notebooks

Swept Langmuir Analysis: Floating Potential

API

Sub-Packages & Modules

`floating_potential`	Functionality for determining the floating potential of a Langmuir sweep.
`helpers`	Helper functions for analyzing swept Langmuir traces.
`ion_saturation_current`	Functionality for determining the ion-saturation current of a Langmuir sweep.

Classes

`ISatExtras`(rsq, fitted_func, fitted_indices)	Create a `tuple` containing the extra parameters calculated by `find_ion_saturation_current`.
`VFExtras`(vf_err, rsq, fitted_func, islands, ...)	Create a `tuple` containing the extra parameters calculated by `find_floating_potential`.

Inheritance diagram of plasmapy.analysis.swept_langmuir.ion_saturation_current.ISatExtras, plasmapy.analysis.swept_langmuir.floating_potential.VFExtras

Functions

`check_sweep`(voltage, current[, strip_units])	Function for checking that the voltage and current arrays are properly formatted for analysis by `plasmapy.analysis.swept_langmuir`.
`find_floating_potential`(voltage, current[, ...])	Determine the floating potential (\(V_f\)) for a given current-voltage (IV) curve obtained from a swept Langmuir probe.
`find_ion_saturation_current`(voltage, current, *)	Determines the ion-saturation current (\(I_{sat}\)) for a given current-voltage (IV) curve obtained from a swept Langmuir probe.

Aliases

PlasmaPy provides aliases of the most common plasma functionality for user convenience. Aliases in PlasmaPy are denoted with a trailing underscore (e.g., alias_). For further details, please refer to the contributor guide’s section on aliases.

`find_isat_`(voltage, current, *[, fit_type, ...])	Alias to `find_ion_saturation_current()`.
`find_vf_`(voltage, current[, threshold, ...])	Alias to `find_floating_potential()`.