About the Noise Analysis Component API

The Noise Analysis component provides an API for programmatically configuring the Noise Analysis component using a Java program.

For information about component APIs, see Component APIs.

The Noise Analysis component API consists of the following methods:

set("NumEvaluations", int numEvals)
This method sets the number of evaluations per input.
get("NumEvaluations")
This method returns the number of evaluations per input.
set("DomainFraction", int fraction)
This method sets the fraction (as a percentage) of the total domain (as defined by any lower and upper bounds specified) over which to vary the inputs. For inputs without lower/upper bounds defined, this percentage is used to define a range around the current parameter value.
get("DomainFraction")
This method returns the fraction of the total domain over which to vary the inputs.
set("ExecuteInParallel", boolean execInParallel)
This method sets whether or not to execute all of the runs in parallel.
get("ExecuteInParallel")
This method returns whether or not the runs will be executed in parallel.
add("Input", String name)
This method adds the parameter with the specified name as an input to vary for noise analysis.
add("Input", VariableReference varRef)
This method adds the parameter associated with the specified VariableReference as an input to vary for noise analysis.
add("Output", String name)
This method adds the parameter with the specified name as an output to vary for noise analysis.
add("Output", VariableReference varRef)
This method adds the parameter associated with the specified VariableReference as an output to vary for noise analysis.
get("Plan")

This method returns a DOEPlan object from the com.engineous.sdk.designdrivers.plan package. From that entry point you have access to numerous methods for setting/configuring the technique, adding/editing factors (inputs to vary) and responses (outputs to study), and configuring execution options. For more information on configuring the Noise Analysis component using the DOEPlan object, refer to the javadoc for the DOEPlan interface—open the following file in a web browser:

<Isight_install_directory>/Doc/docs/api/_index/main.html