API Reference¶

state_space_analysis.converterTool.cli¶

state_space_analysis.converterTool.cli.args_to_request(args)[source]¶

Convert parsed command line arguments into a RunRequest.

Parameters:: args (Namespace)
Return type:: RunRequest

state_space_analysis.converterTool.cli.build_parser()[source]¶

Build the command line parser for transfer-function and state-space conversion.

Return type:: ArgumentParser

state_space_analysis.converterTool.cli.main(argv=None)[source]¶

Run the converter command line interface.

Return type:: None

state_space_analysis.converterTool.apis¶

class state_space_analysis.converterTool.apis.RunRequest(num: 'Optional[str]' = None, den: 'Optional[str]' = None, A: 'Optional[str]' = None, B: 'Optional[str]' = None, C: 'Optional[str]' = None, D: 'Optional[str]' = None, iu: 'int' = 0, tfinal: 'float' = 8.0, dt: 'float' = 0.001, sympy: 'bool' = False, no_plot: 'bool' = False, out_prefix: 'Optional[str]' = None, log: 'str' = 'INFO')[source]¶

Bases: object

Parameters:

num (str | None)
den (str | None)
A (str | None)
B (str | None)
C (str | None)
D (str | None)
iu (int)
tfinal (float)
dt (float)
sympy (bool)
no_plot (bool)
out_prefix (str | None)
log (str)

A: str | None = None¶

B: str | None = None¶

C: str | None = None¶

D: str | None = None¶

den: str | None = None¶

dt: float = 0.001¶

iu: int = 0¶

log: str = 'INFO'¶

no_plot: bool = False¶

num: str | None = None¶

out_prefix: str | None = None¶

sympy: bool = False¶

tfinal: float = 8.0¶

state_space_analysis.converterTool.app¶

class state_space_analysis.converterTool.app.AppResult(ok: 'bool', message: 'str' = '')[source]¶

Bases: object

Parameters:

ok (bool)
message (str)

message: str = ''¶

ok: bool¶

class state_space_analysis.converterTool.app.ConverterApp[source]¶

Bases: object

detect_mode(req)[source]¶

Parameters:: req (RunRequest)
Return type:: str

run(req)[source]¶

Parameters:: req (RunRequest)
Return type:: AppResult

state_space_analysis.converterTool.core¶

class state_space_analysis.converterTool.core.ConversionResult(G: 'object | None' = None, SS: 'ct.StateSpace | None' = None)[source]¶

Bases: object

Parameters:

G (object | None)
SS (StateSpace | None)

G: object | None = None¶

SS: StateSpace | None = None¶

class state_space_analysis.converterTool.core.Plotter(backend='Agg')[source]¶

Bases: object

Parameters:: backend (str)

step_ss(SS, iu=0, tfinal=8.0, dt=0.001, title='Step response (SS)', save=None, show=False)[source]¶

step_tf(G, tfinal=8.0, dt=0.001, title='Step response (TF)', save=None, show=False)[source]¶

class state_space_analysis.converterTool.core.PrettyPrinter[source]¶

Bases: object

sympy_tf(G)[source]¶

Return type:: str

tf(G)[source]¶

Return type:: str

class state_space_analysis.converterTool.core.SystemConverter[source]¶

Bases: object

Core conversion object: TF↔SS and checks.

equivalent_siso(G1, G2, atol=1e-09)[source]¶

Return type:: bool

ss_to_tf(A, B, C, D)[source]¶

Return type:: ConversionResult

tf_to_ss(num, den)[source]¶

Return type:: ConversionResult

state_space_analysis.converterTool.io¶

class state_space_analysis.converterTool.io.SavePaths(tf_plot: 'Path | None' = None, ss_plot: 'Path | None' = None)[source]¶

Bases: object

Parameters:

tf_plot (Path | None)
ss_plot (Path | None)

ss_plot: Path | None = None¶

tf_plot: Path | None = None¶

state_space_analysis.converterTool.io.default_out(name)[source]¶

Parameters:: name (str)
Return type:: Path

state_space_analysis.converterTool.utils¶

state_space_analysis.converterTool.utils.clip_small(a, tol=1e-12)[source]¶

state_space_analysis.converterTool.utils.coeffs_from_tf(G)[source]¶

Return (num, den) as 1‑D arrays for SISO regardless of control version.

Return type:: Tuple[ndarray, ndarray]

state_space_analysis.converterTool.utils.coerce_outputs_to_m_by_N(Y, N_time)[source]¶

Return type:: ndarray

state_space_analysis.converterTool.utils.normalize_tf(num, den)[source]¶

state_space_analysis.converterTool.utils.parse_matrix(s)[source]¶

Parameters:: s (str | None)
Return type:: ndarray | None

state_space_analysis.converterTool.utils.parse_vector(s)[source]¶

Parameters:: s (str | None)
Return type:: ndarray | None

state_space_analysis.converterTool.utils.setup_logger(level='INFO')[source]¶

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