SpacePhysicsMakie.jl

tplot(f, tas; legend=(; position=Right()), link_xaxes=true, link_yaxes=false, rowgap=5, kwargs...)

Lay out multiple time series across different panels (rows) on one Figure / GridPosition f

If legend is nothing, no legend will be added to the plot. Otherwise, legend can be a NamedTuple containing options for legend placement and styling. By default, the time series are transformed via extensible transform.

See also: tplot_panel, transform

tplot_panel(gp, args...; kwargs...)

Generic entry point for plotting different types of data on a grid position gp.

Transforms the arguments to appropriate types and calls the plotting function. Dispatches to appropriate implementation based on the plotting trait of the transformed arguments.

tplot_panel!(ax, args...; kwargs...)

Generic entry point for adding plots to an existing axis ax.

Transforms the arguments to appropriate types and calls the plotting function. Dispatches to appropriate implementation based on the plotting trait of the transformed arguments.

transform(args...; kwargs...)

Transform data into plottable format (e.g., DimArray).

Extend with transform(x::MyType) for custom types.

DEFAULTS

A global constant that holds default parameters:

• add_title::Bool defaults to false.
• add_colorbar::Bool defaults to true.
• delay : in seconds, the time interval between updates. Default is 0.25.
• resample::Int : the number of points to resample to. Default is 6070.

Union type for drawable containers that can hold plots

Union type for data that can be plotted as multiple series

Union type for data types supported by the plotting system

Debouncer

A struct that creates a debounced version of a function f.

The debounced function will only execute after a specified delay (in seconds) of inactivity. If called again before the delay expires, the timer resets.

FunctionPlot is the plot type associated with plotting function functionplot. Check the docstring for functionplot for further information.

HAPISchema <: MetadataSchema

Schema for HAPI (Heliophysics Application Programmer's Interface) metadata.

References

• HAPI Data Access Specification

ISTPSchema <: MetadataSchema

Schema for ISTP-compliant metadata.

References

• ISTP Global Attributes
• ISTP Variables

MadrigalSchema <: MetadataSchema

Schema for Madrigal database metadata.

MetadataSchema

Abstract type for defining how metadata keys map to plot attributes. Each concrete schema defines the mapping rules for a specific metadata standard.

MultiAxisData(primary, secondaries...; metadata=nothing)

A type for handling multiple y-axes where the first element is the primary axis (left) and subsequent elements are secondary axes (right side, with increasing padding).

Fields

• primary: Data for the primary (left) y-axis
• secondaries: Tuple of data for secondary (right) y-axes
• metadata: Optional metadata (e.g., title)

Example

# Three axes: one primary, two secondary
data = MultiAxisData(y1_data, y2_data, y3_data)
tplot(data)

Schema for PySPEDAS Tplot Variable metadata.

SpecPlot is the plot type associated with plotting function specplot. Check the docstring for specplot for further information.

_intersect(d, itr...)

Find common key-value pairs across multiple dictionaries dicts. Only includes pairs where the key exists in all dictionaries with the same value.

_linear_binedges(centers)

Calculate bin edges assuming linear spacing.

Add labels to a figure, automatically searching for blocks to label.

Notes

• https://github.com/brendanjohnharris/Foresight.jl/blob/main/src/Layouts.jl#L2

Add labels to a grid of layouts

Notes

• See tag_facet in egg for reference

Only add legend when the axis contains multiple labels

Only add legend when the axis contains multiple labels

auto_figure_size(tas)

Calculate an appropriate figure size based on the number of plots in the list. Returns a tuple of (width, height) in pixels.

Get axis attributes for x

binedges(centers; transform=identity)

Calculate bin edges from bin centers.

• For linear spacing, edges are placed halfway between centers.
• For transformed spacing, edges are placed halfway between transformed centers.

Arguments

• transform: Function to transform the space (e.g., log for logarithmic spacing)

Example

centers = [1.0, 2.0, 3.0]
edges = binedges(centers)               # Returns [0.5, 1.5, 2.5, 3.5]
edges = binedges(centers, transform=log)  # Returns edges in log space

centers_or_edges(x; transform=identity)

Get a compatible bin edges or centers for plotting with transform

Reference: Makie.edges

clabel(A; multiline=true, schema=get_schema(A))

Get the colorbar label for data using the metadata schema.

Get the default orientation for a legend based on the position

default_palette(x)

Generate a default palette for positioning plots in a grid. Returns an iterator of (row, column) tuples for each item in x.

No docstring defined.

Plot type

The plot type alias for the functionplot function is FunctionPlot.

Attributes

plotfunc = tplot_panel! — No docs available.

functionplot! is the mutating variant of plotting function functionplot. Check the docstring for functionplot for further information.

functionplot!(ax, f, tmin, tmax; kwargs...)

Interactive plot of a function f on ax for a time range from tmin to tmax

functionplot(gp, f, tmin, tmax; kwargs...)

Interactively plot a function over a time range on a grid position

get_schema(data)

Get the appropriate metadata schema for the data.

heatmap_attributes(A; kwargs...)

Extract heatmap attributes from metadata using the schema-based approach.

isspectrogram(A::AbstractMatrix; threshold=8, schema=get_schema(A))

Determine if data should be plotted as a spectrogram using the metadata schema.

labels(x; schema=get_schema(x))

Get the labels for data using the metadata schema.

linesplot(gp, ta)

Plot a multivariate time series on a panel

Create and configure a secondary y-axis

Metadata key mappings for ISTP schema. Returns a NamedTuple with keys corresponding to plot attributes.

Create figure automatically

multiaxisplot(gp, primary, secondaries...; pad_increment = 50.0, [colors, styles, plottypes, axis], kwargs...)

Create a plot with one primary y-axis (left) for primary and multiple secondary y-axes (right) for secondaries....

Each secondary axis is offset to the right with increasing padding of pad_increment to avoid overlap.

Attributes

• colors: Vector of colors for each axis (default: Wong color palette)
• styles: Vector of NamedTuples with plot attributes for each secondary axis
• plottypes: Plot types to use, a single type would be broadcasted to all axes

multiplot!(ax, fs, t0, t1; plotfunc=plot2spec, kwargs...)

Specialized multiplot function for functionplot. Merge specs before plotting so as to cycle through them.

multiplot(gp, tas::MultiPlottable, args...; axis=(;), kwargs...)

Setup the panel on a position and plot multiple time series on it

Determine the plotting function for a given data type. Extend this for custom data types to integrate with the plotting system.

Determine the plotting function for a given data type. Extend this for custom data types to integrate with the plotting system.

prioritized_get(container, keys, default=nothing)

Extract a value from a container using a prioritized list of keys. Returns the first non-nothing value found, or default if none found.

resample(arr, n=DEFAULTS.resample; dim=1, verbose=false)

Resample an array along the dimension dim to n points. If the original length is less than or equal to n, the original array is returned unchanged.

No docstring defined.

Plot type

The plot type alias for the specplot function is SpecPlot.

Attributes

specplot! is the mutating variant of plotting function specplot. Check the docstring for specplot for further information.

Plot heatmap of a time series on the same axis

specplot(gp, ta)

Plot a spectrogram on a panel

tlims!(ax, tmin, tmax)
tlims!(tmin, tmax)
tlims!(trange)

Set axis limits, handling different time formats. Supports DateTime, Unitful, and numeric time values.

Add vertical lines to a plot

tplot(f, tas; legend=(; position=Right()), link_xaxes=true, link_yaxes=false, rowgap=5, kwargs...)

Lay out multiple time series across different panels (rows) on one Figure / GridPosition f

If legend is nothing, no legend will be added to the plot. Otherwise, legend can be a NamedTuple containing options for legend placement and styling. By default, the time series are transformed via extensible transform.

See also: tplot_panel, transform

tplot_panel!(ax, args...; kwargs...)

Generic entry point for adding plots to an existing axis ax.

Transforms the arguments to appropriate types and calls the plotting function. Dispatches to appropriate implementation based on the plotting trait of the transformed arguments.

tplot_panel(gp, args...; kwargs...)

Generic entry point for plotting different types of data on a grid position gp.

Transforms the arguments to appropriate types and calls the plotting function. Dispatches to appropriate implementation based on the plotting trait of the transformed arguments.

tplot_panel_s!(ax::Axis, data; kwargs...)

Plot data on an axis.

transform(args...; kwargs...)

Transform data into plottable format (e.g., DimArray).

Extend with transform(x::MyType) for custom types.

Convert x to DateTime

Reference:

• https://docs.makie.org/dev/explanations/dim-converts#Makie.DateTimeConversion
• https://github.com/MakieOrg/Makie.jl/issues/442
• https://github.com/MakieOrg/Makie.jl/blob/master/src/dim-converts/dates-integration.jl