API Reference¶

state_space_design.controllerTool.cli¶

Command line interface for state-space controller design.

state_space_design.controllerTool.cli.main(argv=None)[source]¶

Run the controllerTool command line interface.

Parameters:: argv (list[str] | None)
Return type:: int

state_space_design.controllerTool.apis¶

Thin API for programmatic access, wrapping the app in a stable surface.

class state_space_design.controllerTool.apis.RunRequest(num: 'str', den: 'str', K_poles: 'Optional[str]' = None, obs_poles: 'Optional[str]' = None, cfg: 'str' = 'both', ts: 'Optional[float]' = None, undershoot: 'Optional[Tuple[float, float]]' = None, obs_speed_factor: 'float' = 5.0)[source]¶

Bases: object

Parameters:

num (str)
den (str)
K_poles (str | None)
obs_poles (str | None)
cfg (str)
ts (float | None)
undershoot (Tuple[float, float] | None)
obs_speed_factor (float)

K_poles: str | None = None¶

cfg: str = 'both'¶

den: str¶

num: str¶

obs_poles: str | None = None¶

obs_speed_factor: float = 5.0¶

ts: float | None = None¶

undershoot: Tuple[float, float] | None = None¶

class state_space_design.controllerTool.apis.RunResponse(result: 'BuildResult')[source]¶

Bases: object

Parameters:: result (BuildResult)

result: BuildResult¶

state_space_design.controllerTool.apis.run(req)[source]¶

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

state_space_design.controllerTool.io¶

Output/plot services (Matplotlib/Plotly optional) for closed-loop responses.

class state_space_design.controllerTool.io.PlotConfig(plots: 'str' = 'both', save_prefix: 'Optional[str]' = None, ply_width: 'int' = 0)[source]¶

Bases: object

Parameters:

plots (str)
save_prefix (str | None)
ply_width (int)

plots: str = 'both'¶

ply_width: int = 0¶

save_prefix: str | None = None¶

class state_space_design.controllerTool.io.PlotService(cfg)[source]¶

Bases: object

Parameters:: cfg (PlotConfig)

plot_closed_loop_bode_and_step(systems)[source]¶

Parameters:: systems (Sequence[tuple[str, TransferFunction]])