Documentation

removePoint

Remove point from list of analysis points in slLinearizer or slTuner interface

Syntax

Description

example

removePoint(s,pt) removes the specified point, pt, from the list of analysis points for the slLinearizer or slTuner interface, s. You can specify pt to remove either a single or multiple points.

removePoint does not modify the model associated with s.

Examples

collapse all

Remove Analysis Point Using Signal Name

Create an slLinearizer interface for the scdcascade model. Add analysis points for the r, e1, and y1m signals.

sllin = slLinearizer('scdcascade',{'r','e1','y1m'});

Remove the y1m point from the interface.

removePoint(sllin,'y1m');

Remove Multiple Analysis Points Using Signal Name

Create an slLinearizer interface for the scdcascade model. Add analysis points for the r, e1, and y1m signals.

sllin = slLinearizer('scdcascade',{'r','e1','y1m'});

Remove the y1m and e1 points from the interface.

removePoint(sllin,{'y1m','e1'});

Remove Analysis Point Using Index

Create an slLinearizer interface for the scdcascade model. Add analysis points for the r, e1, and y1m signals.

sllin = slLinearizer('scdcascade',{'r','e1','y1m'});

Determine the index number of the point you want to remove. To do this, display the contents of the interface, which includes analysis point index numbers, in the Command Window.

For this example, remove the y1m point from sllin.

sllin
slLinearizer linearization interface for "scdcascade":

3 Analysis points: 
--------------------------
Point 1:
- Block: scdcascade/setpoint
- Port: 1
- Signal Name: r

Point 2:
- Block: scdcascade/Sum1
- Port: 1
- Signal Name: e1

Point 3:
- Block: scdcascade/Sum
- Port: 1
- Signal Name: y1m

No permanent openings. Use addOpening method to add new permanent openings.
Other properties (with dot notation get/set access):
      Parameters         : [] 
      OperatingPoints    : [] (model initial condition will be used.)
      BlockSubstitutions : []
      Options            : [1x1 linearize.LinearizeOptions]

The displays shows that y1m is the third analysis point of sllin .

Remove the point from the interface.

removePoint(sllin,3);

Remove Multiple Analysis Points Using Index

Create an slLinearizer interface for the scdcascade model. Add analysis points for the r, e1, and y1m signals.

sllin = slLinearizer('scdcascade',{'r','e1','y1m'});

Determine the index numbers of the points you want to remove. To do this, display the contents of the interface, which includes analysis point index numbers, in the Command Window.

For this example, remove the e1 and y1m points from sllin.

sllin
slLinearizer linearization interface for "scdcascade":

3 Analysis points: 
--------------------------
Point 1:
- Block: scdcascade/setpoint
- Port: 1
- Signal Name: r

Point 2:
- Block: scdcascade/Sum1
- Port: 1
- Signal Name: e1

Point 3:
- Block: scdcascade/Sum
- Port: 1
- Signal Name: y1m

No permanent openings. Use addOpening method to add new permanent openings.
Other properties (with dot notation get/set access):
      Parameters         : [] 
      OperatingPoints    : [] (model initial condition will be used.)
      BlockSubstitutions : []
      Options            : [1x1 linearize.LinearizeOptions]

The displays shows that e1 and y1m are the second and third analysis points of sllin .

Remove the points from the interface.

removePoint(sllin,[2 3]);

Input Arguments

collapse all

s — Interface to Simulink® modelslLinearizer interface | slTuner interface

Interface to a Simulink model, specified as either an slLinearizer interface or an slTuner interface.

pt — Analysis pointstring | cell array of strings | positive integer | vector of positive integers

Analysis point to remove from the list of analysis points for s, specified as:

  • String — Analysis point signal name.

    To determine the signal name associated with an analysis point, type s. The software displays the contents of s in the MATLAB® command window, including the analysis point signal names, block names, and port numbers. Suppose an analysis point does not have a signal name, but only a block name and port number. You can specify pt as the block name.

    You can specify pt as a uniquely matching substring of the full signal name or block name. Suppose the full signal name of an analysis point is 'LoadTorque'. You can specify pt as 'Torque' as long as 'Torque' is not a substring of the signal name for any other analysis point of s.

    For example, pt = 'y1m'.

  • Cell array of strings — Specifies multiple analysis point names. For example, pt = {'y1m','y2m'}.

  • Positive integer or — Analysis point index.

    To determine the index of an analysis point, type s. The software displays the contents of s in the MATLAB command window, including the analysis points indices.

    For example, pt = 1.

  • Vector of positive integers — Specifies multiple analysis point indices. For example, pt = [1 2].

More About

collapse all

Analysis Points

Analysis points, used by the slLinearizer and slTuner interfaces, identify locations within a model that are relevant for linear analysis and control system tuning. You use analysis points as inputs to the linearization commands, such as getIOTransfer, getLoopTransfer, getSensitivity, and getCompSensitivity. As inputs to the linearization commands, analysis points can specify any open- or closed-loop transfer function in a model. You can also use analysis points to specify design requirements when tuning control systems using commands such as systune (requires a Robust Control Toolbox™ license).

Location refers to a specific block output port within a model. For convenience, you can use the name of the signal that originates from this port to refer to an analysis point.

You can add analysis points to an slLinearizer or slTuner interface, s, when you create the interface. For example:

s = slLinearizer('scdcascade',{'u1','y1'});

Alternatively, you can use the addPoint command.

To view all the analysis points of s, type s at the command prompt to display the interface contents. For each analysis point of s, the display includes the block name and port number and the name of the signal that originates at this point. You can also use getPoints to programmatically obtain a list of all the analysis points.

For more information about how you can use analysis points, see Marking Signals of Interest for Control System Analysis and Design.

Was this topic helpful?