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


==============================  XSh_PlotXY   ==================================

 XSh_Plotxy is a widget based graphical interface for the PlotXY
 IDL implementation of the SHADOW plotxy tool.

 DESCRIPTION OF THE CONTROLS IN THE MAIN WINDOW:

  Menu bar
  ========
  File:
    XSh_Plotxy input parameters: This option allows to save the current
		parameters to a file for later loading. It also allows
		to save the current parameters as defaults for being
		used when the application is initialized. In the last
		case, the file is named "application".xop (where 
		"application " is the name of the current XOP
		application) and is written in the directory pointed
		by the XOP_DEFAULTS_DIR environment variable (which
		must be set). The parameter file is ASCII and can be
		read and edited with care.
  Quit: to exit from the program

  Help:   Shows the XSh_PlotXY help (this text) and PlotXY help.

  Other controls
  ==============
  
  "Quit" button: quite sthe program
  "Show contols": starts an application allowing to change interactively 
	the parameters. 
  "Refresh" refresh the screen by exucuting the command written at the 
	bottom (which may be different to the parameters input with
	"Show controls").
  "Refresh in a new window" creates a new clone window and executes
	PlotXY with parameters defined in the "Show controls". This
	option is useful when tracing running SHADOW as a second time
	with some changed parameters and wanted to compare with the 
	previous run without destoying the previous PlotXY graph.
  The bottom editable line can be used to enter by hand any PlotXY
	command. Enter <return> for updating the graph. Note that 
	entering a command here does not update the parameters available
	under the "Show controls" button. Also, by using this button, 
	the previous existing command is overwritten.
	
  
  For zooming (in fact, changing abscissas and ordinates range) select 
       a region of interest in the main plotting area.
  For zooming out, doublr click on the plot.
  


 COPYRIGHT:
	XSH_Plotxy  belongs to SHADOWVUI package and it is distributed 
	as an XOP extension.

	PLEASE REFER TO THE XOP COPYRIGHT NOTICE. 

       XOP WEB SITE:
       http://www.esrf.eu/UsersAndScience/Experiments/TBS/SciSoft/xop2.3/

 CREDITS:
	Published calculations made with SHADOW should refer:

	 C. Welnak, G.J. Chen and F. Cerrina, 
        "SHADOW: a synchrotron radiation X-ray Optics simulation tool",
	 Nucl. Instr. and Meth. in Phys. Res. A347 91994) 344
  
        http://dx.doi.org/ 10.1016/0168-9002(94)91906-2  

	or

	 SHADOW WEB Page: http://www.nanotech.wisc.edu/shadow/


	Published calculations made with SHADOWVUI/XOP should refer:

	  M. Sanchez del Rio and R. J. Dejus 
         "Status of XOP: an x-ray optics software toolkit"
         SPIE Proceedings Vol. 5536 (2004) pp.171-174

         http://dx.doi.org/10.1117/12.560903


 MODIFICATIONS: 

	Author: M. Sanchez del Rio (srio@esrf.fr) , ESRF
	00/07/10 srio@esrf.fr version 1.1 for xop 2.0. Documented.
	08/04/28 srio@esrf.eu documented the non-interactive call. 
                Changed inputs. Updated doc. 
	08/09/09 srio@esrf.eu added zoom. V 1.3


========================================================================


 
 
  NON INTERACTIVE CALL OF XSH_PLOTXY: 


  PRO xsh_plotxy, <plotxy_keyword>, $
    input, $                  ; undefined, structure, file name, pointer
    col1, $                   ; shadow column for plot (horizontal)
    col2, $                   ; shadow column for plot (vertical)
    <plotxy_kw>, $            : list of keywords accepted by plotxy
    NOEXECUTE = noexecute, $  ; create windows, but do not execute plotxy
    GROUP=group               ; id of the window parent


