*kf
by An Uncommon Lab

skfoptions

Create a set of *kf engine options for code generation or load options from a .mat file.

options = skfoptions();
options = skfoptions('my_saved_options.mat');

To learn how each option affects code generation, use the graphical user interface to the *kf engine (skfengine). When a field is selected, the corresponding ID in the options structure will be shown at the bottom of the Info box.

Inputs

file

Optional name of file to load; if none is provided, default options are returned

Outputs

options

An options structure used to generate code or set up the SkfGui.

Example

We can generate code without loading the GUI by loading an options structure, setting individual fields, and calling skfgen.

options = skfoptions();
options.filter_name = 'a_default_filter';
options.init.x0     = [1; 0];
skfgen(options);

Alternately, we can load this options structure directly into the GUI.

options                     = skfoptions();
options.filter_name         = 'another_filter';
options.init.uncertainty.P0 = [2 1; 1 2];
skfengine(options);

or:

skfengine(options);

To load a file with a previous set of skfoptions saved inside it:

options = skfoptions('my_saved_options.mat');

To save in the correct format, use:

save('my_saved_options.mat', 'options')

See Also

skfengine, skfgen

Table of Contents

  1. Inputs
  2. Outputs
  3. Example
  4. See Also