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

Class ResponseMatrixBumpModel

java.lang.Object

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

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

org.scictrl.mp.orbitcorrect.correction.models.ResponseMatrixBumpModel

All Implemented Interfaces:

IOrbitCorrectionModel, ISVDOrbitCorrectionModel, IConfigurable, IOrientationMarker

public class ResponseMatrixBumpModel
extends AbstractSVDBasedModel

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

Method Summary

Modifier and Type	Method	Description
Correction	calculateCorrection(OrbitCorrectionOperator engine)	calculateCorrection.
int	getBumpedCount()	Getter for the field bumpedCount.
BPMonitor	getBumpedElement()	Getter for the field bumpedElement.
double	getBumpHeight()	Getter for the field bumpHeight.
ResponseMatrix	getExternalResponseMatrix()	Getter for the field externalResponseMatrix.
boolean	isUseExternalResponseMatrix()	isUseExternalResponseMatrix.
protected Correction	makeCorrection(ElementList<AbstractCorrector> correctors, Orbit orbit, ResponseMatrix responseMatrix, DataBush db, OrbitCorrectionOperator op)	makeCorrection.
void	setBumpedCount(int newBumpedCount)	Setter for the field bumpedCount.
void	setBumpedElement(BPMonitor newBumpedElement)	Setter for the field bumpedElement.
void	setBumpHeight(double newBumpHeight)	Setter for the field bumpHeight.
void	setExternalResponseMatrix(ResponseMatrix newExternalResponseMatrix)	Setter for the field externalResponseMatrix.
void	setUseExternalResponseMatrix(boolean newUseExternalResponseMatrix)	Setter for the field useExternalResponseMatrix.

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

getName, initialize

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

getOrientation, isHorizontal, isVertical

Constructor Details

ResponseMatrixBumpModel

public ResponseMatrixBumpModel()

RingKeeper constructor comment.

Method Details

getBumpedCount

public int getBumpedCount()

Getter for the field bumpedCount.

Returns:

int

getBumpedElement

public BPMonitor getBumpedElement()

Getter for the field bumpedElement.

Returns:

BPMonitor

getBumpHeight

public double getBumpHeight()

Getter for the field bumpHeight.

Returns:

double

getExternalResponseMatrix

public ResponseMatrix getExternalResponseMatrix()

Getter for the field externalResponseMatrix.

Returns:

ResponseMatrix

isUseExternalResponseMatrix

public boolean isUseExternalResponseMatrix()

isUseExternalResponseMatrix.

Returns:

boolean

calculateCorrection

public Correction calculateCorrection(OrbitCorrectionOperator engine)
                               throws InconsistentDataException

calculateCorrection.

Parameters:

engine - a OrbitCorrectionOperator object

Returns:

double[]

Throws:

InconsistentDataException - if any.

makeCorrection

protected Correction makeCorrection(ElementList<AbstractCorrector> correctors,
 Orbit orbit,
 ResponseMatrix responseMatrix,
 DataBush db,
 OrbitCorrectionOperator op)
                             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

op - a OrbitCorrectionOperator object

Returns:

a Correction object

Throws:

InconsistentDataException - if any.

setBumpedCount

public void setBumpedCount(int newBumpedCount)

Setter for the field bumpedCount.

Parameters:

newBumpedCount - int

setBumpedElement

public void setBumpedElement(BPMonitor newBumpedElement)

Setter for the field bumpedElement.

Parameters:

newBumpedElement - BPMonitor

setBumpHeight

public void setBumpHeight(double newBumpHeight)

Setter for the field bumpHeight.

Parameters:

newBumpHeight - double

setExternalResponseMatrix

public void setExternalResponseMatrix(ResponseMatrix newExternalResponseMatrix)

Setter for the field externalResponseMatrix.

Parameters:

newExternalResponseMatrix - ResponseMatrix

setUseExternalResponseMatrix

public void setUseExternalResponseMatrix(boolean newUseExternalResponseMatrix)

Setter for the field useExternalResponseMatrix.

Parameters:

newUseExternalResponseMatrix - boolean