Main Content

tunableProperties

Get tunable properties of filter

Description

example

tps = tunableProperties(filter) returns and displays the tunable properties of the filter.

Examples

collapse all

Create a trackingEKF object.

filter = trackingEKF;

Obtain the tunable properties using the tunableProperties object function.

tps = tunableProperties(filter)
tps = 
Tunable properties for object of type: trackingEKF

Property:      ProcessNoise
   PropertyValue:   [1 0 0 0;0 1 0 0;0 0 1 0;0 0 0 1]
   TunedQuantity:   Square root
   IsTuned:         true
       TunedQuantityValue:  [1 0 0 0;0 1 0 0;0 0 1 0;0 0 0 1]
       TunableElements:     [1 5 6 9 10 11 13 14 15 16]
       LowerBound:          [0 0 0 0 0 0 0 0 0 0]
       UpperBound:          [10 10 10 10 10 10 10 10 10 10]
Property:      StateCovariance
   PropertyValue:   [1 0 0 0;0 1 0 0;0 0 1 0;0 0 0 1]
   TunedQuantity:   Square root of initial value
   IsTuned:         false

Create a trackingUKF object.

filter = trackingUKF;

Obtain the tunable properties using the tunableProperties object function.

tps = tunableProperties(filter)
tps = 
Tunable properties for object of type: trackingUKF

Property:      ProcessNoise
   PropertyValue:   [1 0 0 0;0 1 0 0;0 0 1 0;0 0 0 1]
   TunedQuantity:   Square root
   IsTuned:         true
       TunedQuantityValue:  [1 0 0 0;0 1 0 0;0 0 1 0;0 0 0 1]
       TunableElements:     [1 5 6 9 10 11 13 14 15 16]
       LowerBound:          [0 0 0 0 0 0 0 0 0 0]
       UpperBound:          [10 10 10 10 10 10 10 10 10 10]
Property:      StateCovariance
   PropertyValue:   [1 0 0 0;0 1 0 0;0 0 1 0;0 0 0 1]
   TunedQuantity:   Square root of initial value
   IsTuned:         false
Property:      Alpha
   PropertyValue:   0.001
   TunedQuantity:   Value
   IsTuned:         true
       TunedQuantityValue:  0.001
       TunableElements:     1
       LowerBound:          1e-05
       UpperBound:          1
Property:      Beta
   PropertyValue:   2
   TunedQuantity:   Value
   IsTuned:         false
Property:      Kappa
   PropertyValue:   0
   TunedQuantity:   Value
   IsTuned:         false

Input Arguments

collapse all

Tracking filter, specified as one of these objects:

Output Arguments

collapse all

Tunable properties, returned as a tunableFilterProperties object.

Version History

Introduced in R2022b