VFExtras

class plasmapy.analysis.swept_langmuir.floating_potential.VFExtras(

vf_err: float | None,

rsq: float | None,

fitted_func: float | None,

islands: list[slice] | None,

fitted_indices: slice | None,

)

Bases: NamedTuple

Create a tuple containing the extra parameters calculated by find_floating_potential.

Create new instance of VFExtras(vf_err, rsq, fitted_func, islands, fitted_indices)

Attributes Summary

fitted_func	Alias for field number 2, the fit-function fitted during the floating potential curve fit.
fitted_indices	Alias for field number 4, the indices used in the floating potential curve fit.
islands	Alias for field number 3, a list of slice objects representing the indices of the identified crossing-islands discovered during the floating potential curve fit.
rsq	Alias for field number 1, the r-squared value of the ion-saturation curve fit.
vf_err	Alias for field number 0, the error in the calculated floating potential from the floating potential curve fit.

Methods Summary

count(value, /)	Return number of occurrences of value.
index(value[, start, stop])	Return first index of value.

Attributes Documentation

fitted_func: float | None

Alias for field number 2, the fit-function fitted during the floating potential curve fit.

fitted_indices: slice | None

Alias for field number 4, the indices used in the floating potential curve fit.

islands: list[slice] | None

Alias for field number 3, a list of slice objects representing the indices of the identified crossing-islands discovered during the floating potential curve fit.

rsq: float | None

Alias for field number 1, the r-squared value of the ion-saturation curve fit.

vf_err: float | None

Alias for field number 0, the error in the calculated floating potential from the floating potential curve fit.

Methods Documentation

count(value, /)

Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.