Main Content

tunableProperties

Get tunable properties of filter

Since R2022b

collapse all in page

Syntax

tps = tunableProperties(filter)

Description

example

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

Examples

collapse all

Open Live Script

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
Open Live Script

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
Open Live Script

Create a trackingIMM object.

filter = trackingIMM;

Obtain the tunable properties using the tunableProperties object function. You can click the links (active in live script) in the display to display the tunable properties of the tracking filters used in the trackingIMM object.

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

Property:      TransitionProbabilities
   PropertyValue:   [0.9 0.05 0.05;0.05 0.9 0.05;0.05 0.05 0.9]
   TunedQuantity:   Rows sum to one
   IsTuned:         true
       TunedQuantityValue:  [0.9 0.05 0.05;0.05 0.9 0.05;0.05 0.05 0.9]
       TunableElements:     [1 2 3 4 5 6 7 8 9]
       LowerBound:          [0.001 0.001 0.001 0.001 0.001 0.001 0.001 0.001 0.001]
       UpperBound:          [1 1 1 1 1 1 1 1 1]
Property:      ModelProbabilities
   PropertyValue:   [0.333333333333333;0.333333333333333;0.333333333333333]
   TunedQuantity:   Columns sum to one
   IsTuned:         true
       TunedQuantityValue:  [0.333333333333333;0.333333333333333;0.333333333333333]
       TunableElements:     [1 2 3]
       LowerBound:          [0.001 0.001 0.001]
       UpperBound:          [1 1 1]

The filter contains 3 tracking filters
   Show tunable properties for filter 1
   Show tunable properties for filter 2
   Show tunable properties for filter 3

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

See Also

| |