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

Class DefaultOrbitCorrectionModel

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

All Implemented Interfaces:

IOrbitCorrectionModel, ISVDOrbitCorrectionModel, IConfigurable, IOrientationMarker

public class DefaultOrbitCorrectionModel
extends AbstractSVDOrbitCorrectionModel

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

Method Summary

Modifier and Type	Method	Description
Correction	calculateCorrection(OrbitCorrectionOperator engine)	calculateCorrection.

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

getBeamAverage, getOffset, isMakeShift, isModelCalculatesOffset, makeCorrection, 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, 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

DefaultOrbitCorrectionModel

public DefaultOrbitCorrectionModel()

RingKeeper constructor comment.

Method Details

calculateCorrection

public Correction calculateCorrection(OrbitCorrectionOperator engine)
                               throws InconsistentDataException

calculateCorrection.

Parameters:

engine - a OrbitCorrectionOperator object

Returns:

double[]

Throws:

InconsistentDataException - if any.