Main Content

h2synOptions

Option set for h2syn

collapse all in page

Syntax

opts = h2synOptions
opts = h2synOptions(Name,Value)

Description

opts = h2synOptions creates the default options set for the h2syn command.

example

opts = h2synOptions(Name,Value) creates an option set with the options specified by one or more Name,Value pair arguments.

example

Examples

collapse all

Open Live Script

Create an option set for the h2syn command that turns off automatic regularization of the plant. Turning off regularization can speed up the computation when you know your problem is far from singular.

You can use Name,Value pairs to create the option set.

opts = h2synOptions('Regularize','off');

Alternatively, create a default options set and use dot notation to change the option value.

opts = h2synOptions;
opts.Regularize = 'off';

You can now use opts as an input argument to h2syn.

Input Arguments

collapse all

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'AutoScale','on','Regularize','off'

Automatic plant scaling, specified as the comma-separated pair consisting of 'AutoScale' and one of the following:

  • 'on' — h2syn automatically scales the plant states, controls, and measurements to improve numerical accuracy. h2syn always returns the controller K in the original unscaled coordinates.

  • 'off' — h2syn does not change the plant scaling. Turning off scaling when you know your plant is well scaled can speed up the computation.

Example: opts = h2synOptions('AutoScale','off') creates an option set for h2syn that turns off automatic scaling.

Automatic regularization of the plant, specified as the comma-separated pair consisting of 'Regularize' and one of the following:

  • 'on' — h2syn automatically regularizes the plant to enforce requirements on P12 and P21 (see h2syn). Regularization is a process of adding extra disturbances and errors to handle singular problems.

  • 'off' — h2syn does not regularize the plant. Turning off regularization can speed up the computation when you know your problem is far enough from singular.

Example: opts = h2synOptions('Regularize','off') creates an option set for h2syn that turns off regularization.

Output Arguments

collapse all

Options for the h2syn computation, returned as an h2syn options object. Use the object as an input argument to h2syn. For example:

[K,CL,gamma,info] = h2syn(P,nmeas,ncont,opts);

Version History

Introduced in R2019a

See Also