5.5 The xasgraph library

Use the subject list in the previous page, or the quick alphabetic index here below to locate the routine of interest.

• annotate_new

  Library	xasgraph	Fortran code
  Calling sequence	CALL ANNOTATE_NEW(LUS,ANNOTATE,BUFFER,BUFFER2,NAME)
  Arguments	INTEGER	LUS(2)
  	CHARACTER	ANNOTATE ('N'|'S'|'L')
  	CHARACTER*(*)	BUFFER,BUFFER2
  	CHARACTER*(*)	NAME

  This high level routine uses the logical units LUS pointing to the communication channels of a plotting server established by y_openplot to set the viewport for standard annotations (which include the XAS filename NAME and other information derived from its header) and display the annotations.
  The annotation style (none, short or long) is controlled by the ANNOTATE flag (respectively ('N'|'S'|'L').
  The two strings BUFFER,BUFFER2 are used internally as work areas.

• annotate_old

  Library	xasgraph	Fortran code
  Calling sequence	CALL ANNOTATE_OLD(LUS,ANNOTATE,BUFFER,NAME)
  Arguments	see previous routine

  A variant of annotate_new

  ---

• check_overtrace

  Library	xasgraph	Fortran code
  Calling sequence	CHECK_OVERTRACE(CLEAR)
  Arguments	LOGICAL	CLEAR

  This routine, called at the beginning of a graphical client, tests the transient XAS environment variable overwrite, unsets it, and returns a logical flag CLEAR (.TRUE. if the current plot shall overtrace the preexisting one, .FALSE. otherwise).

  ---

• df_axes

  Library	xasgraph	Fortran code
  Calling sequence	CALL DF_AXES(LUS,XLINLOG,YLINLOG, XUNIT,YUNIT, XFORMAT,YFORMAT, BUFFER)
  Arguments	INTEGER	LUS(2)
  	CHARACTER*3	XLINLOG,YLINLOG ('LIN'|'LOG')
  	CHARACTER*(*)	XUNIT,YUNIT
  	CHARACTER*(*)	XFORMAT,YFORMAT
  	CHARACTER*(*)	BUFFER

  This routine plots an axis frame (using the logical units LUS pointing to the communication channels of a plotting server established by y_openplot) annotating them using the lb_* routines described below. The type of axis (linear or logarithmic) XLINLOG,YLINLOG and the format of the numeric labels XFORMAT,YFORMAT are passed to such routines.
  The caption of the X and Y axes are taken instead from an appropriate keyword header in a XAS table file : i.e. if one is plotting the 4-th vs the 3-rd column of a table, and therefore the X column is column 3 of the table containing energy in keV, one puts XUNIT='TUNIT3' where the TUNIT3 keyword contains 'keV'. BUFFER is a work area supplied by the caller and used to construct labels.

  ---

• df_pen_colours

  Library	xasgraph	Fortran code
  Calling sequence	CALL DF_PEN_COLOURS(LUS,CLEAR)
  Arguments	INTEGER	LUS(2)
  	LOGICAL	CLEAR

  This routine sets the foreground (and background, not yet implemented) colours for the plotting server connected by y_openplot) to the logical units LUS) according to a family of XAS environment variables which are read in common PENCOMMON ( axispen, bkgpen, datapen, CHARACTERANNOTATE ('N'|'S'|'L') textpen and by default any missing one to pen and by default if missing to 1).
  In addition if the CLEAR flag has been set by check_overtrace, it increments the overcount environment variables and cycles the text and data pens among the 8 fundamental colours.

  ---

• df_viewport

  Library	xasgraph	Fortran code
  Calling sequence	CALL DF_VIEWPORT(LUS,BUFFER,ANNOTATE)
  Arguments	INTEGER	LUS(2)
  	CHARACTER*(*)	BUFFER
  	CHARACTER	ANNOTATE ('N'|'S'|'L')

  This routine sets the default viewport for the plotting server connected by y_openplot) to the logical units LUS, according to the ANNOTATE flag set by annotate_new (this takes account of space around the data frame used for annotations). It uses a default viewport, unless specifically set by the user in XAS environment variable viewport, and stores the information back in the environment. The viewport is changed only if the annotation style has been changed since last plot (this is also kept track of in the environment)
  BUFFER is a work area supplied by the caller and used internally.

  ---

• df_window

  Library	xasgraph	Fortran code
  Calling sequence	CALL DF_WINDOW(LUS,CLEAR,REPLOT, BUFFER, XLINLOG,YLINLOG, XWL,XWU ,YWL,YWU, XWL1,YWL1)
  Arguments	INTEGER	LUS(2)
  	LOGICAL	CLEAR
  	LOGICAL	REPLOT
  	CHARACTER*(*)	BUFFER
  	CHARACTER*3	XLINLOG,YLINLOG ('LIN'|'LOG')
  	REAL	XWL,XWU ,YWL,YWU
  	REAL	XWL1,YWL1

  This routine associates a plotting window to the the default viewport set by df_viewport for the plotting server connected by y_openplot to the logical units LUS.
  It returns the linear or logarithmic setting XLINLOG,YLINLOG for the axis scales retrieving it from the XAS environment.
  The setting of the axes is done only for new frames (otherwise they are retrieved from the XAS environment), i.e. if the CLEAR flag set by check_overtrace or the REPLOT flag are .TRUE..
  The coordinates of the lower left and upper right corners XWL,YWL XWU,YWU of the plotting windows are treated as suggestions and rounded to nices values by the nice_* calls as instructed by XAS environment. The actual values are stored as side effect in PENCOMMON.
  Note that for log scales the lower bounds of the axes cannot be smaller than the positive safety values in XWL1,YWL1.
  BUFFER is a work area supplied by the caller and used internally.

  ---

• get_datastyle

  Library	xasgraph	Fortran code
  Calling sequence	CALL GET_DATASTYLE(ISTYLE)
  Arguments	INTEGER	ISTYLE

  This routine tests the datastyle XAS environment variable and returns a numeric flag indicating the plotting style :
  1. for the Histogram style
  2. for the Error bar style
  3. for the Solid style
  4. for the Marker style (unimplemented and replace by Histogram style)

  ---

• lb_axis

  A family of three axis plotting and annotation routines.

  Library	xasgraph	Fortran code
  Calling sequence	CALL LB_AXIS(XY,ARG2,ARG3, LINLOG, ARG5,ARG6,ARG7 ,ARGX,NTIC)
  Arguments		not documented online

  This routine draws an axis with its annotations. It is derived from a pre-existing plotting package called "The Labeller" which is documented on paper separately.

• lb_number

  Library	xasgraph	Fortran code
  Calling sequence	CALL LB_NUMBER(LUS,ARG1,ARG2,ARG3)
  Arguments	INTEGER	LUS(2)
  	CHARACTER*(*)	ARG1
  	CHARACTER*(*)	ARG2 ('CENTRED')
  	CHARACTER*(*)	ARG3 ('NORMAL'|'ROTATED')

  This routine (derived from the same pre-existing plotting package mentioned for lb_axis) plots the tics values for axes.
  ARG2 controls the alignment of the number label with respect to the tic coordinate (only 'CENTRED' out of the original list of possible values 'PROTECTED'| 'CENTRED'| 'LEFT'| 'RIGHT'| 'GRADUAL' is supported).
  ARG3 controls the orientation of the number label, which is either 'NORMAL' or 'ROTATED' by 90 degrees.
  ARG1 is the format of the numeric label. Integer and floating point Fortran style formats ('In', 'Fw.d') are supported together with an 'Hn' format used to obtain hh:mm:ss hour notation, an 'EXP' and a 'LOG' formats (the former intended for 10 ⁿ notations, while the second reports only the exponent n and is typically used for log scales with many decades).

• lb_tics

  Library	xasgraph	Fortran code
  Calling sequence	CALL LB_TICS(LUS,ARG1)
  Arguments	INTEGER	LUS(2)
  	REAL	ARG1

  This routine (derived from the same pre-existing plotting package mentioned for lb_axis) plots the tics at appropriate places, where ARG1 is the tick height (or length) in NDC (Normalized Device Coordinates, 0.0-1.0, i.e. as a fraction of viewport size).

  ---

• nice_axes

  A family of three routines to set up axis tic labelling.

  Library	xasgraph	Fortran code
  Calling sequence	CALL NICE_AXES(XYMIN,XYMAX,XYLOW,XYUPP)
  Arguments	REAL	XYMIN,XYMAX
  	REAL	XYLOW,XYUPP

  This routine, passed the suggested extrema of an axis XYMIN,XYMAX returns nice rounded extrema XYLOW,XYUPP. Rounding is done down or up to the nearest power of ten (e.g. 2.7 is rounded down to 2 or up to 3, while -440 is rounded down to -500 or up to -400).

• nicer_lin_axes

  Library	xasgraph	Fortran code
  Calling sequence	CALL NICER_LIN_AXES(XYMIN,XYMAX,XYLOW,XYUPP,NTIC)
  Arguments	REAL	XYMIN,XYMAX
  	REAL	XYLOW,XYUPP
  	INTEGER	NTIC

  An improved version of nice_axes which does the rounding so that the values of all tic labels looks nice, when the axis is divided into NTIC parts.

• nicer_log_axes

  Library	xasgraph	Fortran code
  Calling sequence	CALL NICER_LOG_AXES(XYMIN,XYMAX,XYLOW,XYUPP)
  Arguments	REAL	XYMIN,XYMAX
  	REAL	XYLOW,XYUPP

  An improved version of nice_axes which does the rounding so that the values of tic labels looks nice, when the axis is logarithmic.

  ---

• plot_xxy_bar

  A family of routines to plot Y vs X data in a number of standard ways. All routines as usual plot on the plotting server connected by y_openplot to the logical units LUS.

  Library	xasgraph	Fortran code
  Calling sequence	CALL PLOT_XXY_BAR(LUS,LOWER,UPPER, DATA,ERROR, NCHAN, X,Y)
  Arguments	INTEGER	LUS(2)
  	REAL	LOWER(NCHAN), UPPER(NCHAN)
  	REAL	DATA(NCHAN), ERROR(NCHAN)
  	INTEGER	NCHAN
  	REAL	X(2),Y(2)

  This routine plots an array of NCHAN error bars (or upper limits if the ulimit environment variable is set). The DATA and ERROR arrays are the Y data and their errors. The LOWER and UPPER arrays are the extrema of the X error bars.
  The X and Y arrays (of size 2) are work areas used internally to construct the points to be plotted at the ends of the bars.

• plot_xxy_histo

  Library	xasgraph	Fortran code
  Calling sequence	CALL PLOT_XXY_HISTO(LUS,LOWER,UPPER, DATA, NCHAN, X,Y)
  Arguments	INTEGER	LUS(2)
  	REAL	LOWER(NCHAN), UPPER(NCHAN)
  	REAL	DATA(NCHAN),
  	INTEGER	NCHAN
  	REAL	X(2*NCHAN),Y(2*NCHAN)

  This routine plots an array of NCHAN DATA Y values in histogram style (i.e. connecting horizontal bars at the given Y height, where the LOWER and UPPER arrays are the extrema of the bars in X.
  The X and Y arrays (of double size) are work areas used internally to construct all the points to be plotted. The y_lines polyline primitive is used, plotting such data in chunks of 512 points (because of a limitation in the server communication channel buffer) transparently to the user.
  The routine interrupts the plot if a gap (of more than 1% of the previous bin size) is found between the LOWER end of a bin and the UPPER end of the previous bin, and resumes at the next bin (results can be surprising when plotting very sparse data !)

• plot_xxy_join

  Library	xasgraph	Fortran code
  Calling sequence	CALL PLOT_XXY_JOIN(LUS,LOWER,UPPER, DATA, NCHAN, X,Y)
  Arguments	INTEGER	LUS(2)
  	REAL	LOWER(NCHAN), UPPER(NCHAN)
  	REAL	DATA(NCHAN),
  	INTEGER	NCHAN
  	REAL	X(NCHAN),Y(NCHAN)

  This routine plots (connecting each point) an array of NCHAN DATA Y values vs X where the X coordinates are the mean between the LOWER and UPPER arrays.
  The X and Y arrays (of same size as the data) are work areas used internally to construct all the points to be plotted. The y_lines polyline primitive is used, plotting such data in chunks of 512 points (because of a limitation in the server communication channel buffer) transparently to the user.
  The routine interrupts the solid line if a gap (of more than 1% of the previous bin size) is found between the LOWER end of a bin and the UPPER end of the previous bin.

• plot_xy_join

  Library	xasgraph	Fortran code
  Calling sequence	CALL PLOT_XY_JOIN(LUS,XAX,DATA ,NCHAN, X,Y)
  Arguments	INTEGER	LUS(2)
  	REAL	XAX(NCHAN)
  	REAL	DATA(NCHAN),
  	INTEGER	NCHAN
  	REAL	X(NCHAN),Y(NCHAN)

  This routine plots (connecting each point) an array of NCHAN DATA Y values vs the XAX X values.
  The X and Y arrays (of same size as the data) are work areas used internally to construct all the points to be plotted. The y_lines polyline primitive is used, plotting such data in chunks of 512 points (because of a limitation in the server communication channel buffer) transparently to the user.

[Previous][Next] [Up][Down]