7.26 floor_coordinates
- type: action command.
- function: compute floor coordinates for an accelerator.
- sequence: must follow run_setup.
- Command syntax, including use of equations and subcommands, is discussed in 7.2.
&floor_coordinates
STRING filename = NULL;
double X0 = 0.0;
double Z0 = 0.0;
double theta0 = 0.0;
long include_vertices = 0;
long vertices_only = 0;
long magnet_centers = 0;
long store_vertices = 0;
&end
- filename — The (incomplete) name of an SDDS file to send output to. Recommended value:
“%s.flr”.
- X0, Z0, theta0 — Initial X, Z, and angle coordinate of the beamline.
- include_vertices — Flag that, if set, specifies including in the output the coordinates of
the vertices of bending magnets.
- vertices_only — Flag that, if set, specifies that output will contain only the coordinates of
the vertices of bending magnets.
- magnet_centers — Flag that, if set, specifies that output will contain the coordinates of the
centers of all magnets, where the center is defined as the average of the entrance and exit
points. By default, the coordinates of the downstream end are given.
- store_vertices — Flag that, if set, results in storing the floor coordinates for dipole
magnet vertex points. The coordinates are stored in variables with names of the form
magnetName#occurrenceNumber-VP.property, where property is X, Y, Z, theta, phi, and psi.
The “vertex point” for a dipole or string of dipoles is defined as the intersection of the straight lines
from the ideal entrance and exit trajectories. The s quantity for the vertex is defined as the sum of the
actual distance traveled to the start of the dipole or string of dipoles plus the straight-line distance from
the entrace to the vertex. Hence, one cannot subtract the s values for two successive vertices and expect
to get the distance between the vertices.