Skip to content

Commit f5892f0

Browse files
committed
add notes to docstring
1 parent adb24dc commit f5892f0

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

lib/ControlSystemsBase/src/pid_design.jl

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,18 @@ The `form` can be chosen as one of the following (determines how the arguments `
1313
If `state_space` is set to `true`, either `Kd` has to be zero
1414
or a positive `Tf` has to be provided for creating a filter on
1515
the input to allow for a state-space realization.
16+
A balanced state-space realization is returned, unless `balance = false`.
1617
17-
The filter used is either
18-
- `filter_order = 2` (default): ``1 / ((sT_f)^2/(4d^2) + sT_f + 1)`` in series with the controller
18+
## Filter
19+
If `Tf` is supplied, a filter is added, the filter used is either
20+
- `filter_order = 2` (default): ``1 / ((sT_f)^2/(4d^2) + sT_f + 1)`` in series with the controller. Note: this parametrization of the filter differs in behavior from the common parameterizaiton ``1/(s^2 + 2dws + w^2)`` as the parameters vary, the former maintains an almost fixed _bandwidth_ while `d` varies, while the latter maintains a fixed distance of the poles from the origin.
1921
- `filter_order = 1`: ``1 / (1 + sT_f)`` applied to the derivative term only
2022
2123
``T_f`` can typically be chosen as ``T_i/N`` for a PI controller and ``T_d/N`` for a PID controller,
22-
and `N` is commonly in the range 2 to 20. With a second-order filter, `d` controls the damping. `d = 1/√(2)` gives a Butterworth configuration of the poles, and `d=1` gives a critically damped filter (no overshoot).
24+
and `N` is commonly in the range 2 to 20. With a second-order filter, `d` controls the damping. `d = 1/√(2)` gives a Butterworth configuration of the poles, and `d=1` gives a critically damped filter (no overshoot). `d` above one may be used, although `d > 1` yields an increasingly over-damped filter (this parametrization does not send one pole to the origin ``d → ∞`` like the ``(ω,ζ)`` parametrization does).
2325
24-
A balanced state-space realization is returned, unless `balance = false`.
26+
27+
## Discrete-time
2528
2629
For a discrete controller a positive `Ts` can be supplied.
2730
In this case, the continuous-time controller is discretized using the Tustin method.

0 commit comments

Comments
 (0)