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

Class EmpiricOrbitCorrectionModel

java.lang.Object

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

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

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

org.scictrl.mp.orbitcorrect.correction.models.EmpiricOrbitCorrectionModel

All Implemented Interfaces:

IOrbitCorrectionModel, ISVDOrbitCorrectionModel, IConfigurable, IOrientationMarker

public class EmpiricOrbitCorrectionModel
extends AbstractSVDOrbitCorrectionModel

EmpiricOrbitCorrectionModel 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
EmpiricOrbitCorrectionModel()	RingKeeper constructor comment.

Method Summary

Modifier and Type	Method	Description
Correction	calculateCorrection(OrbitCorrectionOperator engine)	calculateCorrection.
int	getAverageBPMsOver()	Getter for the field averageBPMsOver.
ResponseMatrix	getCoupledResponseMatrix()	getCoupledResponseMatrix.
double	getDeltaAngle()	Getter for the field deltaAngle.
protected Correction	makeCorrection(ElementList<AbstractCorrector> correctors, Orbit orbit, ResponseMatrix responseMatrix, DataBush db, OrbitCorrectionOperator oc)	makeCorrection.
ResponseMatrix	measureResponseMatrix(boolean showProgress, ElementList<AbstractCorrector> correctors, ElementList<BPMonitor> monitors, DataBush databush)	measureResponseMatrix.
void	setAverageBPMsOver(int newAverageBPMsOver)	Setter for the field averageBPMsOver.
void	setDeltaAngle(double newDeltaAngle)	Setter for the field deltaAngle.
String	toString()

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

getBeamAverage, getOffset, isMakeShift, isModelCalculatesOffset, setMakeShift, setModelCalculatesOffset, setOffset

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, wait, wait, wait

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

getName, initialize

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

getOrientation, isHorizontal, isVertical

Constructor Details

EmpiricOrbitCorrectionModel

public EmpiricOrbitCorrectionModel()

RingKeeper constructor comment.

Method Details

getAverageBPMsOver

public int getAverageBPMsOver()

Getter for the field averageBPMsOver.

Returns:

int

getCoupledResponseMatrix

public ResponseMatrix getCoupledResponseMatrix()

getCoupledResponseMatrix.

Returns:

ResponseMatrix

getDeltaAngle

public double getDeltaAngle()

Getter for the field deltaAngle.

Returns:

double

makeCorrection

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

makeCorrection.

Overrides:

makeCorrection in class AbstractSVDOrbitCorrectionModel

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.

measureResponseMatrix

public ResponseMatrix measureResponseMatrix(boolean showProgress,
 ElementList<AbstractCorrector> correctors,
 ElementList<BPMonitor> monitors,
 DataBush databush)
                                     throws DataBushPackedException

measureResponseMatrix.

Parameters:

showProgress - boolean

correctors - a ElementList object

monitors - a ElementList object

databush - a DataBush object

Returns:

ResponceMatrix

Throws:

DataBushPackedException - if any.

setAverageBPMsOver

public void setAverageBPMsOver(int newAverageBPMsOver)

Setter for the field averageBPMsOver.

Parameters:

newAverageBPMsOver - int

setDeltaAngle

public void setDeltaAngle(double newDeltaAngle)

Setter for the field deltaAngle.

Parameters:

newDeltaAngle - double

toString

public String toString()

Overrides:

toString in class Object

calculateCorrection

public Correction calculateCorrection(OrbitCorrectionOperator engine)
                               throws InconsistentDataException

calculateCorrection.

Parameters:

engine - a OrbitCorrectionOperator object

Returns:

double[]

Throws:

InconsistentDataException - if any.