Skip to contents

Results of a sensitivity analysis run (either individual or population simulation).

Super classes

ospsuite.utils::Printable -> ospsuite::DotNetWrapper -> SensitivityAnalysisResults

Active bindings

simulation

Reference to the Simulation used to calculate or import the sensitivity analysis results (Read-Only).

count

the number of pk parameter sensitivity entries

allPKParameterNames

Returns the name of all PK-Parameters available in this results. This will be a subset of all potential PK-Parameters available in the system.

allQuantityPaths

Returns the path of all outputs available in this results.

Methods

Inherited methods


    Method new()

    Initialize a new instance of the class

    Usage

    SensitivityAnalysisResults$new(ref, simulation)

    Arguments

    ref

    A .NET Instance.

    simulation

    Reference to the simulation object used to calculated the results.

    Returns

    A new SensitivityAnalysisResults object.


    Method allPKParameterSensitivitiesFor()

    Returns the PKParameterSensitivity for a given pkParameter and output participating to a total sensitivity greater or equal to totalSensitivityThreshold.

    Usage

    SensitivityAnalysisResults$allPKParameterSensitivitiesFor(
      pkParameterName,
      outputPath,
     
        totalSensitivityThreshold = ospsuiteEnv$sensitivityAnalysisConfig$totalSensitivityThreshold
    )

    Arguments

    pkParameterName

    Name of pkParameter for which sensitivity should be retrieved.

    outputPath

    Path of the output for which the sensitivity should be retrieved

    totalSensitivityThreshold

    Threshold used to filter out the most sensitive parameter. A threshold of 0.9 means that only parameter participating to a total of 90 percent of the sensitivity would be returned. A value of 1 would return the sensitivity for all parameters.


    Method pkParameterSensitivityValueFor()

    Returns the sensitivity value for a given pkParameter, output and model parameter (either by path or by name). If the sensitivity result does not exist, returns NaN.

    Usage

    SensitivityAnalysisResults$pkParameterSensitivityValueFor(
      pkParameterName,
      outputPath,
      parameterName = NULL,
      parameterPath = NULL
    )

    Arguments

    pkParameterName

    Name of pkParameter for which sensitivity should be retrieved.

    outputPath

    Path of the output for which the sensitivity should be retrieved.

    parameterName

    Name of the sensitivity parameter for which the sensitivity should be retrieved.

    parameterPath

    Path of the sensitivity parameter for which the sensitivity should be retrieved. Wildcards (*) not accepted.


    Method print()

    Print the object to the console

    Usage

    SensitivityAnalysisResults$print(...)

    Arguments

    ...

    Rest arguments.