API Reference¶

state_space_analysis.canonicalTool.cli¶

state_space_analysis.canonicalTool.cli.main()[source]¶

Run the canonicalTool command line interface.

Return type:: None

state_space_analysis.canonicalTool.apis¶

class state_space_analysis.canonicalTool.apis.CanonicalAPI[source]¶

Bases: object

compare(num, den, tfinal=8.0, dt=0.001, symbolic=False, backend='mpl', show=True, save=None)[source]¶

Return type:: Dict[str, Any]

state_space_analysis.canonicalTool.app¶

class state_space_analysis.canonicalTool.app.CanonicalToolApp[source]¶

Bases: object

High-level orchestrator for canonical forms comparison/plotting.

compare(num, den, opts)[source]¶

Parameters:: opts (CompareOptions)
Return type:: CompareResult

class state_space_analysis.canonicalTool.app.CompareResult(tf_equal: 'dict', symbolic: 'str | None')[source]¶

Bases: object

Parameters:

tf_equal (dict)
symbolic (str | None)

symbolic: str | None¶

tf_equal: dict¶

state_space_analysis.canonicalTool.core¶

class state_space_analysis.canonicalTool.core.CanonicalFormsEngine[source]¶

Bases: object

static canonical_form_safe(sys, form)[source]¶

Parameters:

sys (StateSpace)
form (str)

static make_ccf_from_tf(num, den)[source]¶

Return type:: StateSpace

static make_modal_real(sys)[source]¶

Parameters:: sys (StateSpace)
Return type:: StateSpace

static make_ocf_from_ss(sys)[source]¶

Parameters:: sys (StateSpace)
Return type:: StateSpace

static normalize_tf_coeffs(num, den)[source]¶

static symbolic_G(sys)[source]¶

Parameters:: sys (StateSpace)

static tf_equal(sys1, sys2, tol=1e-09)[source]¶

Parameters:

sys1 (StateSpace)
sys2 (StateSpace)
tol (float)

Return type:

bool

state_space_analysis.canonicalTool.design¶

class state_space_analysis.canonicalTool.design.CompareOptions(tfinal: 'float' = 8.0, dt: 'float' = 0.001, symbolic: 'bool' = False, backend: 'str' = 'mpl', show: 'bool' = True, save: 'str | None' = None)[source]¶

Bases: object

Parameters:

tfinal (float)
dt (float)
symbolic (bool)
backend (str)
show (bool)
save (str | None)

backend: str¶

dt: float¶

save: str | None¶

show: bool¶

symbolic: bool¶

tfinal: float¶

state_space_analysis.canonicalTool.io¶

class state_space_analysis.canonicalTool.io.SaveOptions(save_path: 'Optional[str]' = None)[source]¶

Bases: object

Parameters:: save_path (str | None)

save_path: str | None¶

state_space_analysis.canonicalTool.io.default_out_path(filename)[source]¶

Parameters:: filename (str)
Return type:: str

state_space_analysis.canonicalTool.io.save_json(data, path)[source]¶

Parameters:

data (dict)
path (str)

Return type:

None

state_space_analysis.canonicalTool.utils¶

state_space_analysis.canonicalTool.utils.ensure_dir(path)[source]¶

Parameters:: path (str)
Return type:: None

state_space_analysis.canonicalTool.utils.parse_list(s)[source]¶

Parameters:: s (str)
Return type:: List[float]

state_space_analysis.canonicalTool.utils.substitute_kind(path, kind)[source]¶

Parameters:

path (str | None)
kind (str)

Return type:

str | None

state_space_analysis.canonicalTool.utils.time_grid(tfinal, dt)[source]¶

Parameters:

tfinal (float)
dt (float)

Return type:

ndarray