----- file created by makedoc on: Fri May 31 15:22:22 2013
----- Documentation for /scisoft/xop2.3/extensions/shadowvui/src/lib/ray_prop.pro -----

 NAME:
	RAY_PROP 
 PURPOSE:
	plot the evolution of an image (cols 1,3) in vacuum along the beamline
 CATEGORY:
	SHADOW's utilities.
 CALLING SEQUENCE:
	ray_prop,shadow_in,keyword_parameters
 INPUTS:
	shadow_in   IDL structure with SHADOW data
 OPTIONAL INPUTS:
	col1 [default=1] The column to be placed in the Horizontal axis.
	col2 [default=2] The column to be placed in the Verical axis.
 KEYWORD PARAMETERS:
	RANGE  = [min,max]  limits of Y axis (col 2) to where retrace the image 
	ITERS  = number of iterations (default=20)
	XRANGE = [min,max], limits of the x scale. 
	YRANGE = [min,max], heigth limits of the y scale. 
	NOLOST = consider losses
		0 all rays (default option)
		1 exclude losses 
		2 only losses 
       TITLE = top title
       XTITLE = title in X column
       YTITLE = title in Y column
	PRINT  = if set to 1, set to screen all the images. This
		option is suitable for generating the PS file.
	CART = if set, force cartesian axes (same H and V aspect ratio)
	WAIT = time between frames (default=0)
	XPLOT = set this keyword to launch an xplot window with the 
		statistical parameters (mean sizes and st dev) versus
		beam position.
       GROUP The parent id for the caller widget (used to positioning
               error and information windows).
	EVOL Set this keyword to a named variable to receive a multicolum 
		array with: 
		Col1: dist [cm]
		Col2: Mean X
		Col3: Mean Y
		Col4: St Dev X
		Col5: St Dev Y
		Col6: weighted Mean X
		Col7: weighted Mean Y
		Col8: weighted StDev X
		Col9: weighted StDev Y
	NOPLOT Set this keyw avoid showing the animation (useful when 
		one is only interested in statistical values). 
	MPEG_CREATE Set this keyw to create a mpeg movie file ray_prop.mpg
       NBINS: set this keyword to the number of bins to be used in the
              calculations of the histogram FWHM. (Default: NBINS=0,
              i.e., no histogram calculation)
              Note that the results of these calculations are not
              plotted, but stored and displayed using the XPLOT=1 option
	
 OUTPUTS:
	the interactive view of the beam evolution
 OPTIONAL OUTPUT PARAMETERS:
 COMMON BLOCKS:
 SIDE EFFECTS:
 	None.
 RESTRICTIONS:
	None.
 PROCEDURE:
	Similar to SHADOW's RETRACE
 MODOFICATION HISTORY:
	Original from Steve Turner
       92/10/13 MSR lots of modifications
	98/04/30 srio@esrf.fr Almost rewritten. Adapted for SHADOWVUI.
	07/10/03 srio@esrf.eu added XPLOT keyword
	2010/01/29 srio@esrf.eu added histogram FWHM calculations (NBINS)


