get

Get fit options structure property names and values

Syntax

get(options)

s = get(options)

value = get(options,field)

Description

get(options) displays all property names and values of the fit options structure options.

s = get(options) returns a copy of the fit options structure options as the structure s.

value = get(options,field) returns the value of the property field of the fit options structure options. field can be a cell array of character vectors, in which case value is also a cell array.

Examples

Obtain Property Values of a fit options Structure Using get

Create a fitoptions structure and call the get function to obtain its property values.

options = fitoptions('fourier1');
methodOptions = get(options,'Method')
maxIterOptions = get(options,'MaxIter')
set(options,'Maxiter',1e3);
maxIterOptions = get(options,'MaxIter')

methodOptions =

    'NonlinearLeastSquares'

maxIterOptions =

   400

maxIterOptions =

        1000

Property values can also be referenced and assigned using the dot notation. For example:

options.MaxIter

ans =
        1000

options.MaxIter = 500;
options.MaxIter

ans =
   500

Input Arguments

options — fitoptions object

fitoptions (default)

fitoptions object of which you want to get the property names and values, specified as a fitoptions object.

field — Property value

string scalar | character vector | cell array of character vectors

Property value of the fitoptions object options that you want to get, specified as a string scalar, character vector, or a cell array of character vectors.

Data Types: char | string | cell

Output Arguments

s — fitoptions object

fitoptions

Copy of the fitoptions object, returned as a fitoptions object.

value — Property value

scalar | vector | matrix | cell

Property value of the fitoptions object s, returned as a scalar, a vector, a matrix, or a cell.

Version History

Introduced before R2006a