8.17 sddsfluxcurve

• description: sddsfluxcurve computes undulator fluxcurve curves using Twiss parameter data from elegant or sddsanalyzebeam. Several calculation methods are available.
• examples:

  sddsfluxcurve run.twi run.bri -harmonics=3  -electronBeam=current=0.1,coupling=0.01  -undulator=period=0.033,numberOfPeriods=70,kmin=0.01,kmax=2.7,points=100  -pinhole=distance=30,xsize=0.0025,ysize=0.001

• synopsis:

  sddsfluxcurve [-pipe=[input][,output]] [twissFile] [SDDSoutputfile] [-harmonics=integer] [-method=methodName[,neks=integer]] [-mode=pinhole|density|total] -undulator=period=meters,numberOfPeriods=integer,kmin=value,kmax=value[,points=number] [-electronBeam=current=amps,[,coupling=value | emittanceRatio=value]] [-pinhole=distance=meters,xsize=meters,ysize=meters [,xnumber=integer][,ynumber=integer][,xposition=meters][,yposition=meters]] [-nowarnings]

• files:
  • twissFile — 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.
  • SDDSoutputFile — Contains the flux data in column form. For each requested harmonic i, there are columns photonEnergyi and wavelengthi, plus a column for the flux (TotalFluxi, PinholeFluxi, or FluxDensityi).
• switches:
  • pipe — The standard SDDS Toolkit pipe option.
  • harmonics — The number of harmonics to compute.
  • -method=string,neks=value] — Choose which method to use for calculations. Options are
    • dejus — R. Dejus’ non-zero emittance, infinite-N+convolution method. This is the default.
    • walkerinfinite — R. Walker’s method. Dejus’ method is derived from this method.

    neks is used to change the number of points used for finding the peak of the distribution.

• mode=pinhole|density|total — Specify whether to compute the flux through a pinhole, the flux density, or the total flux.
• -undulator=period=meters,numberOfPeriods=integer,kmin=value,kmax=value[,points=number] — Specify undulator parameters. points is the number of K values to use on the interval [K_min,K_max].
• electronBeam=current=amps,[,coupling=value | emittanceRatio=value] — Specify parameters of the electron beam. The current defaults to 0.1 A. Either the coupling or emittance ratio must be given, unless the input file contains the parameter ey0 or the column ey.
• -pinhole=distance=meters,xsize=meters,ysize=meters[,xnumber=integer]
  [,ynumber=integer][,xposition=meters][,yposition=meters] — Specify the parameters of the pinhole. Required for -mode=pinhole. By default xnumber=20, ynumber=20, xposition=0, and yposition=0.
• authors: M. Borland, H. Shang, R. Dejus (ANL).