omas.omas_plot

plotting ODS methods and utilities

---

Functions

add_to__ALL__(f)
add_to__ODS__(f)	anything wrapped here will be available as a ODS method with name 'plot_'+f.__name__
bolometer_overlay(ods[, ax, ...])	Overlays bolometer chords
cached_add_subplot(fig, ax_cache, *args, **kw)	Utility function that works like matplotlib add_subplot but reuses axes if these were already used before
charge_exchange_overlay(ods[, ax, which_pos])	Overlays Charge Exchange Recombination (CER) spectroscopy channel locations
core_profiles_currents_summary(ods[, ...])	Plot currents in core_profiles_1d
core_profiles_pressures(ods[, time_index, ...])	Plot pressures in ods['core_profiles']['profiles_1d'][time_index]
core_profiles_summary(ods[, time_index, ...])	Plot densities and temperature profiles for electrons and all ion species as per ods['core_profiles']['profiles_1d'][time_index]
core_sources_summary(ods[, time_index, ...])	Plot sources for electrons and all ion species
core_transport_fluxes(ods[, time_index, ...])	Plot densities and temperature profiles for all species, rotation profile, TGYRO fluxes and fluxes from power_balance per STEP state.
ec_launchers_CX(ods[, time_index, time, ax, ...])	Plot EC launchers in poloidal cross-section
ec_launchers_CX_topview(ods[, time_index, ...])	Plot EC launchers in toroidal cross-section
equilibrium_CX(ods[, time_index, time, ...])	Plot equilibrium cross-section as per ods['equilibrium']['time_slice'][time_index]
equilibrium_CX_topview(ods[, time_index, ...])	Plot equilibrium toroidal cross-section as per ods['equilibrium']['time_slice'][time_index]
equilibrium_quality(ods[, fig])	Plot equilibrium convergence error and total Chi-squared as a function of time
equilibrium_summary(ods[, time_index, time, ...])	Plot equilibrium cross-section and P, q, P', FF' profiles as per ods['equilibrium']['time_slice'][time_index]
gas_arrow(ods, r, z[, direction, r2, z2, ...])	Draws an arrow pointing in from the gas inlet
gas_filter(label, which_gas)	Utility: processes the mask / which_gas selector for gas_injection_overlay
gas_injection_overlay(ods[, ax, ...])	Plots overlays of gas injectors
geo_type_lookup(geometry_type, subsys[, ...])	Given a geometry type code
get_channel_count(ods, hw_sys[, check_loc, ...])	Utility function for CX hardware overlays.
handle_time(ods, time_location, time_index, time)	Given either time_index or time returns both time_index and time consistent with one another NOTE: time takes precedence over time_index
imas_units_to_latex(unit)	converts units to a nice latex format for plot labels
interferometer_overlay(ods[, ax])	Plots overlays of interferometer chords.
label_shifter(n, kw)	Interprets label shift instructions
langmuir_probes_overlay(ods[, ax, ...])	Overlays Langmuir probe locations
lh_antennas_CX(ods[, time_index, time, ax, ...])	Plot LH antenna position in poloidal cross-section
lh_antennas_CX_topview(ods[, time_index, ...])	Plot LH antenna in toroidal cross-section
magnetics_bpol_probe_data(ods[, ...])	plot bpol_probe time traces and equilibrium constraints
magnetics_diamagnetic_flux_data(ods[, ...])	plot diamagnetic_flux time trace and equilibrium constraint
magnetics_flux_loop_data(ods[, ...])	plot flux_loop time traces and equilibrium constraints
magnetics_ip_data(ods[, ...])	plot ip time trace and equilibrium constraint
magnetics_overlay(ods[, ax, show_flux_loop, ...])	Plot magnetics on a tokamak cross section plot
nbi_summary(ods[, ax])	Plot summary of NBI power time traces
ods_time_plot(ods_plot_function, ods, ...)	Utility function for generating time dependent plots
overlay(ods[, ax, allow_autoscale, ...])	Plots overlays of hardware/diagnostic locations on a tokamak cross section plot
padded_extension(values_in, n, fill_value)	Forces values_in to be at least length n by appending copies of fill_value as needed :param values_in: scalar or 1D iterable
pellets_trajectory_CX(ods[, time_index, ...])	Plot pellets trajectory in poloidal cross-section
pellets_trajectory_CX_topview(ods[, ...])	Plot pellet trajectory in toroidal cross-section
pf_active_data(ods[, ...])	plot pf_active time traces
pf_active_overlay(ods[, ax])	Plots overlays of active PF coils.
plot_1d_equilbrium_quantity(ax, x, y, ...[, ...])
position_control_overlay(ods[, ax, t, ...])	Overlays position_control data
pulse_schedule_overlay(ods[, ax, t])	Overlays relevant data from pulse_schedule, such as position control
quantity(ods, key[, yname, xname, yunits, ...])	Provides convenient way to plot 1D quantities in ODS
summary(ods[, fig, quantity])	Plot summary time traces.
text_alignment_setup(n[, default_ha, default_va])	Interprets text alignment instructions :param n: int Number of labels that need alignment instructions
tf_b_field_tor_vacuum_r_data(ods[, ...])	plot b_field_tor_vacuum_r time trace and equilibrium constraint
thomson_scattering_overlay(ods[, ax])	Overlays Thomson channel locations
uband(x, y[, ax, fill_kw])	Given arguments x,y where either or both have uncertainties, plot x,y using pyplt.plot of the nominal values and surround it with with a shaded error band using matplotlib's fill_between and/or fill_betweenx.
uerrorbar(x, y[, ax])	Given arguments y or x,y where x and/or y have uncertainties, feed the appropriate terms to matplotlib's errorbar function.
use_subplot(fig, *args, **kw)	Same as add_subplot, but if the figure already has a subplot with key (args, kwargs) then it will simply make that subplot current and return it.
wall_overlay(ods[, ax, component_index, ...])	Plot walls on a tokamak cross section plot
waves_beam_CX(ods[, time_index, time, ax])	Plot waves beams in poloidal cross-section
waves_beam_profile(ods[, time_index, time, ...])	Plot 1d profiles of waves beams given quantity
waves_beam_summary(ods[, time_index, time, fig])	Plot waves beam summary: CX, power_density, and current_parallel_density

Classes

Uband(line, bands)

This class wraps the line and PollyCollection(s) associated with a banded errorbar plot for use in the uband function.