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

Class FrequencyOrbitCorrectionModel

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.FrequencyOrbitCorrectionModel

All Implemented Interfaces:

IOrbitCorrectionModel, ISVDOrbitCorrectionModel, IConfigurable, IOrientationMarker

public class FrequencyOrbitCorrectionModel
extends AbstractSVDOrbitCorrectionModel

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

Method Summary

Modifier and Type	Method	Description
ResponseMatrix	addColumnToResponseMatrix(ResponseMatrix responseMatrix, ElementList<AbstractCorrector> correctors, ElementList<BPMonitor> monitors, DataBush databush)	addColumnToResponseMatrix.
Correction	calculateCorrection(OrbitCorrectionOperator engine)	calculateCorrection.
double	calculateRFFrequencyCorrection(double correction, DataBush databush)	calculateRFFrequencyCorrection.
double	getBeamAverage()	Getter for the field beamAverage.
ResponseMatrix	getExternalResponseMatrix()	Getter for the field externalResponseMatrix.
double	getFrequencyCorrectionAmplification()	Getter for the field frequencyCorrectionAmplification.
double	getOffset()	Getter for the field offset.
boolean	isUseExternalResponseMatrix()	isUseExternalResponseMatrix.
protected 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	setExternalResponseMatrix(ResponseMatrix newExternalResponseMatrix)	Setter for the field externalResponseMatrix.
void	setFrequencyCorrectionAmplification(double newFrequencyCorrectionAmplification)	Setter for the field frequencyCorrectionAmplification.
void	setOffset(double newShiftConstant)	Setter for the field offset.
void	setUseExternalResponseMatrix(boolean newUseExternalResponseMatrix)	Setter for the field useExternalResponseMatrix.

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

isMakeShift, isModelCalculatesOffset, setMakeShift, setModelCalculatesOffset

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

addReduction, configure, getEigenvalues, getEigenvectorsUsed, getMinimalEigenvalue, getMinimalReductionEigenvalue, isReductionEnabled, 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

FrequencyOrbitCorrectionModel

public FrequencyOrbitCorrectionModel()

FrequencyOrbitCorrectionModel constructor comment.

Method Details

addColumnToResponseMatrix

public ResponseMatrix addColumnToResponseMatrix(ResponseMatrix responseMatrix,
 ElementList<AbstractCorrector> correctors,
 ElementList<BPMonitor> monitors,
 DataBush databush)

addColumnToResponseMatrix.

Parameters:

responseMatrix - ResponseMatrix

correctors - a ElementList object

monitors - a ElementList object

databush - a DataBush object

Returns:

ResponseMatrix

calculateRFFrequencyCorrection

public double calculateRFFrequencyCorrection(double correction,
 DataBush databush)

calculateRFFrequencyCorrection.

Parameters:

correction - a double

databush - a DataBush object

Returns:

a double

getBeamAverage

public double getBeamAverage()

Getter for the field beamAverage.

Getter for the field beamAverage.

Overrides:

getBeamAverage in class AbstractSVDOrbitCorrectionModel

Returns:

double

getExternalResponseMatrix

public ResponseMatrix getExternalResponseMatrix()

Getter for the field externalResponseMatrix.

Returns:

a ResponseMatrix object

getFrequencyCorrectionAmplification

public double getFrequencyCorrectionAmplification()

Getter for the field frequencyCorrectionAmplification.

Returns:

a double

getOffset

public double getOffset()

Getter for the field offset.

Getter for the field offset.

Overrides:

getOffset in class AbstractSVDOrbitCorrectionModel

Returns:

double

isUseExternalResponseMatrix

public boolean isUseExternalResponseMatrix()

isUseExternalResponseMatrix.

Returns:

a boolean

makeCorrection

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

op - a OrbitCorrectionOperator object

Returns:

a Correction object

Throws:

InconsistentDataException - if any.

makeSVDInversion

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

makeSVDInversion.

Overrides:

makeSVDInversion in class AbstractSVDBasedModel

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.

setExternalResponseMatrix

public void setExternalResponseMatrix(ResponseMatrix newExternalResponseMatrix)

Setter for the field externalResponseMatrix.

Parameters:

newExternalResponseMatrix - a ResponseMatrix object

setFrequencyCorrectionAmplification

public void setFrequencyCorrectionAmplification(double newFrequencyCorrectionAmplification)

Setter for the field frequencyCorrectionAmplification.

Parameters:

newFrequencyCorrectionAmplification - a double

setOffset

public void setOffset(double newShiftConstant)

Setter for the field offset.

Overrides:

setOffset in class AbstractSVDOrbitCorrectionModel

Parameters:

newShiftConstant - double

setUseExternalResponseMatrix

public void setUseExternalResponseMatrix(boolean newUseExternalResponseMatrix)

Setter for the field useExternalResponseMatrix.

Parameters:

newUseExternalResponseMatrix - a boolean

calculateCorrection

public Correction calculateCorrection(OrbitCorrectionOperator engine)
                               throws InconsistentDataException

calculateCorrection.

Parameters:

engine - a OrbitCorrectionOperator object

Returns:

double[]

Throws:

InconsistentDataException - if any.