Package org.scictrl.mp.orbitcorrect.correction.models

Class AbstractSVDBasedModel

java.lang.Object

org.scictrl.mp.orbitcorrect.correction.models.AbstractOCModel

org.scictrl.mp.orbitcorrect.correction.models.AbstractSVDBasedModel

All Implemented Interfaces:

IOrbitCorrectionModel, ISVDOrbitCorrectionModel, IConfigurable, IOrientationMarker

Direct Known Subclasses:

AbstractSVDOrbitCorrectionModel, CorrectorStrengthReductionModel, ResponseMatrixBumpModel

public abstract class AbstractSVDBasedModel
extends AbstractOCModel
implements ISVDOrbitCorrectionModel, IConfigurable

Abstract AbstractSVDBasedModel class.

Author:

igor@scictrl.com

Field Summary

Fields

Modifier and Type	Field	Description
protected double	correctorRMS	Calculated correctors RMS
protected double[]	eigenvalues	Calculates eigenvalues
protected int	eigenvectorsUsed	Calculated eigenvectors used
protected double	maxCorrection	Calculated max correction
protected double	minimalEigenvalue	Minimal eigenvalues threshold
protected double	minimalReductionEigenvalue	Minimal eigenvalues threshold for strength reduction
protected double	reductedBPMChange	Calculated strength reduction BPM change
protected double	reductedCorrectorChange	Calculated strength reduction corrector change
protected double[]	reductionEigenvalues	Eigenvectors used for strength reduction
protected int	reductionEigenvectorsUsed	Calculated eigenvectors used for strength reduction
protected boolean	reductionEnabled	Strength reduction enabled
protected double	reductionScale	Strength reduction scale
protected double	theoreticalBeamRMS	Calculated Beam RMS theoretical prediction

Fields inherited from class org.scictrl.mp.orbitcorrect.correction.models.AbstractOCModel

debug, name

Constructor Summary

Constructors

Constructor	Description
AbstractSVDBasedModel()	RingKeeper constructor comment.

Method Summary

Modifier and Type	Method	Description
protected void	addReduction(ElementList<BPMonitor> monitors, ElementList<AbstractCorrector> correctors, ResponseMatrix responseMatrix, double[] correction)	makeCorrection method comment.
void	configure(org.apache.commons.configuration.Configuration conf)	configure.
double[]	getEigenvalues()	getEigenvalues.
int	getEigenvectorsUsed()	getEigenvectorsUsed.
double	getMinimalEigenvalue()	getMinimalEigenvalue.
double	getMinimalReductionEigenvalue()	Getter for the field minimalReductionEigenvalue.
boolean	isReductionEnabled()	isReductionEnabled.
protected abstract Correction	makeCorrection(ElementList<AbstractCorrector> correctors, Orbit orbit, ResponseMatrix responseMatrix, DataBush db, OrbitCorrectionOperator op)	makeCorrection.
protected void	makeSVDInversion(double[] B, ResponseMatrix responseMatrix, double[] correction, DataBush db)	makeSVDInversion.
void	setMinimalEigenvalue(double newMinimalEigenvalue)	setMinimalEigenvalue.
void	setMinimalReductionEigenvalue(double newMinimalReductionEigenvalue)	Setter for the field minimalReductionEigenvalue.
void	setReductionEnabled(boolean newReductionEnabled)	Setter for the field reductionEnabled.
void	setReductionScale(double newReductionScale)	Setter for the field reductionScale.

Methods inherited from class org.scictrl.mp.orbitcorrect.correction.models.AbstractOCModel

getName, getOrientation, initialize, isHorizontal, isVertical, read, readOther, testCorrectors, testMonitors

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scictrl.mp.orbitcorrect.correction.IOrbitCorrectionModel

calculateCorrection, getName, initialize

Methods inherited from interface org.scictrl.mp.orbitcorrect.IOrientationMarker

getOrientation, isHorizontal, isVertical

Field Details

maxCorrection

protected double maxCorrection

Calculated max correction

theoreticalBeamRMS

protected double theoreticalBeamRMS

Calculated Beam RMS theoretical prediction

correctorRMS

protected double correctorRMS

Calculated correctors RMS

eigenvalues

protected double[] eigenvalues

Calculates eigenvalues

minimalEigenvalue

protected double minimalEigenvalue

Minimal eigenvalues threshold

eigenvectorsUsed

protected int eigenvectorsUsed

Calculated eigenvectors used

reductionEnabled

protected boolean reductionEnabled

Strength reduction enabled

reductionScale

protected double reductionScale

Strength reduction scale

reductedCorrectorChange

protected double reductedCorrectorChange

Calculated strength reduction corrector change

reductedBPMChange

protected double reductedBPMChange

Calculated strength reduction BPM change

minimalReductionEigenvalue

protected double minimalReductionEigenvalue

Minimal eigenvalues threshold for strength reduction

reductionEigenvectorsUsed

protected int reductionEigenvectorsUsed

Calculated eigenvectors used for strength reduction

reductionEigenvalues

protected double[] reductionEigenvalues

Eigenvectors used for strength reduction

Constructor Details

AbstractSVDBasedModel

public AbstractSVDBasedModel()

RingKeeper constructor comment.

Method Details

getMinimalEigenvalue

public double getMinimalEigenvalue()

getMinimalEigenvalue.

Specified by:

getMinimalEigenvalue in interface ISVDOrbitCorrectionModel

Returns:

a double

getEigenvectorsUsed

public int getEigenvectorsUsed()

getEigenvectorsUsed.

Specified by:

getEigenvectorsUsed in interface ISVDOrbitCorrectionModel

Returns:

a int

getEigenvalues

public double[] getEigenvalues()

getEigenvalues.

Specified by:

getEigenvalues in interface ISVDOrbitCorrectionModel

Returns:

an array of

invalid reference

double

objects

addReduction

protected void addReduction(ElementList<BPMonitor> monitors,
 ElementList<AbstractCorrector> correctors,
 ResponseMatrix responseMatrix,
 double[] correction)
                     throws InconsistentDataException

makeCorrection method comment.

Parameters:

monitors - a ElementList object

correctors - a ElementList object

responseMatrix - a ResponseMatrix object

correction - an array of

invalid reference

double

objects

Throws:

InconsistentDataException - if any.

getMinimalReductionEigenvalue

public double getMinimalReductionEigenvalue()

Getter for the field minimalReductionEigenvalue.

Returns:

double

isReductionEnabled

public boolean isReductionEnabled()

isReductionEnabled.

Returns:

boolean

makeSVDInversion

protected void makeSVDInversion(double[] B,
 ResponseMatrix responseMatrix,
 double[] correction,
 DataBush db)
                         throws InconsistentDataException

makeSVDInversion.

Parameters:

B - an array of

invalid reference

double

objects

responseMatrix - a ResponseMatrix object

correction - an array of

invalid reference

double

objects

db - a DataBush object

Throws:

InconsistentDataException - if any.

setMinimalEigenvalue

public void setMinimalEigenvalue(double newMinimalEigenvalue)

setMinimalEigenvalue.

Specified by:

setMinimalEigenvalue in interface ISVDOrbitCorrectionModel

Parameters:

newMinimalEigenvalue - double

setMinimalReductionEigenvalue

public void setMinimalReductionEigenvalue(double newMinimalReductionEigenvalue)

Setter for the field minimalReductionEigenvalue.

Parameters:

newMinimalReductionEigenvalue - double

setReductionEnabled

public void setReductionEnabled(boolean newReductionEnabled)

Setter for the field reductionEnabled.

Parameters:

newReductionEnabled - boolean

setReductionScale

public void setReductionScale(double newReductionScale)

Setter for the field reductionScale.

Parameters:

newReductionScale - double

configure

public void configure(org.apache.commons.configuration.Configuration conf)

configure.

Specified by:

configure in interface IConfigurable

Parameters:

conf - a Configuration object

makeCorrection

protected abstract Correction makeCorrection(ElementList<AbstractCorrector> correctors,
 Orbit orbit,
 ResponseMatrix responseMatrix,
 DataBush db,
 OrbitCorrectionOperator op)
                                      throws InconsistentDataException

makeCorrection.

Parameters:

correctors - a ElementList object

orbit - a Orbit object

responseMatrix - a ResponseMatrix object

db - a DataBush object

op - a OrbitCorrectionOperator object

Returns:

a Correction object

Throws:

InconsistentDataException - if any.