----- header of sync_ene.pro extracted on: Wed Jun  3 10:12:53 2009
----- Documentation for /scisoft/xop2.3/src_idl/sources/sync_ene.pro -----

 NAME:
       SYNC_ENE

 PURPOSE:
       Calculates the synchrotron radiation energy spectrum

 CATEGORY:
       Mathematics.

 CALLING SEQUENCE:
       Result = sync_ene(flag, Energy )

 INPUTS:
	flag: 	0 Flux fully integrated in angle (Psi)
		1 Flux at Psi=0
		2 Flux integrated in the angular interval [Psi_Min,Psi_Max]
		3 Flux at Psi=Psi_Min

       energy:  the energy array [in eV]

 KEYWORD PARAMETERS:
	POLARIZATION: 0 Total 
		      1 Parallel       (l2=1, l3=0, in Sokolov&Ternov notation)
		      2 Perpendicular  (l2=0, l3=1)

	If FLAG=0 or FLAG=1 the following keywords MUST BE ENTERED

		EC_eV= The critical energy [eV]
		E_GeV= The electron energy [in GeV] 
		I_A= the electron beam intensity [in A]
		HDiv_mrad= the horizontal divergence [in mrad]

	If FLAG=2, in addition to the mentioned keywords, the following 
		ones must be present:

		Psi_Min the minimum integration angle [in mrad]
		Psi_Max the maximum integration angle [in mrad]
		Psi_NPoints the number of points in psi for integration

	If FLAG=3, in addition to the mentioned keywords for FLAG=0 OR 
		FLAG=1, the following kewford must be defined: 

		Psi_Min the Psi angular value [in mrad]

 KEYWORD PARAMETERS (OUTPUT):

	IF FLAG=2, the following keywords can be used to obtain additional info:

		FMATRIX=A two dimensional variable containing the matrix of 
			flux as a function of angle [first index] and energy 
			[second index]
		ANGLE_MRAD= A one-dim array with the angular points [in mrad]

 OUTPUTS:
       returns the array with the flux [photons/sec/0.1%bw] for FLAG=0,2
       and the flux [photons/sec/0.1%bw/mrad] for FLAG=1,3

 PROCEDURE:

	References: 
		G K Green, "Spectra and optics of synchrotron radiation" 
			BNL 50522 report (1976)
		A A Sokolov and I M Ternov, Synchrotron Radiation, 
			Akademik-Verlag, Berlin, 1968

 EXAMPLE:
	The following program was used for testing sync_ene
	
	
	e=makearray1(10,20000.0,30000.0) ; create 10-points energy array in [20,30] keV
	
	;
	; test of spectra at Psi=0
	;
	; at psi=0 (i.e., FLAG=1)
	y1=sync_ene(1,e,ec_ev=19166.0,e_gev=6,i_a=0.1,hdiv=1)
	; at psi_min (FLAG=3)
	y2=sync_ene(3,e,ec_ev=19166.0,e_gev=6,i_a=0.1,hdiv=1,psi_min=0.0)
	
	plot,e,y1
	oplot,e,y2,Psym=2
	
	
	;
	; test of integrated spectra 
	;
	
	; Integrating (by hand) using FLAG=3
	y3 = y1*0.0D0
	a = makearray1(50,-0.2,0.2)  ; it is large enough to cover the full radiation fan
	
	FOR i=0,N_Elements(a)-1 DO BEGIN
	  y2=sync_ene(3,e,ec_ev=19166.0,e_gev=6,i_a=0.1,hdiv=1,psi_min=a[i])
	  y3 = y3 + y2
	  ;plot,e,y2,title='Psi='+StrCompress(a[i])
	  ;wait,0.1
	ENDFOR
	y3=y3*(a[1]-a[0])
	
	; Integrating (automatically) using FLAG=2
	y4 = sync_ene(2,e,ec_ev=19166.0,e_gev=6,i_a=0.1,hdiv=1,psi_min=-0.2,psi_max=0.2,psi_npoints=50)
	
	; Integrated (over all angles) using FLAG=0
	y5 = sync_ene(0,e,ec_ev=19166.0,e_gev=6,i_a=0.1,hdiv=1)
	
	pause
	plot,e,y4
	pause
	oplot,e,y4,psym=2
	pause
	oplot,e,y5,psym=4
	
	print,'   energy    int_by_hand     int_num    int'
	FOR i=0,N_Elements(e)-1 DO BEGIN
	  print,e[i],y3[i],y4[i],y5[i]
	ENDFOR
	
	end

	The results obtained are: 
		  energy    int_by_hand     int_num       int
	       20000.000   9.3255428e+12   9.3255428e+12   9.3319989e+12
	       21111.111   8.9528668e+12   8.9528668e+12   8.9590648e+12
	       22222.222   8.5885671e+12   8.5885671e+12   8.5945128e+12
	       23333.333   8.2334350e+12   8.2334350e+12   8.2391347e+12
	       24444.444   7.8880553e+12   7.8880553e+12   7.8935159e+12
	       25555.556   7.5528452e+12   7.5528452e+12   7.5580737e+12
	       26666.667   7.2280844e+12   7.2280844e+12   7.2330880e+12
	       27777.778   6.9139400e+12   6.9139400e+12   6.9187260e+12
	       28888.889   6.6104867e+12   6.6104867e+12   6.6150626e+12
	       30000.000   6.3177237e+12   6.3177237e+12   6.3220968e+12


	EXAMPLE 2
		Surface plot of flux versus angle ane energy
		e = makeArray1(20,20000,30000)
		tmp = sync_ene(2,e,ec_ev=19166.0,e_gev=6,i_a=0.1,hdiv=1,$
			psi_min=-0.2,psi_max=0.2,psi_npoints=50,fm=fm,an=a)
		surface,fm,a,e, ztitle='Flux[phot/sec/0.1%bw/mradPsi', $
			xtitle='Angle [mrad]',ytitle='Energy [eV]'
 MODIFICATION HISTORY:
       Written by:     M. Sanchez del Rio, srio@esrf.fr, 2002-06-03
	2007-05-14 srio@esrf.fr debug with FLAG=2. The bandwith in 
		angle depends on the number of points. Now it is 1mrad
		Bug reported by flori@n-nolz.de
		Added default values. 
       2007-12-13  srio@esrf.eu fixes bug reported by Gernot.Buth@iss.fzk.de
               concerning the normalization of the angular integral.



