&modulate_elements STRING name = NULL; STRING item = NULL; STRING type = NULL; long start_pass = 0; long end_pass = LONG_MAX; double start_value = 0; double end_value = 0; long differential = 1; long multiplicative = 0; long start_occurence = 0; long end_occurence = 0; double exponent = 1; double s_start = -1; double s_end = -1; STRING before = NULL; STRING after = NULL; long verbose = 0; &end
N.B.: This command will produce unpredictable results when used with
load_parameters (except when
It should work properly with
link_elements in turn-by-turn mode
when the source element is ramped, but not when the target element
name-- A possibly-wildcard-containing string giving the names of the elements to modulate. If not specified, then one must specify
item-- The name of the parameter to modulate.
type-- A possibly-wildcard-containing string giving the names of element types to modulate. May be specified with
nameor by itself.
end_pass-- The starting and ending pass, and for the ramp. For passes less than
start_pass, the ramp value is
start_value. For passes greater than
end_pass, the ramp value is
end_value-- The end-point values (start) and (end) of the ramp.
exponent-- The exponent for the variation of values between the start and end of the ramp. The ramp function is
multiplicative-- Determine how the amplitude function is used to obtain the new value of the parameter. There are four cases
end_occurence-- If nonzero, these give the starting and ending occurrence numbers of elements that will be modulated. N.B.: if wildcards are used, occurrence number counting is for each set of identically-named elements separately, rather than for the sequence of matched elements.
s_end-- If non-negative, these give the gaving and ending position limits for the end-of-element locations of elements to be modulated.
after-- The name of an element. If given, the modulation is applied only to elements that follow the named element in the beamline.
before-- The name of an element. If given, the modulation is applied only to elements that precede the named element in the beamline.
verbose-- If nonzero, information is printed to the standard output as changes are made. Use for debugging only, since otherwise it may slow the simulation.