solarwindpy.plotting.spiral.SpiralMesh

class SpiralMesh(x, y, initial_xedges, initial_yedges, min_per_bin=250)[source]

Bases: object

__init__(x, y, initial_xedges, initial_yedges, min_per_bin=250)[source]
property bin_id
property cat

pd.Categorical version of bin_id, with fill bin removed.

property data
property initial_edges
property mesh
property min_per_bin
property cell_filter_thresholds
property cell_filter

Boolean Series identifying properly filled mesh cells.

Series selects mesh cells that meet density and area criteria specified by mesh_cell_filter_thresholds().

Notes

Neither density nor size convert log-scale edges into linear scale. Doing so would overweight the area of mesh cells at larger values on a given axis.

set_cell_filter_thresholds(**kwargs)[source]

Set or update the mesh_cell_filter_thresholds().

Parameters:
  • density (scalar) – The density quantile above which we want to select bins, e.g. above the 0.01 quantile. This ensures that each bin meets some sufficient fill factor.

  • size (scalar) – The size quantile below which we want to select bins, e.g. below the 0.99 quantile. This ensures that the bin isn’t so large that it will appear as an outlier.

set_initial_edges(xedges, yedges)[source]
set_data(x, y)[source]
set_min_per_bin(new)[source]
initialize_bins()[source]
static process_one_spiral_step(bins, x, y, min_per_bin)[source]
generate_mesh()[source]
calculate_bin_number()[source]
place_spectra_in_mesh()[source]
build_cat()[source]