Spike Toolbox

STOptions
Retrieve and set options for the Spike Toolbox

Syntax
[stOptions] = STOptions STOptions(stOptions) [stOptionsOld] = STOptions(stOptionsNew)

Description
The first usage will retrieve the current toolbox options, for the user to either examine or modify. The modified options can them be set by calling STOptions with the second usage mode.

The third usage will set the toolbox options, and return the previous options in stOptionsOld.

STOptions must be called with a valid options structure, as defined by STIsValidOptionsStruct. This structure must contain values for all of the Spike Toolbox options. The easiest way to do this is to use STOptions to retrieve the current options, modify the returned structure and pass the modified structure back to STOptions. STOptions guarantees to return a valid options structure.

Note that modifying the structure is not enough; to set the toolbox options, the structure must be passed back to STOptions as an argument.

Various utility functions exist to make setting addressing modes easier. See the STAddrSpec... family of functions in the categorical function index for details.

STDescribe will print a summary of the toolbox options when passed an options structure as an argument. STOptionsDescribe will describe the current toolbox options.

$Id: STOptions.html 1783 2005-08-31 21:05:51Z dylan $