Skip to Main Content Skip to Search
Product Documentation

SpeciesInputFactors - Specify species inputs for sensitivity analysis

Description

Use the SpeciesInputFactors property to specify the species with respect to which you want to compute the sensitivities of the species states in your model.

SpeciesInputFactors is a property of the SensitivityAnalysisOptions object. SenstivityAnalysisOptions is a property of the configuration set object.

The SimBiology software calculates sensitivities with respect to the initial amounts of the species specified in this property. When you simulate a model with SensitivityAnalysis enabled in the active configuration set object, sensitivity analysis returns the computed sensitivities of the species specified in StatesToLog. For a description of the output, see the SensitivityAnalysisOptions property description.

Characteristics

Applies toObject: SensitivityAnalysisOptions
Data typeSpecies object or array of species objects
Data valuesSpecies object array. Default is [] (empty).
AccessRead/write

Examples

This example shows how to set SpeciesInputFactors for sensitivity analysis.

  1. Import the radio decay model from the SimBiology demos.

    modelObj  = sbmlimport('radiodecay');
  2. Retrieve the configuration set object from modelObj.

    configsetObj = getconfigset(modelObj);
  3. Add a species to the SpeciesInputFactors property and display. Use the sbioselect function to retrieve the species object from the model.

    set(configsetObj.SensitivityAnalysisOptions,'SpeciesInputFactors', sbioselect(modelObj, 'Type', 'species', 'Name', 'z'));
    get (configsetObj.SensitivityAnalysisOptions, 'SpeciesInputFactors')
    SimBiology Species Array
    
    Index:  Compartment:  Name:  InitialAmount: InitialAmountUnits:
      1       unnamed      z        0              molecule

See Also

ParameterInputFactors, sbioselect, SensitivityAnalysis, SensitivityAnalysisOptions

  


Free Computational Biology Interactive Kit

See how to analyze, visualize, and model biological data and systems using MathWorks products.

Get free kit

Trials Available

Try the latest computational biology products.

Get trial software
 © 1984-2012- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS