WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

SystemsModelControllerData
✖
SystemsModelControllerData

✖

represents controller data generated by functions LQGRegulator, PIDTune, etc.

Details

  • A SystemsModelControllerData[…] object cd can be used to retrieve data through cd["property"].
  • A list of available properties is given by cd["Properties"]. Additional details about the properties are listed on the page for each controller design function.
  • State feedback controller design functions include:
  • StateFeedbackGainspole placement
    LQRegulatorGainslinear quadratic (LQ) optimal control
    DiscreteLQRegulatorGainsapproximate discrete-time LQ optimal control
  • Output feedback controller design functions include:
  • EstimatorRegulatorassembling state feedback and state estimator
    LQGRegulatorLQ Gaussian optimal regulator and estimator
    PIDTuneautomatically tuned PID controller
  • Typical properties include:
  • "Design"type of controller design
    "ClosedLoopSystem"the closed-loop system with plant and controller
    "ClosedLoopPoles"the poles of the Taylor linearized closed-loop system
    "InputsCount"number of inputs
    "OutputsCount"number of outputs
  • Other specifications include:
  • {p1,…,pn}get the values of properties pi
    "Dataset"get the property names and values as a Dataset
    "PropertyAssociation"get the property names and values as an Association

Examples

open allclose all

Basic Examples  (1)Summary of the most common use cases

Create a SystemsModelControllerData object:

In[1]:=1
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-l2m3zo
Out[1]=1

Obtain a list of available properties:

In[2]:=2
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-4786gq
Out[2]=2

Extract a property:

In[3]:=3
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-rr62lt
Out[3]=3

Retrieve a list of properties:

In[4]:=4
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-qlqtyf
Out[4]=4

Scope  (10)Survey of the scope of standard use cases

Controller Designs  (7)

Get the controller data object for a pole-placement design using StateFeedbackGains:

In[1]:=1
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-ua3eyc
In[3]:=3
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-m5af89
Out[3]=3

Its properties:

In[4]:=4
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-qx4oa1
Out[4]=4

Get the controller data object for a regulator design using LQRegulatorGains:

In[1]:=1
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-ts7a9b
In[2]:=2
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-ykwj0c
Out[2]=2

Its properties:

In[3]:=3
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-jt0xot
Out[3]=3

Get the controller data object for a regulator design using LQOutputRegulatorGains:

In[1]:=1
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-24jljp
In[2]:=2
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-urvfix
Out[2]=2

Its properties:

In[3]:=3
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-laykw3
Out[3]=3

Get the controller data object for a discrete-time design using DiscreteLQRegulatorGains:

In[1]:=1
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-63zmnm
In[2]:=2
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-b8u09u
Out[2]=2

Its properties:

In[3]:=3
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-6fcg01
Out[3]=3

Get the controller data object for a controller assembled using EstimatorRegulator:

In[1]:=1
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-tcv6rz
In[2]:=2
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-oil7xv
Out[2]=2

Its properties:

In[3]:=3
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-87a7ce
Out[3]=3

Get the controller data object for a controller designed using LQGRegulator:

In[1]:=1
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-ndl8yk
In[2]:=2
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-e7tm33
Out[2]=2

Its properties:

In[3]:=3
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-nu3xq1
Out[3]=3

Get the controller data object for a controller designed using PIDTune:

In[1]:=1
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-cilp6t
Out[1]=1

Its properties:

In[2]:=2
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-c66a7i
Out[2]=2

Properties  (3)

Obtain the names of all available properties:

In[1]:=1
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-kfsyh
In[2]:=2
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-hk4yio
Out[2]=2

Get the names and values of the properties as a Dataset:

In[3]:=3
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-dfkcrf
Out[3]=3

As an Association:

In[4]:=4
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-ce48wp
Out[4]=4

Get the value of a specific property:

In[1]:=1
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-7nmt2y
In[2]:=2
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-ymdspc
Out[2]=2

A list of property values:

In[3]:=3
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-5chqh7
Out[3]=3

Some properties can be given additional specifications:

In[1]:=1
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-1b92vk
In[2]:=2
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-pzoczr
Out[2]=2

A list of properties, some without and some with additional specifications:

In[3]:=3
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-v7g4h7
Out[3]=3

Applications  (1)Sample problems that can be solved with this function

Automatically compute properties of a controller design for further analysis:

In[1]:=1
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-wlefwl

The data object:

In[3]:=3
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-14lm81
Out[3]=3

Compute the state response using the "ClosedLoopSystem" property:

In[4]:=4
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-fkyjy6
Out[5]=5

The closed-loop poles:

In[6]:=6
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-ss25w5
Out[6]=6

Compare them to the open-loop poles:

In[7]:=7
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-n82nbr
Out[7]=7

The control effort:

In[8]:=8
✖
https://wolfram.com/xid/0g3zqoig1jg3paa1e-z72o2w
Out[9]=9
Wolfram Research (2021), SystemsModelControllerData, Wolfram Language function, https://reference.wolfram.com/language/ref/SystemsModelControllerData.html.
✖
Wolfram Research (2021), SystemsModelControllerData, Wolfram Language function, https://reference.wolfram.com/language/ref/SystemsModelControllerData.html.

Text

Wolfram Research (2021), SystemsModelControllerData, Wolfram Language function, https://reference.wolfram.com/language/ref/SystemsModelControllerData.html.

✖
Wolfram Research (2021), SystemsModelControllerData, Wolfram Language function, https://reference.wolfram.com/language/ref/SystemsModelControllerData.html.

CMS

Wolfram Language. 2021. "SystemsModelControllerData." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/SystemsModelControllerData.html.

✖
Wolfram Language. 2021. "SystemsModelControllerData." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/SystemsModelControllerData.html.

APA

Wolfram Language. (2021). SystemsModelControllerData. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/SystemsModelControllerData.html

✖
Wolfram Language. (2021). SystemsModelControllerData. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/SystemsModelControllerData.html

BibTeX

@misc{reference.wolfram_2025_systemsmodelcontrollerdata, author="Wolfram Research", title="{SystemsModelControllerData}", year="2021", howpublished="\url{https://reference.wolfram.com/language/ref/SystemsModelControllerData.html}", note=[Accessed: 18-June-2025 ]}

✖
@misc{reference.wolfram_2025_systemsmodelcontrollerdata, author="Wolfram Research", title="{SystemsModelControllerData}", year="2021", howpublished="\url{https://reference.wolfram.com/language/ref/SystemsModelControllerData.html}", note=[Accessed: 18-June-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_systemsmodelcontrollerdata, organization={Wolfram Research}, title={SystemsModelControllerData}, year={2021}, url={https://reference.wolfram.com/language/ref/SystemsModelControllerData.html}, note=[Accessed: 18-June-2025 ]}

✖
@online{reference.wolfram_2025_systemsmodelcontrollerdata, organization={Wolfram Research}, title={SystemsModelControllerData}, year={2021}, url={https://reference.wolfram.com/language/ref/SystemsModelControllerData.html}, note=[Accessed: 18-June-2025 ]}