11.21 sddsurgent

• description: sddsurgent uses algorithms from the program US (by R. Dejus) and URGENT (by R. Walker) for computation of undulator radiation properties, including power density and intensity distributions.
• examples: Take particle data from a tracking run and compute the power density using a 1 mm by 1 mm pinhole for a 72-period, 3.3-cm-period undulator set for a 5 keV first harmonic.

  sddsanalyzebeam run.out -pipe=out -correctedOnly
  | sddsurgent -pipe=in power.sdds -electronbeam=current=0.025
  -calc=method=dejus,mode=powerDensity -us
  -pinhole=dist=30,xsize=1,ysize=1,xnum=100,ynum=100
  -undulator=period=0.033,number=72,energy=5e3

• synopsis:

  sddsurgent inputFile outputFile [-calculation=mode=modeString,method=methodString,harmonics=integer] [-undulator=period=meters,numberOfPeriods=integer, kx=value,ky=value,phase=value,energy=eV] [-electronBeam=current=Amp,energy=GeV,spread=fraction, xsigma=mm,ysigma=mm,xprime=mrad,yprime=mrad,nsigma=number] [-pinhole=distance=m,xposition=value,yposition=value, xsize=value,ysize=value,xnumber=integer,ynumber=integer] [-alpha=steps=integer,delta=value] [-omega=steps=integer,delta=value] [-nphi=integer] [-us] [-photonEnergy=maximum=eV,minimum=eV,points=number] [-nowarnings] [-coupling=value | -emittanceRatio=value]

• files:
  • inputFile — A Twiss output file from elegant, with radiation integral calculations included, or an output from sddsanalyzebeam. In the latter case, the -correctedOnly option should be used with sddsanalyzebeam.
  • outputFile — Contains the output data, which varies depending on the calculation mode. Use sddsquery to view the file contents.
• switches:
  • pipe — The standard SDDS Toolkit pipe option.
  • -calculation=mode=modeString,method=methodString,harmonics=integer — Choose which calculation to perform and what method to us, as well as the number of undulator harmonics to compute. Values for modeString are
    • 1 | fluxDistribution: Angular/spatial flux density distribution.
    • 2 | fluxSpectrum: Angular/spatial flux density spectrum
    • 3 | brightness | brilliance: On-axis brilliance spectrum
    • 4 | pinholeSpectrum: Flux spectrum through a pinhole
    • 5 | integratedSpectrum: Flux spectrum integrated over all angles
    • 6 | powerDensity: Power density and integrated power

    Values for methodString are

    • 1: Non-zero emittance; finite-N.
    • 2: Non-zero emittance; infinite-N.
    • 3 | WalkerFinite: Zero emittance; finite-N.
    • 4 | Dejus: Non-zero emittance; infinite-N + convolution (Dejus, with -us only).
    • 14 | WalkerInfinite: Non-zero emittance; infinite-N + convolution (Walker, with -tt us only).
  • -emittanceRatio=value | -coupling=value — In the case of a twiss output file from elegant, which does not contain the vertical emittance, one must supply one of these options. If -emittanceRatio=R is given, ϵ_y = ϵ₀ * R and ϵ_x = ϵ₀. If -coupling=k is given, ϵ_x = ϵ₀∕(1 + k) and ϵ_y = k * ϵ_x. ϵ₀ is the equilibrium emittance from the twiss output of elegant.

    In the case of twiss output from sddsanalyzebeam, both emittances are present and these options are ignored.

  • undulator=period=meters,numberOfPeriods=integer,
    kx=value,ky=value,phase=value,energy=eV] — Specify undulator parameters. If energy (of first-harmonic photons) is given, kx=0 and ky is computed, corresponding to a horizontally deflecting undulator. phase specifies the phase difference in degrees for a canted undulator.
  • -electronBeam=current=Amps,energy=GeV,spread=fraction,
    xsigma=mm,ysigma=mm,xprime=mrad,yprime=mrad,nsigma=number specifies electron beam parameters. Only the current is needed, as other data will be drawn from the input file.
    • current — electron beam current in A. (default is 0.1A).
    • energy — electron energy in Gev. (default is 7.0Gev).
    • spread — electron energy spread.
    • xsigma — horizontal RMS beam size (mm)
    • ysigma — vertical RMS beam size (mm)
    • xprime — horizontal RMS divergence (mrad)
    • yprime — vertical RMS divergence (mrad)
    • nsigma — no. of standard deviations of electron beam dimensions (size and divergence) to be included.
  • -pinhole=distance=m,xposition=value,yposition=value,
    xsize=value,ysize=value,xnumber=integer,ynumber=integer — Specifies pinhole parameters. Pinhole parameters are not needed for computing on-axis brilliance (i.e., mode=3).
    • distance — distance from the source (m) (distance=0.0 gives angular flux).
    • xposition — X-coordinate for center of pinhole (mm) or (mrad for distance=0)
    • yposition — Y-coordinate for center of pinhole (mm) or (mrad for distance=0)
    • xsize — X-size of pinhole (full width) (mm) or (mrad for distance=0)
    • ysize — y-size of pinhole (full width) (mm) or (mrad for distance=0)
    • xnumber — Number of subdivisions of pinhole in X (max 500)
    • ynumber — Number of subdivisions of pinhole in Y (max 500)
  • nphi=number — Specifies number of steps in phi between 0 and π∕2. Must be less than 100. used in (calculation mode=1,2,3,4,5 calculation method=1,2).
  • alpha=steps=integer,delta=value — Specifies the number of steps in angle alpha (gamma*theta) (<100). Delta specifies range of angles in alpha² to be used, in units of the angular equivalent to 1/N. Used in (mode=1, method=1) and method=3.
  • omegasteps=integer,delta=value — Specifies the number of steps in photon energy for the natural lineshape (<5000). delta specifies range of photon energies to be included in the natural lineshape in units (energy of fundamental/N). The default value covers the range ±2∕N of the natural lineshape. Used in mode=2,3,4,5 method=1.
  • photonEnergy=maximum=eV,minimum=eV,points=number — Specifies the maximum and minimum photon energy in eV, and the number of energy points to be computed.
• authors: H. Shang, R. Dejus, M. Borland, X. Jiao (ANL).