7.1 sddssyncflux

• description: sddssyncflux calculates synchrotron radiation photon flux of bend, wiggler, and undulator magnets. The calculation for undulators has not been implemented yet.
• examples:
  sddssyncflux bend.test -source=bend -mode=energy,linear,start=1,end=3,step=0.1  
  sddssyncflux wiggler.test -source=wiggler,period=5,numberOfPeriods=7,field=1 -mode=energy,linear,start=100,end=200,step=2  
      

• synopsis:
  sddssyncflux <outputFile> -verbose [-pipe]  
    [-fileValues=<filename>[,energy=<columnName or wavelength=columnName>]]  
    [-mode=energy(wavelength),linear(logarithmic),start=<value>,end=<value>,step(factor)=<value>]  
    [-source=bendMagnet[,field=xx[,radius=yy][,criticalEnergy=zz]]  
    [-source=wiggler(undulator),period=xx[,field=yy][,K=zz],numberOfPeriods=<n>]  
    [-eBeamEnergy=<value> [-eBeamCurrent=<value>] [-eBeamGamma=<value>]]  
      

• files: outputFile the results are written to an SDDS file.
• switches:
  • -pipe — output result to the pipe.
  • -fileValues=<filename>[,energy=<columnName or wavelength=columnName>] — get the energy or wavelength from filename instead of by -mode option.
  • -mode=energy,linear,start=<value>,end=<value>,step=<value> — Generate photon energy column in eV linearly, from start to end in steps.
  • -mode=energy,logarithmic,start=<value>,end=<value>,factor=<value> — Generate photon energy column logarithmically, from start to end by multiplying factor from point to point.
  • -mode=wavelength,linear,start=<value>,end=<value>,step=<value> — Generate photon wavelength column in nm linearly, from start to end in steps.
  • -mode=wavelength,logarithmic,start=<value>,end=<value>,factor=<value> — Generate photon wavelength column in nm logarithmically, from start to end by multiplying factor from point to point.
  • -source=bendMagnet[,field=xx][,radius=yy][,criticalEnergy=zz] — Bend magnet source, magnetic field xx Tesla (default 0.6 Tesla), bend radius yy meters, critical energy zz eV. Only one of field, radius and critical energy is needed.
  • -source=wiggler,period=xx[,field=yy][,K=zz],numberOfPeriods=n — Wiggler source, period xx cm (default 5 cm), peak magnetic field yy Tesla (default 1 Tesla), undulator parameter K=zz (no default). Only two of period, field and K are needed. numberOfPeriods must be provided.
  • -source=undulator,period=xx[,field=yy][,K=zz],numberOfPeriods=n — Undulator source, period xx cm (default 5 cm), peak magnetic field yy Tesla (default 1 Tesla), undulator parameter K=zz (no default). Only two of period, field and K are needed. numberOfPeriods must be provided. Note that only one source is accepted at one time.
  • -eBeamEnergy=<value> — Electron beam energy in GeV, default 7 GeV.
  • -eBeamGamma=<value> — Electron beam gamma.
  • -eBeamCurrent=<value> — Electron beam current in A.
  • -g1ValueFile=<filename> — Give the file that contains the values of y and yGy, where yGy is y multiplied by the integral of the Bessel function K5/3 from y to infinity.
• see also:
  • sddsplot()
• author: H. Shang ANL/APS.