HIGZ -- H2OverviewofHPLOTcalls

Overview of HPLOT calls


  Name      Action                                       Page
   HPLABL    to define alphanumeric         
            labels lists
   HPLAER    to draw asymetric error        
            bars
   HPLARC    to draw an arc of circle       
   HPLAX     to add a comment to the         
            axes
   HPLBOX    to draw a box on the           
            picture
   HPLCAP    to switch or/off metafile      
            output
   HPLCOM    to add a comment               
   HPLCON    to draw a contour plot         
   HPLDO     to plot all histograms          
            (like  HISTDO)
   HPLEGO    to plot a scatter plot as      
            a 3 dim view
   HPLEND    to terminate HPLOT             
   HPLERR    to draw error bars             
   HPLFRA    to define (and draw) a         
            frame
   HPLFUN    to draw a function             
   HPLGIV    to return size of the          
            current zone
   HPLINE    to draw straight lines         
   HPLINT    to initialize HPLOT            
   HPLKEY    to draw a symbol and its       
            explanation
   HPLNT     to plot a N-tuple               
   HPLNUL    to draw a picture or zone      
            frame
   HPLNXT    user routine called before     
            each new frame
   HPLOC     for graphics input              
   HPLOPT    to define options              
   HPLOT     to plot histograms or           
            plots
   HPLPRO    to plot a scatter plot and     
            its projections
   HPLPTO    wait after each plot           
   HPLSET    to redefine parameters         
   HPLSIZ    to set or read picture         
            dimensions
   HPLSOF    to draw software               
            characters
   HPLSUR    to plot a scatter plot as      
            a 3 dim view
   HPLSYM    to draw symbols on the         
            picture
   HPLTAB    to draw an histogram as a      
            table
   HPLTIT    to draw a title                
   HPLUSR    user routine called after      
            each plot
   HPLWIR    to draw cross-wires on a       
            picture.
   HPLZOM    to zoom a picture              
   HPLZON    to split the picture into      
            zones

                     +------------------------------+
                     | CALL  HPLABL (NUM, NB, CHLAB) |
                     +------------------------------+

Action: By default, labels used by axis are numeric labels. This routine, allows the user to define up to nine alphanumeric set of labels (numbered from 1 to 9). These labels can then be used in subsequent calls producing axis. This routine limits the lenght of the alphanumeric labels at 32 characters. Parameter Description:

NUM: List number.
NB: Number of labels .
CHLAB(NB): Array of CHARACTER defining the list contents.

See also the HIGZ routine IGQWK.

                    +--------------------------------+
                    | CALL  HPLINE (XU, YU, N, CHOPT) |
                    +--------------------------------+

Action: Draws a polyline on the picture. Parameter Description:

XU

Array containing the X-coordinates of the points be to connected by straight lines.

YU

Array containing the Y-coordinates of the points be to connected by straight lines.

N

Dimension of the arrays XU and YU. Note that N-1 lines will be drawn.

CHOPT

CHARACTER variable determining the coordinate system of the XU, YU coordinates:

' ': means that the coordinates are expressed in histogram coordinates (of the last drawn histogram).
'C': (or 'CM' for compatibility) means that the coordinates are expressed in centimeters.

Remark:

If CHOPT = 'CM', HPLGIV can be used to determine the boundary of the current picture.
The line type can be changed with parameter DMOD of HPLSET.
The limit N<1002 must be satisfiedto parameter NMAX defined in the Patchy KEEP sequence HPL11 in the HPLOT source PAM file..
See also the HIGZ routine IPL.

HPLINE must be called after HPLFRA or HPLOT.

                          +--------------------+
                          |CALL  HPLINT (IWTYP) |
                          +--------------------+

Action: Initialises the HPLOT package and especially the graphic package environment (HIGZ). Parameter Description:

IWTYP: Workstation type.See appendix B for the list of valid workstation types. The special value IWTYP=0 will not open a graphics workstation. This value should be used when working in batch mode. In this case, to direct output to a metafile, use HPLCAP or IGMETA.

Remark:

The HPLOT error messages will appear on the same output file as the HBOOK error message file.
The HBOOK result file can be changed by the HBOOK routine HOUTPU, and the HBOOK error message file can be changed by the HBOOK routine HERMES.

HPLINT must be called before any other HPLOT routines, but after the HBOOK initialization routine HLIMIT.

                   +----------------------------------+
                   |CALL  HPLKEY (XC, YC, ISYM, CHTIT) |
                   +----------------------------------+

Action: Draws a symbol and its explanation. The symbol numbers are the same as for HPLSYM, and HPLKEY provides a convenient method of annotating the different symbols on a plot. Parameter Description:

XC: X coordinate (in cm) of the first character of the string preceded by the symbol ISYM.
YM: Y coordinate (in cm) of the first character of the string preceded by the symbol ISYM.
ISYM: Code of the symbol to be drawn (see HPLSYM for details).
CHTIT: CHARACTER variable containing the string to be drawn.

Remark: For HPLKEY the ``text'' consists of the symbol followed by a space and then the characters of CHTIT, which will be in the same size as for comments (routine HPLCOM). This can be controlled by setting the value of the parameter CSIZ using routine HPLSET, which defines also the symbol size.

       +----------------------------------------------------------+
       | CALL  HPLNT (IDN, ISEL, UWFUNC, IFROM, ITO, IVARX, IVARY) |
       +----------------------------------------------------------+

Action: Draws two variables of an Ntuple as a scatterplot. Parameter Description:

IDN: Identifier of a Ntuple.
ISEL: Selection flag.
UWFUNC: Selection function.
IFROM: First event number.
ITO: Last event number.
IVARX: Number of the Ntuple variable to be plotted along X.
IVARY: Number of the Ntuple variable to be plotted along Y.

Routine HPLNT plots the correlation between two variables of an existing Ntuple IDN. For all events in the range IFROM to ITO the Ntuple variable with identifier IVARY will be plotted against the variable with identifier IVARX. A selection mechanism may be specified with the ISEL parameter. ISEL=0 means no selection. All events with numbers between IFROM to ITO included will be used in the plot. When ISEL is not zero, then an EXTERNAL user written function UWFUNC is called for each event with, as parameters the Ntuple array X and the value of ISEL. Routine UWFUNC should return the weight of the event. If UWFUNC=0 then the event is not included in the plot.

                    Example of the use of  HPLNT

                 .
                 .
                 .
                 .
     EXTERNAL WFUNC
*
*         To plot X(7) versus X(3) for the 5000 first events
*         of Ntuple 10 using the selection option 1.
*
     CALL HPLNT(10,1,WFUNC,1,5000,3,7)
                 .
                 .
                 .
     FUNCTION WFUNC(X,ISEL)
     DIMENSION X(*)
     WFUNC=0.
*
     IF(ISEL.EQ.1)THEN
         IF(X(2)**2 +X(3)**2.LT.0.)WFUNC=1.
     ELSEIF(ISEL.EQ.2)THEN
         IF(X(2)**2 +X(3)**2.GT.5.)WFUNC=1.
     ELSE
         WFUNC=X(5)
     ENDIF
     END

Remark:

HPLNT works only on ``Row Wise Ntuples''.
In PAW, more possibilities are offer to draw Ntuples (including 3D).
In an interactive PAW session the user function UWFUNC may be defined interactively using a Fortran syntax without recompilation and relinking.

For more information about Ntuples, see the description of routine HBOOKN in the HBOOK manual.

                             +--------------+
                             | CALL  HPLNUL  |
                             +--------------+

Action: Draws a box in place of the histogram box and its contents. Remark: HPLNUL allows the user to draw a box for his own requirements. If windowing is in use ( HPLZON), HPLNUL draws the box in the appropriate position. If windowing is not in use, or if HPLNUL draws a box on a new page, then the page number and the global title (if present) will also be drawn. Routines HPLAX, HPLBOX, HPLCOM, HPLINE, HPLTIT, etc., can all be used to add information to the box. It is also possible to superimpose a histogram with:

      CALL HPLOT(ID,'S',' ',0)

in which case no axis values or tick marks will be drawn.

                             +--------------+
                             | CALL  HPLNXT  |
                             +--------------+

Action: This is an HPLOT User routine. The user should not call it but provide, if he wishes, his own version to replace the do-nothing version automatically provided by HPLOT. This routine is called before each graphics clear screen operation i.e. it is intended to be used to pause an interactive program at the end of a graphics frame and, if required, to change program flow. On some systems graphics input/output and Fortran input/output cannot be intermixed and in most systems Fortran input/output will simply start its text from wherever the graphics cursor was positioned. For these reasons an auxiliary HPLOT routine, called HPLPTO, to do simple text output and wait for input via graphics rather than Fortran has been provided.

                   Example of the use of  HPLNXT

     SUBROUTINE HPLNXT
*        Optional user routine called before a new frame
     CHARACTER*30   STROUT,STRIN
*
     DATA STROUT/'TYPE QUIT OR RETURN'/
*        Issue a graphics prompt and read keyboard
     CALL HPLPTO(STROUT,STRIN)
*        Check for quit
     IF(STRIN.NE.'QUIT') RETURN
*        Clean up and stop
     CALL HPLEND
     STOP 99
     END

  +--------------------------------------------------------------------+
  | CALL  HPLOC (NTPRI, NTLOC*, XLOC*, YLOC*, IDH*, ICX*, ICY*, ISTAT*) |
  +--------------------------------------------------------------------+

Action: Picks a point on the current displayed picture and returns the information, related to the corresponding histogram. Picking is done with locator number 1. Parameter Description:

NTPRI: Normalisation transformation number with a priority. If NTPRI<0 then automatic selection of NTLOC. If NTPRI>=0 then transformation number NTPRI has priority.
NTLOC: Normalisation transformation number which has been picked.
XLOC: X coordinate in NTLOC units.
YLOC: Y coordinate in NTLOC units.
IDH: Histogram identifier corresponding to NTLOC.
ICX: Channel number in X for IDH.
ICY: Channel number in Y for IDH (if 2-dim histogram).
ISTAT: Locator return status

Remarks:

NTLOC is returned with the value 0 when the point is outside the picture limits as defined by the XSIZ/YSIZ parameters. In this case XLOC and YLOC are given in Normalized Device Coordinates in the range (0.,1.).
NTLOC is returned with the value 1 when the point is somewhere on the picture, but not in a histogram box. In this case XLOC and YLOC are given in centimeters. To force XLOC and YLOC to be returned in centimeters independently of the position of the locator, set NTPRI=1.

NTLOC returns values like 10, 20, 30, etc when the point is inside one of the histogram boxes as explained in chapter [more info]. In this case XLOC and YLOC are given in histogram coordinates.

                         +----------------------+
                         |CALL  HPLOPT (CHOPT,N) |
                         +----------------------+

Action: Allows the user to change the options defined by default in HPLINT. HPLOPT can be called any number of times, each option remaining in effect until modified by a further call to HPLOPT. Parameter Description:

CHOPT: CHARACTER*4 array of options. Each word of the array defines a new option via a character string of four characters (see table below).
N: Size of the array in words.

In table [more info] the values in the column labelled default are those set at initialization by HPLINT.

           Table 0.1: Overview of the  HPLOPT options             [tab:hplopt]
+-----------+-----------+-------------------------------------------------------+
+-Default---+-Alternative-Effect------------------------------------------------+
| ' '       | 'A0',     | Picture size. Predefined options are: A0, A1, A2,     |
|           | 'A1',...  | A3, A4, A5, A6                                        |
| 'NOPG'    | '*P','**P', Suppresses ('NOPG') or adds a 1, 2 or 3 digit page    |
|           | '***P'    | numbers to a plot (Each '*' stands for a     |
|           |           | digit). The page numbers are incremented              |
|           |           | automatically                                         |
| 'NEAH'    | 'EAH'     | Plots Errors bars And Histogram, if both are          |
|           |           | present                                               |
|           |           |                                                       |
| 'VERT'    | 'HORI'    | Vertical or horizontal orientation of paper           |
| 'NAST'    | 'AST'     | Functions are drawn with ('AST ') or without          |
|           |           | ('NAST') asterisks in each channel.                   |
| 'NCHA'    | 'CHA'     | Scatter plot are plotted with dots randomised         |
|           |           | within each bin ('NCHA') or by printing a single      |
|           |           | character in the middle of the bin ('CHA ')           |
| 'SOFT'    | 'HARD'    | Use SOFTware or HARDware characters                   |
| 'TAB '    | 'NTAB'    | tables ( HTABLE) are plotted as tables ('TAB ') or     |
|           |           | as scatter plots ('NTAB')                             |
+-----------+-----------+-------------------------------------------------------+

             Table 0.1: Overview of the  HPLOPT options (continued)
+-Default---+-Alternative-Effect------------------------------------------------+
+-----------+-----------+-------------------------------------------------------+
| 'HTIT'    | 'UTIT'    | Option for printing titles. 'HTIT' means use the      |
|           |           | HBOOK titles, while 'UTIT' signals the use of user    |
|           |           | titles                                                |
| 'LINX'    | 'LOGX'    | The scale for the X axis is linear or logarithmic.    |
| 'LINY'    | 'LOGY'    | The scale for the Y axis is linear or logarithmic.    |
|           |           | Note that if in HBOOK the  HIDOPT option 'LOGY' or     |
|           |           |  HLOGAR was selected for a particular ID      |
|           |           | and if neither options 'LINY' nor 'LOGY' are          |
|           |           | selected then the scale will be logarithmic. If       |
|           |           |  HIDOPT with option 'LOGY' was called and    |
|           |           | the option 'LINY' is selected then the scale will     |
|           |           | be linear                                             |
| 'LINZ'    | 'LOGZ'    | The scale for the Z axis is linear or logarithmic     |
|           |           | (for lego plots or surfaces).                         |
| 'BOX '    | 'NBOX'    | By default a rectangular box is drawn around a        |
|           |           | picture. 'NBOX' suppresses this box                   |
|           |           |                                                       |
| 'NTIC'    | 'TIC'     | Cross-wires are drawn ('TIC ') or not drawn           |
|           |           | ('NTIC') after each plot                              |
| 'NSTA'    | 'STA'     | Statistics information are printed ('STA ') or not    |
|           |           | printed ('NSTA') on the picture                       |
| 'NFIT'    | 'FIT'     | Fit parameters are printed ('FIT ') or not printed    |
|           |           | ('NFIT') on the picture                               |
| 'NZFL'    | 'ZFL'     | The picture is stored ('ZFL ') or not stored          |
|           |           | ('NZFL') in a ZEBRA data base The procedure to        |
|           |           | create a HIGZ picture is given below.                 |
| 'NZFL'    | 'ZFL1'    | 'ZFL1' has the same effect as 'ZFL ', but only the    |
|           |           | picture last created is kept in memory.               |
| 'NPTO'    | 'PTO'     | ``Please Turn Over''. With 'PTO ' a carriage return   |
|           |           | is requested between each new plot.                   |
|           |           |                                                       |
| 'NBAR'    | 'BAR'     | 1-dimensional histograms are plotted as ``Bar         |
|           |           | charts'' ('BAR ') or as contours ('NBAR')             |
| 'DVXR'    | 'DVXI'    | Real ('DVXR') or integer ('DVXI') labels are          |
|           |           | computed for the X axis                               |
| 'DVYR'    | 'DVYI'    | Real ('DVYR') or integer ('DVYI') labels are          |
|           |           | computed for the Y axis                               |
| 'GRID'    | 'NGRI'    | Grid on X and Y axis                                  |
| 'NDAT'    | 'NDAT'    | The date is printed or not on each plot               |
| 'NFIL'    | 'NFIL'    | The file name is printed or not on each plot          |
+-----------+-----------+-------------------------------------------------------+

Remarks:

The parameters can be supplied in any order in array CHOPT. If two mutually exclusive options are given, the last one encountered is used i.e. CHOPT(2) takes precedence over CHOPT(1).
The allowed range of metric paper sizes may be restricted at some installations by the physical size of the plotter.
Once a value for the page number has been given, it will automatically be incremented for each new picture.
If the options 'A3' or 'A4' are called, windowing is turned off (i.e. a call is made to HPLZON(1,1,1,' ')). It is recommended that windowing is defined after HPLOPT to avoid this problem.
When the option 'LOGX' is selected only the axes are drawn with a call to HPLOT or HPLTAB. This option is interesting when used with HPLERR, HPLAER, HPLSYM or HPLFUN.
If option 'ZFL ' is selected then all the subsequent graphics primitives are kept in memory to make a HIGZ picture. A name is automatically assigned to each HIGZ picture : PICT1, PICT2, .... Several pictures can be stored in memory. They can be saved in a ZEBRA/RZ direct access file and be modified with the HIGZ graphics editor. (See the HIGZ routines IZFILE, IZIN, IZOUT, IZPICT and IZGED and the last example at the end of the manual.)
If option 'ZFL1' is selected only the last created picture is kept in memory.
With the 'BAR ' option parameter HTYP of HPLSET can be used to change the fill area interior style.

If CHOPT(1) = 'SHOW' a list of all options and their current values is printed.

                  +------------------------------------+
                  |CALL  HPLOT (ID, CHOPT, CHCASE, NUM) |
                  +------------------------------------+

Action: Plots histogram ID. Parameter Description:

ID

Identifier of the histogram to be plotted. ID=0 means plot all histograms.

CHOPT

CHARACTER variable containing the string of options.

'': The histogram contour is drawn (1 dim histograms).
'H': The histogram contour is drawn (1 dim histograms).
'L': Draw a Line connecting bin contents (1 dim histogram).
'*': An asterisk is drawn at the center of each histogram channel.
'P': The current polymarker is drawn at the center of each histogram channel.
'C': The histogram contour is drawn as a smooth curve (the curve will pass through the center of each channel and will be smoothed to form a line).
'B': Bar chart format selected for 1 dim histograms.
'S': The current histogram is superimposed on the previous picture (title, axes, page number are not redrawn).
'K': Keep histogram in memory (in a ZEBRA bank). This option needs to be requested for later update of histogram (option 'U') or for addition of several histograms (option '+') if several zones (with HPLZON) are in use.
'U': Update histogram with identifier ID. Useful for dynamic histograms (when the content of the histogram changes with time). The new histogram content is superimposed on the previous one, and the scale is changed (with new axis labels if necessary).
'+': The contents of histogram ID is added to the contents of the histogram on the current picture.
'-': Same as '+' but the contains of the histogram is substract.
'+-': Draw the for each bin delta between 2 histograms
'A': If specified, axis are not drawn
'BOX': Draw 2D histograms with proportionnal Boxes
'ARR': Draw 2D histograms with Arrows
'COL': Draw 2D histograms with Colors
'LEGO': Draw as a Lego plot
'LEGO1': Draw as a Lego (mode 1 see HPLTAB)
'LEGO2': Draw as a Lego (mode 2 see HPLTAB)
'SURF': Draw as a Surface
'SURF1': Draw as a Surface (mode 1 see HPLTAB)
'SURF2': Draw as a Surface (mode 2 see HPLTAB)
'CONT': Draw 2D histograms as a Contour plot
'SCAT': Draw 2D histograms a Scatter plot
'TEXT': Draw 2D histograms with the contains of each cell
'CHAR': Draw 2D histograms with a character set
'ARR': Draw 2D histograms with arrows
'HIST': Draw only the histogram
'FUNC': Draw only the function (for example in case of fit)
'E': Errors with current marker type and size are drawn.

CHCASE

4-CHARACTER string to select possible projections of a 2 dimensional histogram, e.g. slices in X. Possible values are: HIST, PROX, PROY, BANX, BANY, SLIX, SLIY.

NUM

Integer which permits, together with parameter CHCASE, to further specify a given selection, e.g. third slice in X.

Remarks:

When superimposing histograms with CHOPT = 'S' the line style for drawing the straight lines of the histogram, error bars and function is changed as follow :
```
first histogram     ------   solid line
second histogram     ----    (dash,blank,dash,blank)
third histogram     . . .    (dot,blank,dot,blank)
fourth histogram    .-.--    (dash,dot,dash,dot)
fifth histogram     .....    (dot,dot,dot,dot)
```
If more than five histograms are superimposed, HPLOT will loop round the symbols again. If three histograms are to be superimposed, but the second histogram requested does not exist, the third histogram will still be plotted with the third symbol ( . .). Similarly if the second histogram is a scatter plot, the third histogram will take the third symbol.
One can force a particular type of line style by calling routine HPLSET with parameter DMOD, e.g. CALL HPLSET('DMOD', 4.0) will force all lines to be drawn in dash-dot mode.
When option 'S' is selected, the histogram is drawn with the viewport and window parameters of the first histogram plotted in the current zone.
Option 'BAR ' in HPLOPT can be used instead of CHOPT = 'B' to plot all 1 dimensional histogram as ``bar charts''.
The fill area interior style and style index can be changed with parameter HTYP in HPLSET (this parameter has to be set to draw a histogram as a hatched surface instead of a contour).
The colour (contour or surface) of the histogram can be changed with parameter HCOL in HPLSET.
The current polymarker (CHOPT = 'P') can be changed by calling HIGZ routine IGSET (parameter MTYP).

If options 'U' or '+' are selected, and if several zones are requested, option 'K' must be used when the first histogram is drawn.

    Example of the use of the option K and U


      program dice
      common /pawc/ h(100000)
*.___________________________________________
*
      call igwkty(kwtype)
      call hlimit(100000)
      call hplint(kwtype)
*
      n      = 1000
      ifirst = 1
      call hplset('HCOL',1001.)
      call hplset('NDVX',-11.05)
      call hplopt('STAT',1)
      call hbook1(3,'Playing with two dice',11,2.,13.,0.)
      do j=1,n
         ix1=6.*rndm(.01234)+1
         ix2=6.*rndm(.56789)+1
         call hfill(3,float(ix1+ix2),0.,1.)
         if (ifirst.eq.1) then
            call hplot(3,'BK',' ',0)
            ifirst=0
         else
            call hplot(3,'BU',' ',0)
         endif
         call igterm
      enddo
*
      end

Two random numbers between 1 and 6 are generated and the histogram is filled with the sum of this numbers to simulate dice playing. The first time the histogram is plotted the option ``LitK'' is used to keep in memory a copy of the histogram in order to update it later. With the ``U'' option, HPLOT looks at the current kept histogram contents and update the plot with the new contribution without redrawing everything. This mechanism is used in data acquisition. The statistics are also updated.

                   +----------------------------------+
                   | CALL  HPLPRO (ID, CHXTIT, CHYTIT) |
                   +----------------------------------+

Action: Draws a scatter plot and its X and Y projections (if present) on a plot with 2 by 2 zones. Separate titles may be given to the projections if required. Parameter Description:

ID: The HBOOK identifier of a 2 Dim histogram.
CHXTIT: CHARACTER string containing the title to be printed for the X projection. ' ' requests to print the histogram title for the X projection (unless option 'UTIT' has been selected, in which case no title will be printed).
CHYTIT: CHARACTER string containing the title to be printed for the Y projection. ' ' requests to print the histogram title for the Y projection (unless option 'UTIT' has been selected, in which case no title will be printed).

Remarks:

This routine sets the zone option on entry, and turns it off before returning, therefore subsequent plots will be plotted in the default ``unzoned'' manner.
The scatter plot is drawn last so that if HPLAX is called after HPLPRO, the axis titles will appear on the scatter plot.

If option 'UTIT' is selected before calling HPLPRO, no title will be printed on the 2 dim histogram itself (the titles for the projections depend on CHXTIT and CHYTIT, not 'UTIT'). Therefore, it is possible to supply a title for the 2-D histogram with HPLTIT.

                      +----------------------------+
                      |CALL  HPLPTO (STROUT, STRIN) |
                      +----------------------------+

Action: Displays the CHARACTER variable specified in the bottom left hand corner of the screen during an interactive graphics session, waits for some user keyboard input and returns the input (which may be just carriage return) in a CHARACTER variable. Parameter Description:

STROUT: CHARACTER variable to be displayed. The maximum length allowed will depend on the underlying graphics package.
STRIN: CHARACTER variable returned to the user. The maximum length allowed will depend on the underlying graphics package.

Remark: When called in interactive graphics mode this routine does nothing. It is primarily intended to be called from the user routine HPLNXT at the end of each graphics frame so that a user can pause between frames.

                       +--------------------------+
                       | CALL  HPLSET (CHOPT, VAR) |
                       +--------------------------+

Action: Sets one HPLOT parameter (see table for more details). Note that if HPLSET in invoked with a parameter not describe in the table , the HIGZ routine IGSET is invoked with the same parameter value. If the parameter value is again not correct for IGSET, then an error message is displayed. Parameter Description:

CHOPT: CHARACTER variable of length 4 identifying the parameter to be redefined.
VAR: New value for the parameter specified.

Remarks:

If VAR = 0 the corresponding parameter is set to its default value.
If CHOPT = '* ', all parameters listed in the table are set to their default value.
If CHOPT = 'SHOW' a list of all parameters is printed.
HMAX is given in percent (default value is 90%).
The values given to the parameters PTYP, BTYP and HTYP are fill area interior style. These parameters are installation dependent and even device dependent. If one wants to get the same result on all devices, use numbers defined on on the figure [more info]. The parameters PCOL, BCOL, HCOL are equivalent to PTYP, BTYP, HTYP, respectively, but instead of changing the hatch style, they change the colour of the same areas.
If PCOL, BCOL, HCOL are between 1 and 99, then only the contour of the corresponding area is changed. If they are between 1001 and 1099, then the surface is filled with the corresponding fill area colour index. For PCOL, BCOL or HCOL the corresponding value of the Fill Area Interior Style (for PTYP, BTYP, HTYP) is automatically set to 1 (solid).

It is possible to specify with one HPLSET call both the border and the inside color for the Histogram, Box Page, and Function (HCOL, BCOL, PCOL, FCOL).

              Example of HCOL specification

      Ex:
                             +---- The Histogram is filled
                             |+--- The border color is 2
                             ||++- The inside color is 3
                             ||||
                             VVVV
          CALL HPLSET('HCOL',1203.)

The same mechanism is also available for FCOL, BCOL and PCOL.

TFON, GFON, VFON and LFON must be set according the following convention :
```
                         'X'FON = 10*IFON + IPREC
                                  
```
where IFON and IPREC correspond respectively to the HIGZ attributes for ``Text Font'' and ``Precision''.
*SIZ, *TYP, *COL, *WID and *FON define respectivly all the text sizes, the fill area type, the colors, the line width and the text fonts with the same values.

The label sets defined by the routine HPLABL can be used for axes on all plots produced by HPLOT via the NDVX, LitNDVY and NDVZ parameters. These parameters have the following structure:

              Example of NDVX specification

          CALL HPLSET('NDVX',i)      e.g.   CALL HPLSET('NDVX',512.)
        or
          CALL HPLSET('NDVX',i.jk)   e.g.   CALL HPLSET('NDVX',10.25)

In the first case the number i contains 100 times the number of secondary divisions plus the number of primary divisions. (e.g. 512 means 12 primary and 5 secondary division. By adding 10000 times N3 to i a third level of divisions is available. In the second case the number in front of the dot (i) indicates the total number of divisions, the first digit following the dot (j) the label identifier: LABNUM (see HPLABL) (if this number is equal to 0 numeric labels are drawn). The second digit after the (k) dot indicates the position where the labels have to be drawn (i.e. the text justification parameter, in this case 5, indicating horizontally written text centered on the interval). Study figures [more info] and [more info] for details. These two figures show that the labels can be centered on the tick marks (1 to 4) or on the divisions (5 to 8). If the labels are centered on the tick marks, note that the number of items defined by the routine HPLABL must be equal to the number of tick marks (which is equal to the number of divisions plus one), otherwise the last alphanumeric label on the axis will be undefined. By default, the number of primary divisions given by CALL HPLSET('NDVX',n), CALL HPLSET('NDVY',n) or CALL HPLSET('NDVZ',n) is optimized to have a reasonable labelling. If the number of divisions has to be exactly equal to the number given by HPLSET, a negative value must be used i.e.:


               Forcing an exact number of divisions

          CALL HPLSET('NDVX',-i)      e.g.   CALL HPLSET('NDVX',-512.)
        or
          CALL HPLSET('NDVX',-i.jk)   e.g.   CALL HPLSET('NDVX',-10.25)


                                                                                        < A>

Figure:  Example of labelling for horizontal axes

 [fig:LABNDVX]



                                                                                        < A>

Figure:  Example of labelling for vertical axes

 [fig:LABNDVY]


              Table 0.2: Overview of the  HPLSET options                [tab:hplset]
+-CHOPT--+-VAR-(default)--+-Explanation--------------------------------------+
+--------+-------------------------+--------------------------------------------------+
|  XSIZ  |                20.00cm  | length of picture along X                        |
|  YSIZ  |                20.00cm  | length of picture along Y                        |
|  XMGL  |                2.00 cm  | X margin left                                    |
|  XMGR  |                2.00 cm  | X margin right                                   |
|  YMGL  |                2.00 cm  | Y margin low                                     |
|  YMGU  |                2.00 cm  | Y margin up                                      |
|        |                         |                                                  |
|  XWIN  |                2.00 cm  | X space between zones                            |
|  YWIN  |                2.00 cm  | Y space between zones                            |
|  XLAB  |                1.40 cm  | distance Y axis to labels                        |
|  YLAB  |                0.80 cm  | distance X axis to labels                        |
|  XVAL  |                0.40 cm  | distance Y axis to axis values                   |
|  YVAL  |                0.20 cm  | distance X axis to axis values                   |
|        |                         |                                                  |
|  XTIC  |                0.30 cm  | X axis tick mark length                          |
|  YTIC  |                0.30 cm  | Y axis tick mark length                          |
|  YNPG  |                0.60 cm  | Y position for number of page                    |
|  YGTI  |                1.50 cm  | Y position of global title                       |
|  YHTI  |                1.20 cm  | Y position of histogram title                    |
|  KSIZ  |                0.28 cm  | Hershey character size (cf.  HPLKEY)              |
|        |                         |                                                  |
|  GSIZ  |                0.28 cm  | global title size                                |
|  TSIZ  |                0.00 cm  | histogram title size                             |
|  ASIZ  |                0.28 cm  | axis label size                                  |
|  CSIZ  |                0.28 cm  | comment size                                     |
|  PSIZ  |                0.28 cm  | page number size                                 |
|  VSIZ  |                0.28 cm  | axis values size                                 |
|        |                         |                                                  |
|  SSIZ  |                0.28 cm  | asterisk size (for functions)                    |
|  2SIZ  |                0.28 cm  | scatter plot and table character. size           |
|  HMAX  |                0.90 cm  | histogram maximum for scale                      |
|  PASS  |                     1.  | number of pass for software characters           |
|  CSHI  |                   0.03  | character shift between two pass                 |
|  BARO  |                   0.25  | bar offset for ``bar charts''                    |
|        |                         |                                                  |
|  BARW  |                    0.5  | bar width for ``bar charts''                     |
|  DASH  |                   0.15  | length of basic dashed segment for dashed lines  |
|  DMOD  |                      1  | line style for histogram contour (see HPLOT)     |
|  GRID  |                      3  | grid line type                                   |
|  DATE  |                      2  | date position                                    |
|  FILE  |                      1  | file name position                               |
|        |                         |                                                  |
|  STAT  |                   1111  | stat values to be plotted                        |
|  FIT   |                    101  | fit values to be plotted                         |
|  HTYP  |                      0  | histogram fill area style index                  |
|  BTYP  |                      0  | zone fill area style index                       |
|  PTYP  |                      0  | picture fill area style index                    |
|  FTYP  |                      0  | function fill area TYPe                          |
+--------+-------------------------+--------------------------------------------------+

                Table 0.2: Overview of the  HPLSET options (continued)
+-CHOPT--+-VAR-(default)--+-Explanation--------------------------------------+
+--------+-------------------------+--------------------------------------------------+
|  HCOL  |                      1  | histogram fill area colour index                 |
|  BCOL  |                      1  | zone fill area colour index                      |
|  PCOL  |                      1  | picture fill area colour index                   |
|  FCOL  |                      1  | function fill area COLor                         |
|  XCOL  |                      1  | X axis COLor                                     |
|  YCOL  |                      1  | Y axis COLor                                     |
|        |                         |                                                  |
|  HWID  |                      1  | histogram line width                             |
|  BWID  |                      1  | box line width                                   |
|  PWID  |                      1  | picture line width                               |
|  FWID  |                      1  | function line width                              |
|  XWID  |                      1  | X ticks width                                    |
|  YWID  |                      1  | Y ticks width                                    |
|        |                         |                                                  |
|  TFON  |                      2  | general text (comments) font                     |
|  GFON  |                      2  | global title font                                |
|  VFON  |                      2  | axis values font                                 |
|  LFON  |                      2  | axis labels font                                 |
|  CFON  |                      2  | comment font                                     |
|  NDVX  |               10510.00  | number of divisions for X axis                   |
|        |                         |                                                  |
|  NDVY  |               10510.00  | number of divisions for Y axis                   |
|  NDVZ  |               10510.00  | number of divisions for Z axis                   |
|  FPGN  |                      1  | first PaGe Number                                |
+--ERRX--+-------------------0.50--+-error-on-X-(%-of-bin-width)----------------------+



                                                                    

Figure:  A graphical view of the  HPLSET parameters.

 [fig:HPLSET]


                                                                                  


Figure:  [
The HPLSET parameters PTYP, BTYP and HTYP]The  HPLSET parameters PTYP,
BTYP, HTYP
 [TYPE]

                 +--------------------------------------+
                 |CALL  HPLSIZ (*XSIZE*, *YSIZE*, CHOPT) |
                 +--------------------------------------+

Action: Sets or reads picture size. Parameter Description:

*XSIZE*

Size of the picture along X in centimeters

*YSIZE*

Size of the picture along Y in centimeters

CHOPT

CHARACTER variable specifying whether the picture size given as input or queried for output.

' ': Set the picture size (XSIZE and YSIZE are input parameters).
'R': Read the picture size (XSIZE and YSIZE are output parameters).

         +------------------------------------------------------+
         | CALL  HPLSOF (X, Y, CHTXT, SIZE, ANGLE, SIZMAX, IOPT) |
         +------------------------------------------------------+

Action: Draw software characters. Parameter Description:

X

X coordinate (in cm) of the first character of the string to be drawn.

Y

Y coordinate (in cm) of the first character of the string to be drawn.

CHTXT

CHARACTER variable containing the string to be drawn.

SIZE

Size (in cm) for the characters.

ANGLE

Rotation angle (in degrees) of the text to be drawn

SIZMAX

Dummy (not used at present)

IOPT

Integer specifying the option desired:

-1: First character of text is left adjusted to X, Y
0: Text is centered at X,Y
1: Last character of text is right adjusted at X,Y

List of escape characters and their meaning

<: go to lower case
>: go to upper case (default)
[: go to greek (Roman = default)
]: end of greek
": go to special symbols
#: end of special symbols <
/TT>: gotosuperscript
?: go to subscript
!: go to normal level of script
&: backspace one character
$: termination character

Remarks: The order of alphabets is Roman, Greek and special. The way in which software characters are produced is to present a text as a string of characters which consists only of the allowed characters in Hollerith strings. This string is interpreted by routine HPLSOF as a string consisting both of control characters for such things as change of alphabet, upper and lower case, and others, and the equivalent of each character in the extended range given by a character in the limited set of 63 characters. Note that boldface characters may be simulated by setting the attributes PASS and CSHI with HPLSET. The meaning of these attributes is the following: Every stroke used to display the character is repeated PASS times, at a distance (in percentage of the character height) given by CSHI. This routine directly invokes HIGZ routine IGTEXT. HPLSOF has been kept for compatibility with previous versions of HPLOT. Users are strongly invited to call HIGZ routine IGTEXT directly. +----------------------------------+ |CALL HPLSUR (ID,THETA, PHI, MODE) | +----------------------------------+ Action: Plots two dimensional histograms as solid objects viewed from infinity. The ``object'', can be rotated over a certain angle. Parameter Description: ID Histogram identifier. THETA Viewing angle theta in degrees. PHI Viewing angle phi in degrees. MODE Not used at present. Remarks: See also the routine HPLTAB. +------------------------------------------+ |CALL HPLSYM (X, Y, N, ISYM, USIZE, CHOPT) | +------------------------------------------+ Action: Draws symbols or points on a picture. Parameter Description: X X coordinate of the center of the symbols to be drawn Y Y coordinate of the center of the symbols to be drawn N Dimension of arrays X and Y. ISYM Code of the symbol to be drawn (see below). If ISYM = 0 a point will be drawn. USIZE Size of the symbol (in cm). If USIZE = 0. then the size of the symbol in cm will be taken from the current ``Comment size'', which can be changed with the parameter CSIZ of HPLSET. CHOPT CHARACTER variable determining the coordinate system of X and Y. ' ' means that the coordinates are expressed in histogram coordinates (of the last drawn histogram). Error bars are drawn. 'C' (or 'CM' for compatibility) means that the coordinates are expressed in centimeters. Remark: Some symbols are meant to represent ``blackened'' symbols, but have to be drawn by a series of straight lines. Their effectiveness is therefore device-dependent. On PostScript files they are really filled. The symbol numbers correspond to the Hershey character set used by HIGZ routine IGTEXT, which can also be called directly to draw the same symbols or others. +------------------------------------+ | CALL HPLTAB (ID, NPAR, PAR, CHOPT) | +------------------------------------+ Action: Draws a table with the histogram ID according to the value of CHOPT. Parameter Description: ID Histogram identifier. NPAR Number of parameters in PAR. PAR(NPAR) Array of real parameter. If PAR(i)=0. or NPAR a default value is taken. CHOPT CHARACTER variable specifying the options selected. The possible value of CHOPT and the associate values of PAR are describe below. The default value of CHOPT is 'P'. HPLTAB example program hplotlego * dimension par(6) common /pawc/ h(100000) *.___________________________________________ * call igwkty(kwtype) call hlimit(100000) call hplint(kwtype) call hplmak * call vzero(par,6) call hplsiz(9.,9.,' ') call hplset('YGTI',0.3) call hplset('XMGL',1.) call hplset('YMGL',2.) call hplset('XMGR',1.) call hplset('YMGU',0.5) call hplset('VSIZ',0.15) call hplset('YHTI',1.5) call hplset('MTYP',1.) call doeps(par,'SCAT') call doeps(par,'BOX') call doeps(par,'ARR') call doeps(par,'CONT') call doeps(par,'COL') call doeps(par,'TEXT') call doeps(par,'CHAR') par(1) = 30. par(2) = 30. call doeps(par,'LEGO') call doeps(par,'LEGO1') call doeps(par,'LEGO2') call doeps(par,'SURF') call doeps(par,'SURF1') call doeps(par,'SURF2') call doeps(par,'SURF3') call doeps(par,'SURF4') call doeps(par,'LEGOPOL') call doeps(par,'LEGOCYL') call doeps(par,'LEGOSPH') call doeps(par,'LEGOPSD') call doeps(par,'SURFPOL') call doeps(par,'SURFCYL') call doeps(par,'SURFSPH') call doeps(par,'SURFPSD') call hplend end subroutine doeps(par,chopt) character*(*) chopt character*32 name name = 'hplot' name(6:) = chopt call cutol(name(6:)) open(unit=10,file=name(1:lenocc(name))//'.eps' +, form='formatted',status='unknown') call igmeta(10,-113) call hpltab(200,6,par,chopt) call igterm call igmeta(999,0) close(10) end subroutine hplmak * * Creation of some histograms (based on HBOOK examples) * common /hex2/ c1,c2,xm1,xm2,xs1,xs2 external htfun1,htfun2 *.___________________________________________ * c1 = 1. c2 = 0.5 xm1 = 0.3 xm2 = 0.7 xs1 = 0.07 xs2 = 0.12 * call hbfun2(200,'Test of 2-DIM plots',40,0.,1.,40,0.,1.,htfun2) * end function htfun1(X) common /hex2/ c1,c2,xm1,xm2,xs1,xs2 * a1 = -0.5*((x-xm1)/xs1)**2 a2 = -0.5*((x-xm2)/xs2)**2 x1 = c1 x2 = c2 if(abs(a1).gt.1.e-4)x1 = c1*exp(a1) if(abs(a2).gt.1.e-4)x2 = c2*exp(a2) htfun1 = x1+x2 end function htfun2(x,y) htfun2 = 100.*htfun1(x)*htfun1(y) end +-+--------------------------------------------------------------------------------------------+-+ +-+-CHOPT-=-'SCAT'-Scatter-plot-----------------------------------------------------+----------+-+ | | PAR index | PAR values | default | | +-+-----1------+-Marker-type-see- ISMK.----------------------------------------------+------1.--+-+ | | | | | | | | 2 | Maximum number of random points per cell | 50. | | | | 3 | ZMIN Lowest Z value | ZMIN | | | | 4 | ZMAX Highest Z value | ZMAX | | | | 5 | 1000*IXMIN + IXMAX (Useful for ZOOM) | 1-NX | | | | 6 | 1000*IYMIN + IYMAX (Useful for ZOOM) | 1-NY | | +-+------------+--------------------------------------------------------------------+----------+-+ Figure: Example of HPLTAB with SCAT option +-+--------------------------------------------------------------------------------------------+-+ +-+-CHOPT-=-'BOX'-Boxes-------------------------------------------------------------+----------+-+ | | PAR index | PAR values | default | | +-+------------+--------------------------------------------------------------------+----------+-+ | | 1 | Not used | | | | | 2 | Not used | | | | | 3 | ZMIN Lowest Z value | ZMIN | | | | 4 | ZMAX Highest Z value | ZMAX | | | | 5 | 1000*IXMIN + IXMAX (Useful for ZOOM) | 1-NX | | | | 6 | 1000*IYMIN + IYMAX (Useful for ZOOM) | 1-NY | | +-+------------+--------------------------------------------------------------------+----------+-+ Figure: Example of HPLTAB with BOX option +-+-CHOPT-=-'ARR'-Arrows-----------------------------------------------------------------------+-+ +-+------------+--------------------------------------------------------------------+----------+-+ +-+-PAR-index--+----------------------------PAR-values------------------------------+-default--+-+ | | 1 | Not used | | | | | 2 | Not used | | | | | 3 | ZMIN Lowest Z value | ZMIN | | | | 4 | ZMAX Highest Z value | ZMAX | | | | 5 | 1000*IXMIN + IXMAX (Useful for ZOOM) | 1-NX | | | | | | | | +-+-----6------+-1000*IYMIN-+-IYMAX-(Useful-for-ZOOM)-------------------------------+----1-NY--+-+ Figure: Example of HPLTAB with ARR option +-+-CHOPT-=-'CONT'-Contour-plot----------------------------------------------------------------+-+ +-+------------+--------------------------------------------------------------------+----------+-+ +-+-PAR-index--+----------------------------PAR-values------------------------------+-default--+-+ | | 1 | Nlevel (min=2 max=50) | 20. | | | | 2 | 0 use colour to distinguish contours. Line type used is 1. | 0. | | | | | 1 use line style to distinguish contours. | | | | | | 2 line style and colour are the same for all contours. | | | | | | 3 draw the contour with fill colored fill are. | | | | | | | | | | | 3 | XMIN Lowest X-axis label | IXMIN | | | | 4 | XMAX Highest Y-axis label | IXMAX | | | | 5 | YMIN Lowest Y-axis label | IYMIN | | | | 6 | YMAX Highest Y-axis label | IYMAX | | | | 7 | ZMIN Lowest Z value | ZMIN | | | | 8 | ZMAX Highest Z value | ZMAX | | | | | | | | | | 9 | 1000*IXMIN + IXMAX (Useful for ZOOM) | 1-NX | | +-+----10------+-1000*IYMIN-+-IYMAX-(Useful-for-ZOOM)-------------------------------+----1-NY--+-+ Figure: Example of HPLTAB with CONT option +-+--------------------------------------------------------------------------------------------+-+ +-+-CHOPT-=-'COL'-COLour-plot-------------------------------------------------------+----------+-+ +-+-PAR-index--+----------------------------PAR-values------------------------------+-default--+-+ | | 1 | 0 use the standard 8 colours | 0. | | | | 2 | Not used | | | | | 3 | ZMIN Lowest Z value | ZMIN | | | | 4 | ZMAX Highest Z value | ZMAX | | | | | | | | | | 5 | 1000*IXMIN + IXMAX (Useful for ZOOM) | 1-NX | | +-+-----6------+-1000*IYMIN-+-IYMAX-(Useful-for-ZOOM)-------------------------------+----1-NY--+-+ Figure: Example of HPLTAB with COL option +-+-CHOPT-=-'TEXT'-Table-(Text)----------------------------------------------------------------+-+ +-+------------+--------------------------------------------------------------------+----------+-+ +-+-PAR-index--+----------------------------PAR-values------------------------------+-default--+-+ | | 1 | Text font | 1. | | | | 2 | Text Precision | 0. | | | | 3 | ZMIN Lowest Z value | ZMIN | | | | 4 | ZMAX Highest Z value | ZMAX | | | | 5 | 1000*IXMIN + IXMAX (Useful for ZOOM) | 1-NX | | | | | | | | +-+-----6------+-1000*IYMIN-+-IYMAX-(Useful-for-ZOOM)-------------------------------+----1-NY--+-+ Figure: Example of HPLTAB with TEXT option +-+-CHOPT-=-'CHAR'-Character,-the-contains-is-one-single-character-----------------------------+-+ +-+------------+--------------------------------------------------------------------+----------+-+ +-+-PAR-index--+----------------------------PAR-values------------------------------+-default--+-+ | | 1 | Text font | 1. | | | | 2 | Text Precision | 0. | | | | 3 | ZMIN Lowest Z value | ZMIN | | | | 4 | ZMAX Highest Z value | ZMAX | | | | 5 | 1000*IXMIN + IXMAX (Useful for ZOOM) | 1-NX | | | | | | | | +-+-----6------+-1000*IYMIN-+-IYMAX-(Useful-for-ZOOM)-------------------------------+----1-NY--+-+ Figure: Example of HPLTAB with CHAR option +-+-CHOPT-=-'LEGO'-Lego-(mode-0)---------------------------------------------------------------+-+ | | | | | | CHOPT = 'LEGO1' Lego with colours (mode 1) | | +-+-CHOPT-=-'LEGO2'-Lego-with-colours-(mode-2)-------------------------------------------------+-+ | | CHOPT = 'SURF' Surface (mode 0) | | | | CHOPT = 'SURF1' Surface with colours (mode 1) | | | | CHOPT = 'SURF2' Surface with colours (mode 2) | | | | CHOPT = 'SURF3' Surface with contour plot on top (mode 3) | | | | | | +-+-CHOPT-=-'SURF4'-Surface-with-Gouraud-shading-(mode-4)--------------------------------------+-+ | | CHOPT = 'CYL' Cylindrical for lego and surface | | | | CHOPT = 'SPH' Spherical for lego and surface | | +-+-CHOPT-=-'PSD'-Pseudo-rapidity-for-lego-and-surface------------------------------+----------+-+ | | PAR index | PAR values | default | | +-+-----1------+-Theta--------------------------------------------------------------+-----30.--+-+ | | | | | | | | 2 | Phi | 30. | | | | 3 | ZMIN Lowest Z value | ZMIN | | | | 4 | ZMAX Highest Z value | ZMAX | | | | 5 | 1000*IXMIN + IXMAX (Useful for ZOOM) | 1-NX | | | | 6 | 1000*IYMIN + IYMAX (Useful for ZOOM) | 1-NY | | +-+------------+--------------------------------------------------------------------+----------+-+ Figure: Example of HPLTAB with LEGO option Figure: Example of HPLTAB with LEGO1 option Figure: Example of HPLTAB with LEGO2 option Figure: Example of HPLTAB with SURF option Figure: Example of HPLTAB with SURF1 option Figure: Example of HPLTAB with SURF2 option Figure: Example of HPLTAB with SURF3 option Figure: Example of HPLTAB with SURF4 option Figure: Example of HPLTAB with LEGOPOL option Figure: Example of HPLTAB with LEGOCYL option Figure: Example of HPLTAB with LEGOSPH option Figure: Example of HPLTAB with LEGOPSD option Figure: Example of HPLTAB with SURFPOL option Figure: Example of HPLTAB with SURFCYL option Figure: Example of HPLTAB with SURFSPH option Figure: Example of HPLTAB with SURFPSD option +--------------------+ |CALL HPLTIT (CHTIT) | +--------------------+ Action: Writes a title for a histogram instead of the HBOOK title. The user must also turn off the option for printing the HBOOK title by setting the option 'UTIT'. Parameter Description: CHTIT CHARACTER variable containing the title to be drawn (up to 80 characters). ' ' specifies that the HBOOK histogram title is to be used. Remarks: HPLTIT must be called after HPLOT. Before calling HPLOT for the histogram to be titled, HPLOPT must be called with the option 'UTIT' otherwise the HBOOK histogram title will also be printed. The position of the title may be changed with HPLSET and its parameter 'YHTI'. +------------------------------+ |CALL HPLUSR (ID, CHCASE, KID) | +------------------------------+ Action: This is an HPLOT User Routine. The user should not call it, but provide his own subroutine HPLUSR, which will be called after each histogram has been plotted. To avoid problems with unresolved external references, a dummy routine HPLUSR is provided in the HPLOT library. Parameter Description: ID Identifier of the histogram just plotted CHCASE CHARACTER variable specifying the type of histogram which has just been plotted: '1DIM' 1 dimensional histogram. '2DIM' 2 dimensional histogram. 'TABL' Table. '3DIM' 2 dimensional histogram or table plotted with routine HPLSUR. 'SLIX' Slice in X of a 2 dimensional histogram or table. 'SLIY' Slice in Y of a 2 dimensional histogram or table. 'BANX' Band in X of a 2 dimensional histogram or table. 'BANY' Band in Y of a 2 dimensional histogram or table. 'PROX' X projection of a 2 dimensional histogram or table. 'PROY' Y projection of a 2 dimensional histogram or table. KID Flag denoting how HPLUSR was invoked: 0 : invoked with call to HPLOT(0,,,). 1 : invoked with a specific histogram identifier ID. Remarks: HPLUSR is particularly useful when used in conjunction with HPLOT(0) as it allows to assign to every histogram the same axis titles, etc. Another use is to provide a printout of all histograms plotted. Many HBOOK and HPLOT subroutines can be called from HPLUSR, but some could give problems and the following routines can not be called from within HPLUSR: HPLOT, HPLINT, HPLEND, HPLPRO and HPLSUR. The option routine HPLOPT can be called from HPLUSR, but the plot size should not be changed (i.e. do not call HPLOPT with arguments 'HORI', 'VERT', 'A4', ...). Examples of the use of HPLUSR A simple example The user may require all histograms to have the same axis titles, but there be gaps in the numbering of the histogram identifiers ID, or one may not even know which identifiers are available. A DO loop involving calls to HPLOT(ID) and HPLAX is therefore difficult. HPLUSR can be used together with HPLOT(0,' ',' ',0) Using HPLUSR to have identical axes titles SUBROUTINE HPLUSR(ID,CHCASE,KID) CALL HPLAX('Momentum (GeV/c)','Time of flight(nsec)') END An example with zones It may sometimes be required to perform a different action for different zones. As an example suppose one issues the following calls (with no call to HPLZON inside HPLUSR): CALL HPLZON(2,2,1,' ') CALL HPLOT(0,' ',' ',0) Suppose also that for every histogram a comment must be written in the lower left hand corner (i.e. zone number 3 in our example): +--------+--------+ +--------+--------+ +---3----+--------+ SUBROUTINE HPLUSR(ID,CHCASE,KID) CHARACTER*(*) CHCASE DATA IWIN /0/ IWIN=IWIN+1 K=MOD(IWIN,4) . IF(K.EQ.3) CALL HPLCOM(......) END If the comment has to appear in the histogram box, HPLGIV could be used to return the coordinates of the histogram box. +----------------------------------------+ | CALL HPLWIR (CHOPT,XVAL, YVAL, CHTICK) | +----------------------------------------+ Action: Draws ``cross-wires'' on a picture, optionally with tick marks and values. In the present context cross-wires are lines perpendicular to the X and/or Y axis. Parameter Description: CHOPT CHARACTER variable specifying which cross-wires must be drawn and where to draw the values '' Tick marks are drawn on the edges of the picture. 'X' Cross-wire drawn perpendicular to the X-axis. 'Y' Cross-wire drawn perpendicular to the Y-axis. 'A' Value drawn Above cross-wire. 'B' Value drawn Below cross-wire. 'L' Value drawn at Left of cross-wire. 'R' Value drawn at Right of cross-wire. XVAL Intersection on the X-axis. YVAL Intersection on the Y-axis. CHTICK CHARACTER variable specifying whether tick marks are required ('TICK'). Remarks: HPLWIR must be called after HPLOT. The values of XVAL and YVAL are always histogram coordinates. The tick marks will be drawn on both sides of the cross-wire, unless the cross-wires are requested on the boundary of the box surrounding the histogram (i.e. at the extreme limits of the drawn histogram). In this case tick marks will only be drawn inside the box. The character options 'A' (Above) and 'B' (Below) refer only to the cross-wires perpendicular to the Y axis, e.g. CALL HPLWIR('YA',0.,3.14,'TICK') CALL HPLWIR('Y' ,0.,3.14,' ') In each case only one cross-wire will be drawn. Similarly the character options 'L' (Left) and 'R' (Right) refer only to the cross-wires perpendicular to the X-axis. 'A', 'B', 'L' and 'R' have no effect unless CHTICK='TICK' It is possible to redefine the length of the tick marks on the X or Y axis by calling HPLSET with XTIC or YTIC The position of the axis values may be changed with HPLSET (XVAL or YVAL). The number of divisions and tick marks may be changed with HPLSET (NDVX or NDVY). +------------------------------------+ |CALL HPLZOM (ID, CHOPT, IMIN, IMAX) | +------------------------------------+ Action: Plots a 1 dimensional histogram between two channel numbers. Parameter Description: ID Identifier of a 1=dimensional histogram. CHOPT Options (as for routine HPLOT). IMIN First channel to be plotted. If IMIN<=0, then IMIN is assumed to be 1. IMAX Last channel to be plotted. If IMAX is greater than the number of channels, then IMAX is taken equal to the number of channels. +------------------------------------------+ |CALL HPLZON (NXZON, NYZON, IFIRST, CHOPT) | +------------------------------------------+ Action: Splits the picture into smaller parts, called zones. A complete histogram can be drawn in one of these zones. Parameter Description: NXZON Number of zones in the X direction. NYZON Number of zones in the Y direction IFIRST First zone to be plotted. A value of zero is equivalent to 1 and the first zone is selected. CHOPT CHARACTER variable specifying the options desired. 'S' Redefine zones on the same picture. '' The next call to HPLOT will start a new picture. If both NXZON and NYZON are zero, then they are set to 1, if both NYZON are reset to 1 and the zone option is turned off. Remarks: Zones are numbered from left to right, starting at the top of the picture. For example with CALL HPLZON(3,2,1,' ') the zones are numbered as follows: +---------+--------+---------+ | | | | | 1 | 2 | 3 | +---------+--------+---------+ | | | | | 4 | 5 | 6 | +---------+--------+---------+ The zone number is automatically incremented with each HPLOT call unless reset by a further call to HPLZON. If the zone number becomes larger than the maximum allowed on a picture, then the next histogram plotted will be at zone position 1 on a new picture. For example, assuming histograms 101 to 110 are 1 dimensional, then the following code: CALL HPLZON(3,2,1,' ') DO 10 I=101,110 10 CALL HPLOT(I,' ',' ',0) gives: +---------+--------+---------+ +---------+--------+---------+ | | | | | | | | | 101 | 102 | 103 | | 107 | 108 | 109 | +---------+--------+---------+ +---------+--------+---------+ | | | | | | | | | 104 | 105 | 106 | | 110 | | | +---------+--------+---------+ +---------+--------+---------+ and a further call to HPLOT will start plotting below histogram 108. It is important to understand the difference between the effects of the 'S' options of HPLZON and HPLOT. The 'S' option of HPLOT allows histograms to be superimposed without redrawing axes or titles. The 'S' option of HPLZON allows the zone options to be reset on the current picture, and the next HPLOT call will plot a histogram complete with axes and titles. The 'S' option of HPLZON is normally used when plotting different sized zones on the same plot, or when forcing a histogram into a particular zone. Different sized zones can be plotted together on one picture with a series of HPLZON and HPLOT calls, all but the first containing the 'S' parameter in HPLZON. +--------+---------+ | | | CALL HPLZON(2,2,2,' ') | | 100 | CALL HPLOT(100,' ',' ',0) | | | For example: CALL HPLZON(2,2,4,'S'will give: | 102 +---------+ CALL HPLOT(101,' ',' ',0) | | | CALL HPLZON(2,1,1,'S') | | 101 | CALL HPLOT(102,' ',' ',0) +--------+---------+ This example also illustrates how one can force a histogram into a particular zone. To terminate the zone option: CALL HPLZON(1,1,1,' ') The next HPLOT call will start on a new picture. For scatter plots remember that: CALL HPLOT(ID,' ',' ',0) will give several pictures if slices/bands/projections are present. The above remarks must be read with this in mind. Note that routine HPLZON must be called after HPLOPT if the options 'A3', 'A4', 'HORI' or 'VERT' are being requested and also after a call to HPLSET which defines the margin. The distance between zones can be redefined using routine HPLSET and its options XWIN and YWIN.