an integer in the range [-len(ring), len(ring)-1]
selecting the element according to python indexing rules.
As a special case, len(ring) is allowed and refers to the end
of the last element,
an ordered list of such integers without duplicates,
a numpy array of booleans of maximum length len(ring)+1,
where selected elements are True.
an integer in the range [-len(ring), len(ring)-1]
selecting the element according to python indexing rules.
As a special case, len(ring) is allowed and refers to the end
of the last element,
an ordered list of such integers without duplicates,
a numpy array of booleans of maximum length len(ring)+1,
where selected elements are True.
an integer in the range [-len(ring), len(ring)-1]
selecting the element according to python indexing rules.
As a special case, len(ring) is allowed and refers to the end
of the last element,
an ordered list of such integers without duplicates,
a numpy array of booleans of maximum length len(ring)+1,
where selected elements are True.
df (float) – Deviation of RF frequency. Defaults to
None
orbit (Orbit) – Avoids looking for the closed orbit if it is
already known ((6,) array)
get_chrom (bool) – Compute chromaticities. Needs computing
the tune at 2 different momentum deviations around the central one.
get_w (bool) – Computes chromatic amplitude functions
(W, WP) [4], and derivatives of the dispersion and twiss parameters
versus dp. Needs to compute the optics at 2 different momentum
deviations around the central one.
keep_lattice (bool) – Assume no lattice change since the
previous tracking. Defaults to False
Initial conditions for transfer line optics.
Record array as output by linopt6(), or dictionary. Keys:
R or alpha, beta
mandatory (2,) arrays
closed_orbit
Optional (6,) array, default 0
dispersion
Optional (6,) array, default 0
If present, the attribute R will be used, otherwise the
attributes alpha and beta will be used. All other attributes
are ignored.
Returns:
elemdata0 – Linear optics data at the entrance of the ring
ringdata – Lattice properties
elemdata – Linear optics at the points referred to by refpts,
if refpts is None an empty lindata structure is returned.
elemdata is a record array with fields:
s_pos
longitudinal position [m]
M
(4, 4) transfer matrix M from the beginning of ring
to the entrance of the element [2]
closed_orbit
(6,) closed orbit vector
dispersion
(4,) dispersion vector
beta
\(\left[ \beta_x,\beta_y \right]\) vector
alpha
\(\left[ \alpha_x,\alpha_y \right]\) vector
mu
\(\left[ \mu_x,\mu_y \right]\), betatron phase
Warning: if the sampling (number of refpts) is too
sparse, i.e. if the phase advance is more than 2*pi
between 2 points the integer part will not increment
correclty
W
\(\left[ W_x,W_y \right]\) only if get_w
is True: chromatic amplitude function
Wp
\(\left[ Wp_x,Wp_y \right]\) only if get_w
is True: chromatic phase function
an integer in the range [-len(ring), len(ring)-1]
selecting the element according to python indexing rules.
As a special case, len(ring) is allowed and refers to the end
of the last element,
an ordered list of such integers without duplicates,
a numpy array of booleans of maximum length len(ring)+1,
where selected elements are True.
Initial conditions for transfer line optics.
Record array as output by linopt6(), or dictionary. Keys:
R or alpha, beta
mandatory (2,) arrays
closed_orbit
Optional (6,) array, default 0
dispersion
Optional (6,) array, default 0
If present, the attribute R will be used, otherwise the
attributes alpha and beta will be used. All other attributes
are ignored.
Returns:
elemdata0 – Linear optics data at the entrance of the ring
ringdata – Lattice properties
elemdata – Linear optics at the points refered to by refpts,
if refpts is None an empty lindata structure is returned.
elemdata is a record array with fields:
s_pos
longitudinal position [m]
M
(4, 4) transfer matrix M from the beginning of ring
to the entrance of the element [6]
closed_orbit
(6,) closed orbit vector
dispersion
(4,) dispersion vector
beta
\(\left[ \beta_x,\beta_y \right]\) vector
alpha
\(\left[ \alpha_x,\alpha_y \right]\) vector
mu
\(\left[ \mu_x,\mu_y \right]\), betatron phase
Warning: if the sampling (number of refpts) is too
sparse, i.e. if the phase advance is more than 2*pi
between 2 points the integer part will not increment
correclty
gamma
gamma parameter of the transformation to
eigenmodes [7]
W
\(\left[ W_x,W_y \right]\) only if get_w
is True: chromatic amplitude function
Wp
\(\left[ Wp_x,Wp_y \right]\) only if get_w
is True: chromatic phase function
an integer in the range [-len(ring), len(ring)-1]
selecting the element according to python indexing rules.
As a special case, len(ring) is allowed and refers to the end
of the last element,
an ordered list of such integers without duplicates,
a numpy array of booleans of maximum length len(ring)+1,
where selected elements are True.
Initial conditions for transfer line optics.
Record array as output by linopt6(), or dictionary. Keys:
R or alpha, beta
mandatory (2,) arrays
closed_orbit
Optional (6,) array, default 0
dispersion
Optional (6,) array, default 0
If present, the attribute R will be used, otherwise the
attributes alpha and beta will be used. All other attributes
are ignored.
cavpts (Refpts) – Cavity location for off-momentum tuning
Returns:
elemdata0 – Linear optics data at the entrance of the ring
ringdata – Lattice properties
elemdata – Linear optics at the points refered to by refpts,
if refpts is None an empty lindata structure is returned.
elemdata is a record array with fields:
s_pos
longitudinal position [m]
M
(6, 6) transfer matrix M from the beginning of ring
to the entrance of the element
closed_orbit
(6,) closed orbit vector
dispersion
(4,) dispersion vector
A
(6,6) A-matrix
R
(3, 6, 6) R-matrices
beta
\(\left[ \beta_x,\beta_y \right]\) vector
alpha
\(\left[ \alpha_x,\alpha_y \right]\) vector
mu
\(\left[ \mu_x,\mu_y \right]\), betatron phase
Warning: if the sampling (number of refpts) is too
sparse, i.e. if the phase advance is more than 2*pi
between 2 points the integer part will not increment
correclty
W
\(\left[ W_x,W_y \right]\) only if get_w
is True: chromatic amplitude function
Wp
\(\left[ Wp_x,Wp_y \right]\) only if get_w
is True: chromatic phase function