solarwindpy.instabilities.verscharen2016.StabilityCondition

class StabilityCondition(growth_rate, beta, anisotropy)

Bases: object

Evaluate plasma stability using the Verscharen et al. fits.

Parameters:

• growth_rate (int) – Index of the growth-rate table to use (-2, -3 or -4).

• beta (pandas.Series) – Parallel proton beta.

• anisotropy (pandas.Series) – Temperature anisotropy.

instability_thresholds

Threshold anisotropies for each instability.

Type:

pandas.DataFrame

is_unstable

Boolean mask indicating unstable modes.

Type:

pandas.DataFrame

stability_bin

Integer label describing the dominant instability.

Type:

pandas.Series

__init__(growth_rate, beta, anisotropy)

Initialize the object.

Parameters:

• growth_rate (int) – Growth rate index (-2, -3 or -4).

• beta (pandas.Series) – Arrays of parallel beta and temperature anisotropy.

• anisotropy (pandas.Series) – Arrays of parallel beta and temperature anisotropy.

property fill

Used to build data containers and check all entries are visited.

property instability_parameters

The Pandas DataFrame of instability parameters.

property data

DataFrame with beta and anisotropy measurements.

property beta

The beta values of the object.

property anisotropy

The anisotropy values of the object.

property stability_map

The map of ints to strings identifying the instabilities.

property stability_map_inverse

The inverse of stability_map.

property instability_thresholds

The value of the anisotropy for which the plasma goes unstable.

property instability_tests

The tests used for each instability threshold.

The keys are "AIC", "MM", "FMW", and "OFI" for Alfven/Ion-Cyclotron, Mirror Mode, Fast Magnetosonic / Whistler, and Oblique Firehose. The values are NumPy ufuncs.

property is_unstable

Boolean DataFrame indicating instability to a given instability.

property stability_bin

The integer corresponding to the (in)stability condition.

property cmap

A linearly segmented colormap for the (in)stability condition.

property norm

The normalization instance used for plotting the stability bin.

property cbar_kwargs

Keyword arguments for drawing a colorbar.

set_instability_parameters(growth_rate)

Take the instability parameters corresponding to growth_rate.

Parameters:

growth_rate (int) – Growth-rate index (-2, -3 or -4).

set_beta_ani(beta, anisotropy)

Set the beta and anisotropy values.

calculate_stability_criteria()

Run the full instability calculation.

This method calls _calc_instability_thresholds(), _calc_is_unstable(), and _calc_stability_bin() in that order. Use this method over calling the private methods individually.