API

Data Visualization

Visualisations.plot_phase_space — Function
plot_phase_space(
    ed::ExperimentData,
    var_type::Symbol;
    label,
    color,
    resolution,
    kwargs...
) -> Tuple{Makie.Figure, Vector}

Plot phase space of var_type for all trajectories in ed. var_type can be :states, :observables or :controls.

Arguments

  • ed::ExperimentData: ExperimentData object
  • var_type::Symbol: :states, :observables or :controls
  • color::Tuple: color of the lines. Default is (:orange, 0.1) where 0.1 is the alpha value.
  • resolution::Tuple: resolution of the figure. Default is nothing which means (length(labels)-1).*(1000, 1000) where labels is the labels of the var_type.
  • kwargs...: keyword arguments passed to Axis constructor

Returns

  • fig::Figure: Makie figure object
  • axs::Vector{Axis}: vector of Makie axis objects
source
plot_phase_space(
    Xs::AbstractVector{<:AbstractMatrix};
    ...
) -> Tuple{Makie.Figure, Vector}
plot_phase_space(
    Xs::AbstractVector{<:AbstractMatrix},
    labels;
    title,
    resolution,
    color,
    label,
    fontsize,
    kwargs...
) -> Tuple{Makie.Figure, Vector}

Arguments

  • Xs::AbstractVector{<:AbstractMatrix}: vector of matrices of size (m, n) where m is the number of dimensions and n is the number of timepoints.
  • labels::Vector: list of labels of the dimensions of length m.
  • color::Tuple: color of the lines. Default is (:orange, 0.1) where 0.1 is the alpha value.
  • label: label for the legend
  • resolution::Tuple: resolution of the figure. Default is nothing which means (ndims-1).*(1000, 1000) where ndims is the number of dimensions.
  • kwargs...: keyword arguments passed to Axis constructor
source
Visualisations.plot_phase_space! — Function
plot_phase_space!(
    fig::Makie.Figure,
    axs::AbstractVector{<:Makie.Axis},
    ed::ExperimentData,
    var_type::Symbol;
    color,
    label,
    kwargs...
) -> Tuple{Makie.Figure, AbstractVector{<:Makie.Axis}}

Plot phase space of var_type for all trajectories in ed. var_type can be :states, :observables or :controls.

Arguments

  • fig::Figure: Makie figure object
  • axs::Vector{Axis}: vector of Makie axis objects
  • ed::ExperimentData: ExperimentData object
  • var_type::Symbol: :states, :observables or :controls
  • color::Tuple: color of the lines. Default is (:orange, 0.1) where 0.1 is the alpha value.
  • kwargs...: keyword arguments passed to Axis constructor

Returns

  • fig::Figure: Makie figure object
  • axs::Vector{Axis}: vector of Makie axis objects
source
plot_phase_space!(
    fig::Makie.Figure,
    axs::AbstractVector{<:Makie.Axis},
    Xs::AbstractVector{<:AbstractMatrix};
    color,
    label,
    labelsize,
    kwargs...
) -> Tuple{Makie.Figure, AbstractVector{<:Makie.Axis}}

Arguments

  • fig::Figure: Makie figure object
  • axs::Vector{Axis}: vector of Makie axis objects
  • Xs::AbstractVector{<:AbstractMatrix}: vector of matrices of size (m, n) where m is the number of dimensions and n is the number of timepoints.
  • color::Tuple: color of the lines. Default is (:orange, 0.1) where 0.1 is the alpha value.
  • label: label for the legend
  • kwargs...: keyword arguments passed to Axis constructor
source
Visualisations.plot_traces — Function
plot_traces(
    ed::ExperimentData,
    idx;
    var_type,
    color,
    resolution,
    kwargs...
) -> Makie.Figure

Plot traces of var_type for trajectory idx in ed. var_type can be :states, :observables or :controls.

Arguments

  • ed::ExperimentData: ExperimentData object
  • idx::Int: index of the trajectory
  • var_type::Symbol: :states, :observables or :controls
  • color::Tuple: color of the lines. Default is (:black, 1) where 1 is the alpha value.
  • resolution::Tuple: resolution of the figure. Default is nothing which means (1000, length(labels)*200) where labels is the labels of the var_type.
  • kwargs...: keyword arguments passed to Axis constructor

Returns

  • fig::Figure: Makie figure object
source
plot_traces(
    ts::AbstractVector,
    gt::AbstractMatrix,
    pred::AbstractMatrix,
    labels::AbstractVector;
    resolution,
    gt_color,
    pred_color,
    kwargs...
) -> Makie.Figure

Plot traces of gt and pred of m dimensions and n timepoints against time ts with labels.

Arguments

  • ts::Vector: time vector of length n,
  • gt::Matrix: ground truth matrix of size (m, n),
  • pred::Matrix: prediction matrix of size (m, n),
  • labels::Vector: labels for the traces of length m,
  • resolution::Tuple: resolution of the figure. Default is nothing which means (1000, length(labels)*200).
  • kwargs...: keyword arguments passed to Axis constructor

Returns

  • fig::Figure: Makie figure object
source

Data Generation Tuning

Visualisations.datagen_tuning_app — Method
datagen_tuning_app(; kwargs...)

Starts the DataGeneration tuning app.

Arguments

  • kwargs: Optional keyword arguments for PlutoVSCodeApp.create_app function call
source