Bump[str,options]
str is defined as str=Steer[...]
options: default
Range Null specifies the range of the bump
Center Null sepcifies the center position where
the bump is placed.
Plane Automatic The plane of the bump "H" or "V" or "HV".
Condition Null Orbit conditions. The following forms
are allowed
{"QF","X",1e-3} or
{{"QF","X",1e-3},{"QF","PX",0},...}
NumberOfSteers 6 Number of steers used for the bump.
CorrectOrbitBump[v,f,bpm,str,optics,options]
arguments are the same as those of CorrectOrbit except for f,
which specifies bump variables. The function returns a list of
steer strength and determined bump-variables. The resultant
steer strength is set to K0 slot in the LINE.
f bump variables. The following forms are allowed
f1=Bump[str,Center->..,...,Condition->{"QF","X",#}]&
f2=Bump[str,Center->..,...,Condition->{{"QF","X",#1},
{"QF","PX",#2}}]&
or f3=Function[x,
Bump[str,Center->..,...,Condition->{"QF","X",x}]
or f4[x_]=Bump[str,Center->..,...,Condition->{"QF","X",x}]
or g={f1,f2,f3,f4}
MakeBump[b,str,optics,options]
make a orbit bump. The function returns a list of steering
strength and index of used steers. The resultant
steer strength is set to K0 slot in the LINE.
b a bump specified as
b=Bump[str,Center->...,...]
1. Orbit correction
CorrectOrbit make an orbit correction.
Usage:
CorrectOrbit[orbit-kind,monitor,steer,optics,options]
orbit-kind : a character string or a list of character strings which
represent kind of orbit to be corrected, for example,
"X", "EY", {"X","Y"}, {"Y","EY"}, etc. "X" represents
horizontal orbit and "EY" the vertical dispersion.
monitor_List : a list of monitor element which is defined by the
function Monitor.
steer_List : a list of steering element which is defined by the
function Steer.
optics_List : a list of optics parameters which is defined by the function
CalucalateOptics.
options : optional parameters in the form of opt->parameters;
________________________________________________________________________
option default descriptions
------------------------------------------------------------------------
SetSteer True Set steer values.
Solver "LeastSquare" Type of solver routine. For MICADO method
Solver->{"Micado",n} . n is number
of correctors.
TotalKick {Null,Null} Specifies a constraint to the steering strength.
TotalKick->{ax,ay} means that the sum of the
kick angle should be ax and ay for horizontal
and vertical steers, respectively.
ZeroSum False ZeroSum->True is equivalent to TotalKick->{0,0}
TotalDZ Null Constraint that circumference should be changed
by amount of dz, if TotalDZ->dz after
correction.
DN {Null,Null} Constraint that the tune should be changed
by amount of {dnx,dny}, if DN->{dnx,dny} after
correction.
Tune {0,0} A list of tune {nu-x,nu-y}. If tune is zero,
the tune from input optics is used in the
caculation of the response matrix.
Orbit {} A list of orbit values that is to be minimized.
Calc True Calulate a resultant optics and set it in the
Twiss buffer.
Epsilon 1e-8 Epsilon value for the LinearSolve. EPS can be
used instead of Epsilon.
Condition {{},{}} A list {c,d}, where c is a matrix and d is
a vector representing a condition equations
that the solution should obeys:
c.x==d .
More convenient form of Condition option is
available:
Condition->{{"ZX.1","ZX.2","ZX.3"},{1,-2,1},0}}
, for example. This is equivalent to a
condition
ZX.1 -2*ZX.3 +ZX.3 == 0 .
Weight Automatic A list of weights to the monitors. If Automatic
Sqrt of beta-function at the monitors is
applied.
ExpectedOrbit False Leave an expected orbit in the Twiss buffer
after the corretion. (ExpectedOrbit->True)
overrides the (Calc->True). This option is
convenient for OPERATE mode.
------------------------------------------------------------------------
Result: (1) Returns a list of kick angle
(2) Resultant steer strength is set to "K0" slot in the LINE
if SetSteer->True (default).
(3) Calculate optics if Calc->True and ExpectedOrbit->False and
OPERATE flag is false.
(4) Leave an estimated orbit in the Twiss buffer if
ExpectedOrbit->True.
2. Orbit manupilation with bump
Bump generates a "Bump" object.
Usage:
b=Bump[str,options]
str a list of steering element which is defined by the
function Steer.
____________________________________________________________________
option default descriptions
--------------------------------------------------------------------
Range Null Specifies the range of the bump
Center Null Sepcifies the center position where
the bump is placed.
Plane Automatic The plane of the bump. "H" or "V" or "HV".
Condition Null Orbit conditions. The following forms
are allowed
{"QF","X",1e-3} or
{{"QF","X",1e-3},{"QF","PX",0},...}
The first one means that x should be 1mm at "QF",
and the second that x should be 1mm and px is
0mrad at "QF".
NumberOfSteers 6 Number of steers used for the bump.
Result: (1) b is defined as a "Bump" object.
MakeBump make an orbit bump.
Usage:
MakeBump[b,str,optics,options]
The function returns a list of steering
strength and index of used steers. The resultant
steer strength is set to K0 slot in the LINE.
b a bump object defined as
b=Bump[str,Center->...,...]
str a list of steering element which is defined by the
function Steer.
optics a list of optics parameters which is defined by the function
CalucalateOptics.
options optional parameters in the form of opt->parameters;
____________________________________________________________________
option default descriptions
--------------------------------------------------------------------
SetSteer True Set steer values.
Calc True Calulate a resultant optics and set it in
the Twiss buffer.
--------------------------------------------------------------------
Result: (1) Returns a list of kick angles and indices of used steers.
(2) Resultant steer strength is set to "K0" slot in the LINE
if SetSteer->True(default).
(3) Calculate optics if Calc->True and OPERATE flag is false.
CorrectOrbitBump make an orbit correction using orbit-bumps as
correctors (knobs).
Usage:
CorrectOrbitBump[v,f,bpm,str,optics,options]
Arguments are the same as those of CorrectOrbit except for f,
which specifies bump variables. The function returns a list of
steer strength and determined bump-variables. The resultant
steer strength is set to "K0" slot in the LINE. SetSteer option
is not accepted.
v a character string or a list of character strings that represent
kind of orbit to be corrected, for example,
"X", "EY", {"X","Y"}, {"Y","EY"}, etc.
f bump variables. The following forms are accepted
f1=Bump[str,Center->..,...,Condition->{"QF","X",#}]&
f2=Bump[str,Center->..,...,Condition->{{"QF","X",#1},
{"QF","PX",#2}}]&
or f3=Function[x,
Bump[str,Center->..,...,Condition->{"QF","X",x}]
or f4[x_]=Bump[str,Center->..,...,Condition->{"QF","X",x}]
or f={f1,f2,f3,f4}
bpm a list of monitor element which is defined by the
function Monitor.
str a list of steering element which is defined by the
function Steer.
optics a list of optics parameters which is defined by the function
CalucalateOptics.
options optional parameters in the form of opt->parameters,see
explanations of CorrectOrbit
Result: (1) Returns a list of kick angles and bump variable.
(2) Resultant steer strength is set to "K0" slot in the LINE.
(3) Calculate optics if Calc->True and ExpectedOrbit->False and
OPERATE flag is false.
(4) Leave an estimated orbit in the Twiss buffer if
ExpectedOrbit->True.