overshoot
Builtin index · Signal processing
result = overshoot(x, [settle_level=], [initial_level=], [settle_frac=0.1])
Input: x, settle_level, initial_level, settle_frac · Output: result
What it is
x: a length-N real vector or Signal. settle_level/initial_level (optional numbers) default to the mean of the last and first settle_frac of the record (10%, at least one sample each — a mean rather than the single end samples, so one noisy point cannot carry the whole measurement).
Overloads
One call shape — this function is not overloaded.
| Code | Input | Output | Description |
result = overshoot(x, [settle_level=], [initial_level=], [settle_frac=0.1]) | x vector or Signalx: a length-N real vector or Signal.settle_level number, optionalsettle_level/initial_level (optional numbers) default to the mean of the last and first settle_frac of the record (10%, at least one sample each — a mean rather than the single end samples, so one noisy point cannot carry the whole measurement).initial_level number, optionalsettle_level/initial_level (optional numbers) default to the mean of the last and first settle_frac of the record (10%, at least one sample each — a mean rather than the single end samples, so one noisy point cannot carry the whole measurement).settle_frac number, optional (default 0.1)settle_level/initial_level (optional numbers) default to the mean of the last and first settle_frac of the record (10%, at least one sample each — a mean rather than the single end samples, so one noisy point cannot carry the whole measurement). | result number | Returns a single number, a percent of the step's own size abs(final - initial): overshoot is how far the response travels *past its settled value* in the direction the step was going, undershoot how far it backs up *past where it started* (the pre-shoot), which is MATLAB stepinfo's convention. Both clamp at zero. A falling step works the same way with min and max exchanged. Errors when the record contains no step to be a percentage of. |
Examples
No documentation example calls this form yet. The Signal processing chapter is where one belongs.
How it works
overshoot(x, [settle_level=], [initial_level=], [settle_frac=0.1]) / undershoot(...) -- step-response overshoot and undershoot, each as a PERCENT of the step's own size. Overshoot is how far the response travels past its settled value in the direction the step was going; undershoot is how far it backs up past where it STARTED (the pre-shoot), which is MATLAB stepinfo's convention. Both clamp at zero. A falling step works the same way with min and max exchanged. The settled and initial levels default to the mean of the last and first settle_frac of the record (10%, at least one sample each) rather than to the single end samples, which would put the whole measurement at the mercy of one noisy point. Override either explicitly when the record does not settle inside its own tail.
From the note above this builtin in the interpreter, where the reasoning was written down as it was built.
See also
undershoot — documented in the same entry.