Package org.moeaframework.analysis.tools

Class SobolAnalysis

java.lang.Object
org.moeaframework.util.CommandLineUtility
org.moeaframework.analysis.tools.SobolAnalysis
public class SobolAnalysis extends CommandLineUtility
Global sensitivity analysis of blackbox model output using Saltelli's improved Sobol' global variance decomposition procedure.

The following code was derived and translated from the C code used in the study cited below. Refer to this article for a description of the procedure.

References:

  1. Tang, Y., Reed, P., Wagener, T., and van Werkhoven, K., "Comparing Sensitivity Analysis Methods to Advance Lumped Watershed Model Identification and Evaluation," Hydrology and Earth System Sciences, vol. 11, no. 2, pp. 793-817, 2007.
  2. Saltelli, A., et al. "Global Sensitivity Analysis: The Primer." John Wiley & Sons Ltd, 2008.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SobolAnalysis()
    Constructs the command line utility for global sensitivity analysis using Sobol's global variance decomposition based on Saltelli's work.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.commons.cli.Options
    getOptions()
    Returns the options made available by this command line utility.
    static void
    main(String[] args)
    Command line utility for global sensitivity analysis using Sobol's global variance decomposition based on Saltelli's work.
    void
    run(org.apache.commons.cli.CommandLine commandLine)
    Runs this command line utility with the specified command line arguments.

    Methods inherited from class org.moeaframework.util.CommandLineUtility

    getCommandString, getLocalizedOptions, setCommandString, showHelp, start

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SobolAnalysis

      public SobolAnalysis()
      Constructs the command line utility for global sensitivity analysis using Sobol's global variance decomposition based on Saltelli's work.

  • Method Details

    • getOptions

      public org.apache.commons.cli.Options getOptions()
      Description copied from class: CommandLineUtility
      Returns the options made available by this command line utility. The base implementation automatically provides the -h,--help option. Implementations overriding this method and begin with a call to super.getOptions().
      Overrides:
      getOptions in class CommandLineUtility
      Returns:
      the options made available by this command line utility

    • run

      public void run(org.apache.commons.cli.CommandLine commandLine) throws Exception
      Description copied from class: CommandLineUtility
      Runs this command line utility with the specified command line arguments.
      Specified by:
      run in class CommandLineUtility
      Parameters:
      commandLine - the command line arguments
      Throws:
      Exception - if any exception occurred while running this command

    • main

      public static void main(String[] args) throws Exception
      Command line utility for global sensitivity analysis using Sobol's global variance decomposition based on Saltelli's work.
      Parameters:
      args - the command line arguments
      Throws:
      Exception - if an error occurred