Package cern.accsoft.steering.aloha.plugin.disp.sensitivity

Class DispersionSensitivityMatrixContributor

java.lang.Object

cern.accsoft.steering.aloha.plugin.disp.sensitivity.DispersionSensitivityMatrixContributor

All Implemented Interfaces:

BeanAware, MachineElementsManagerAware, NoiseWeighterAware, SensitivityMatrixContributor

public class DispersionSensitivityMatrixContributor
extends java.lang.Object
implements SensitivityMatrixContributor, NoiseWeighterAware, MachineElementsManagerAware

This class is responsible for creating correct parts of the sensitivity-matrix, corresponding to the dispersion-data

Constructor Summary

Constructors

Constructor	Description
DispersionSensitivityMatrixContributor()

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 SensitivityMatrixContributor.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.
void	setDispersionMeasurement(DispersionMeasurementImpl dispersionMeasurement)
void	setMachineElementsManager(MachineElementsManager machineElementsManager)	by the use of this method the MachineElementsManager is injected if the class is configured by the AlohaBeanFactory
void	setNoiseWeighter(NoiseWeighter noiseWeighter)	this method is used by the AlohaBeanFactory to inject the NoiseWeighter instance

Methods inherited from class java.lang.Object

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

Constructor Detail

DispersionSensitivityMatrixContributor

public DispersionSensitivityMatrixContributor()

Method Detail

calcCorrectorSensitivityMatrix

public Jama.Matrix calcCorrectorSensitivityMatrix()

Specified by:

calcCorrectorSensitivityMatrix in interface SensitivityMatrixContributor

Returns:

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

calcMonitorSensitivityMatrix

public Jama.Matrix calcMonitorSensitivityMatrix()

Specified by:

calcMonitorSensitivityMatrix in interface SensitivityMatrixContributor

Returns:

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

calcPerturbedColumn

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

Specified by:

calcPerturbedColumn in interface SensitivityMatrixContributor

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

public Jama.Matrix getDifferenceVector()

Specified by:

getDifferenceVector in interface SensitivityMatrixContributor

Returns:

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

getMatrixRowCount

public int getMatrixRowCount()

Description copied from interface: SensitivityMatrixContributor

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

Specified by:

getMatrixRowCount in interface SensitivityMatrixContributor

Returns:

the number of rows of the matrices.

getName

public java.lang.String getName()

Specified by:

getName in interface SensitivityMatrixContributor

Returns:

a name for the contributor, which can be displayed

initUnperturbed

public void initUnperturbed()

Description copied from interface: SensitivityMatrixContributor

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.

Specified by:

initUnperturbed in interface SensitivityMatrixContributor

setMachineElementsManager

public void setMachineElementsManager(MachineElementsManager machineElementsManager)

Description copied from interface: MachineElementsManagerAware

by the use of this method the MachineElementsManager is injected if the class is configured by the AlohaBeanFactory

Specified by:

setMachineElementsManager in interface MachineElementsManagerAware

Parameters:

machineElementsManager - the machineElementsManager to set

setNoiseWeighter

public void setNoiseWeighter(NoiseWeighter noiseWeighter)

Description copied from interface: NoiseWeighterAware

this method is used by the AlohaBeanFactory to inject the NoiseWeighter instance

Specified by:

setNoiseWeighter in interface NoiseWeighterAware

Parameters:

noiseWeighter - the noiseWeighter to set

setDispersionMeasurement

public void setDispersionMeasurement(DispersionMeasurementImpl dispersionMeasurement)

getMeasurement

public Measurement getMeasurement()

Specified by:

getMeasurement in interface SensitivityMatrixContributor

Returns:

the measurement to which this contributor is related to.

getDifferenceVectorErrors

public Jama.Matrix getDifferenceVectorErrors()

Description copied from interface: SensitivityMatrixContributor

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

Specified by:

getDifferenceVectorErrors in interface SensitivityMatrixContributor

Returns:

a vector representing the errors on the difference vector.