Package cern.accsoft.steering.aloha.calc.sensitivity

Interface SensitivityMatrixContributor

All Known Implementing Classes:

DispersionSensitivityMatrixContributor, KickResponseSensitivityMatrixContributor, MultiturnBetaSensitivityMatrixContributor, Ti8CollimatorConstraintsContributor, TrajectorySensitivityMatrixContributor

public interface SensitivityMatrixContributor

this interface defines methods for classes, that can contribute to the overall sensitivity-matrix. It defines methods which then can be used by SensitivityMatrixManagerImpl to query parts of the matrix. NOTE: All matrices must have to same number of rows. The number of columns in general are different.

Method Summary

Modifier and Type	Method	Description
Jama.Matrix	calcCorrectorSensitivityMatrix()
Jama.Matrix	calcMonitorSensitivityMatrix()
PerturbedColumn	calcPerturbedColumn(double delta, java.lang.Double normalizationFactor)
Jama.Matrix	getDifferenceVector()
Jama.Matrix	getDifferenceVectorErrors()	This method must return a vector which has the same dimensions as the difference-vector as returned by getDifferenceVector().
int	getMatrixRowCount()	this method can be called to determine the designated number of rows of the matrices that will be produced by this contributor.
Measurement	getMeasurement()
java.lang.String	getName()
void	initUnperturbed()	this method is called by the SensitivityMatrixManagerImpl, to make it possible for the contributors to store their unperturbed values, in order to be able to correctly calculate the perturbed values later on.

Method Detail

getMeasurement

Measurement getMeasurement()

Returns:

the measurement to which this contributor is related to.

initUnperturbed

void initUnperturbed()

this method is called by the SensitivityMatrixManagerImpl, to make it possible for the contributors to store their unperturbed values, in order to be able to correctly calculate the perturbed values later on.

getName

java.lang.String getName()

Returns:

a name for the contributor, which can be displayed

getMatrixRowCount

int getMatrixRowCount()

this method can be called to determine the designated number of rows of the matrices that will be produced by this contributor.

Returns:

the number of rows of the matrices.

calcMonitorSensitivityMatrix

Jama.Matrix calcMonitorSensitivityMatrix()

Returns:

the part of the sensitivity-matrix corresponding to the monitor-gains.

calcCorrectorSensitivityMatrix

Jama.Matrix calcCorrectorSensitivityMatrix()

Returns:

the part of the sensitivity-matrix corresponding to the corrector-gains.

calcPerturbedColumn

PerturbedColumn calcPerturbedColumn(double delta,
                                    java.lang.Double normalizationFactor)

Parameters:

delta - the variation that was used to trim the parameter. This is needed by the method to calc the gradient correctly.

normalizationFactor - the normalization factor to use to calc the column. If none is given (null) then the own normalization-factor must be calculated by the method.

Returns:

a column, which represents the perturbation of the actual values in comparison to the default one.

getDifferenceVector

Jama.Matrix getDifferenceVector()

Returns:

the difference-vector between measurement-model, corresponding to the rows in the other matrices

getDifferenceVectorErrors

Jama.Matrix getDifferenceVectorErrors()

This method must return a vector which has the same dimensions as the difference-vector as returned by getDifferenceVector(). This vector shall represent the errors on the difference vector. It will be used to estimate the errors on the fitted parameters.

Returns:

a vector representing the errors on the difference vector.