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

Class AbstractSVDOrbitCorrectionModel

java.lang.Object

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

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

org.scictrl.mp.orbitcorrect.correction.models.AbstractSVDOrbitCorrectionModel

All Implemented Interfaces:

IOrbitCorrectionModel, ISVDOrbitCorrectionModel, IConfigurable, IOrientationMarker

Direct Known Subclasses:

DefaultOrbitCorrectionModel, EmpiricOrbitCorrectionModel, FixBPMsOrbitCorrectionModel, FrequencyOrbitCorrectionModel

public abstract class AbstractSVDOrbitCorrectionModel
extends AbstractSVDBasedModel

Abstract AbstractSVDOrbitCorrectionModel class.

Author:

igor@scictrl.com

Field Summary

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

correctorRMS, eigenvalues, eigenvectorsUsed, maxCorrection, minimalEigenvalue, minimalReductionEigenvalue, reductedBPMChange, reductedCorrectorChange, reductionEigenvalues, reductionEigenvectorsUsed, reductionEnabled, reductionScale, theoreticalBeamRMS

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

debug, name

Constructor Summary

Constructors

Constructor	Description
AbstractSVDOrbitCorrectionModel()	RingKeeper constructor comment.

Method Summary

Modifier and Type	Method	Description
double	getBeamAverage()	Getter for the field beamAverage.
double	getOffset()	Getter for the field offset.
boolean	isMakeShift()	isMakeShift.
boolean	isModelCalculatesOffset()	isModelCalculatesOffset.
protected Correction	makeCorrection(ElementList<AbstractCorrector> correctors, Orbit orbit, ResponseMatrix responseMatrix, DataBush db, OrbitCorrectionOperator oc)	makeCorrection.
void	setMakeShift(boolean newMakeShift)	Setter for the field makeShift.
void	setModelCalculatesOffset(boolean newModelCalculatesOffset)	Setter for the field modelCalculatesOffset.
void	setOffset(double newShiftConstant)	Setter for the field offset.

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

addReduction, configure, getEigenvalues, getEigenvectorsUsed, getMinimalEigenvalue, getMinimalReductionEigenvalue, isReductionEnabled, makeSVDInversion, setMinimalEigenvalue, setMinimalReductionEigenvalue, setReductionEnabled, setReductionScale

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

Constructor Details

AbstractSVDOrbitCorrectionModel

public AbstractSVDOrbitCorrectionModel()

RingKeeper constructor comment.

Method Details

getBeamAverage

public double getBeamAverage()

Getter for the field beamAverage.

Returns:

double

getOffset

public double getOffset()

Getter for the field offset.

Returns:

double

isMakeShift

public boolean isMakeShift()

isMakeShift.

Returns:

boolean

isModelCalculatesOffset

public boolean isModelCalculatesOffset()

isModelCalculatesOffset.

Returns:

boolean

makeCorrection

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

makeCorrection.

Specified by:

makeCorrection in class AbstractSVDBasedModel

Parameters:

correctors - a ElementList object

orbit - a Orbit object

responseMatrix - a ResponseMatrix object

db - a DataBush object

oc - a OrbitCorrectionOperator object

Returns:

a Correction object

Throws:

InconsistentDataException - if any.

setMakeShift

public void setMakeShift(boolean newMakeShift)

Setter for the field makeShift.

Parameters:

newMakeShift - boolean

setModelCalculatesOffset

public void setModelCalculatesOffset(boolean newModelCalculatesOffset)

Setter for the field modelCalculatesOffset.

Parameters:

newModelCalculatesOffset - a boolean

setOffset

public void setOffset(double newShiftConstant)

Setter for the field offset.

Parameters:

newShiftConstant - double