xal.tools.math

Class ErrorPropagator

java.lang.Object

xal.tools.math.ErrorPropagator

public class ErrorPropagator
extends java.lang.Object

Propagates errors from independent source variables to the specified operation using standard error propagation.

Constructor Summary

Constructors

Constructor and Description
ErrorPropagator(DifferentiableOperation baseOperation, DifferentiableVariable... sourceVariables) Constructor

Method Summary

Modifier and Type	Method and Description
static ErrorPropagator	getInstance(DifferentiableOperation baseOperation, DifferentiableVariable... sourceVariables) Construct an instance of this class
double	getSigma() Calculate the operation standard error propagated from the default source variances
double	getVariance() Calculate the operation variance propagated from the default source variances
double	getVarianceWithCommonSourceVariance(double sourceVariance) Calculate the operation variance propagated from a common source variance.
double	getVarianceWithSourceVariances(double... sourceVariances) Calculate the operation variance propagated from the source variances.
void	setCommonSourceSigma(double sigma) Set a common sigma to use as the default for all source variables
void	setCommonSourceVariance(double variance) Set a common variance to use as the default for all source variables
void	setSourceSigma(DifferentiableVariable sourceVariable, double sigma) Set the default standard deviation for the specified source variable
void	setSourceVariance(DifferentiableVariable sourceVariable, double variance) Set the default variance for the specified source variable
void	setSourceVariances(double... sourceVariances) Set the default variances for the source variables

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorPropagator

public ErrorPropagator(DifferentiableOperation baseOperation,
                       DifferentiableVariable... sourceVariables)

Constructor

Parameters:

baseOperation - the operation for which the error propagation will be performed

sourceVariables - independent variables from which source errors are to be propagated

Method Detail

getInstance

public static ErrorPropagator getInstance(DifferentiableOperation baseOperation,
                                          DifferentiableVariable... sourceVariables)

Construct an instance of this class

Parameters:

baseOperation - the operation for which the error propagation will be performed

sourceVariables - independent variables from which source errors are to be propagated

setSourceVariance

public void setSourceVariance(DifferentiableVariable sourceVariable,
                              double variance)

Set the default variance for the specified source variable

Parameters:

sourceVariable - variable for which to assign the variance

variance - the variance to assign the variable

setSourceVariances

public void setSourceVariances(double... sourceVariances)

Set the default variances for the source variables

Parameters:

sourceVariances - the variances to each source in the order they were specified in the constructor

setCommonSourceVariance

public void setCommonSourceVariance(double variance)

Set a common variance to use as the default for all source variables

setCommonSourceSigma

public void setCommonSourceSigma(double sigma)

Set a common sigma to use as the default for all source variables

setSourceSigma

public void setSourceSigma(DifferentiableVariable sourceVariable,
                           double sigma)

Set the default standard deviation for the specified source variable

Parameters:

sourceVariable - variable for which to assign the variance

sigma - standard deviation to assign the variable

getVariance

public double getVariance()

Calculate the operation variance propagated from the default source variances

getVarianceWithCommonSourceVariance

public double getVarianceWithCommonSourceVariance(double sourceVariance)

Calculate the operation variance propagated from a common source variance. Note that this assignment is only for the current calculation and does change the default source variances.

getVarianceWithSourceVariances

public double getVarianceWithSourceVariances(double... sourceVariances)

Calculate the operation variance propagated from the source variances. Note that this assignment is only for the current calculation and does change the default source variances.

getSigma

public double getSigma()

Calculate the operation standard error propagated from the default source variances