functions

plot.functions

Functions

Name Description
plot_coupling_function Plot a CouplingFunction’s response curve over a sensible input range.
plot_temporal_equation Plot a temporal equation (SymPy expression or ontology entity) over a time vector.

plot_coupling_function

plot.functions.plot_coupling_function(CF, ax=None)

Plot a CouplingFunction’s response curve over a sensible input range.

Picks the input domain based on the function’s name (±π for Kuramoto, ±1000 for Sigmoidal, ±10 otherwise), substitutes the curated default parameters, and renders the SymPy expression as a 1-D curve with a LaTeX title.

Parameters

Name Type Description Default
CF Any The coupling function (an instance of Coupling-derived class or an ontology lookup result). required
ax Any Existing matplotlib axes to draw into; created if None. None

plot_temporal_equation

plot.functions.plot_temporal_equation(
    EQ,
    t_ms,
    title='Stimulation pulse sequence',
    plot_kwargs=None,
    ax=None,
    **kwargs,
)

Plot a temporal equation (SymPy expression or ontology entity) over a time vector.

Substitutes ontology-curated default parameters (overridable via **kwargs) and evaluates the expression pointwise at each value of t_ms.

Parameters

Name Type Description Default
EQ Any A SymPy expression or an owlready2 class representing a temporal equation. required
t_ms Any 1-D array-like of time points in milliseconds. required
title str Axes title. 'Stimulation pulse sequence'
plot_kwargs Optional[dict] Forwarded to ax.plot(...). None
ax Any Existing matplotlib axes; created if None. None
**kwargs Any Override symbolic parameters by name. {}