ncl_hstopc(3)

1HSTOPC(3NCARG)                   NCAR GRAPHICS                  HSTOPC(3NCARG)
2
3
4

NAME

6       HSTOPC - Specifies various CHARACTER variables to be used by the
7       Histogram utility.
8

SYNOPSIS

10       CALL HSTOPC (STRING,STRNG2,NUMBER,ILCH)
11

C-BINDING SYNOPSIS

13       #include <ncarg/ncargC.h>
14
15       void c_hstopc (char *string, char *strng2, int number,
16       int ilch)
17

DESCRIPTION

19       STRING      Character, input -- Selects an internal parameter.  The
20                   possibilities are:
21
22                     ´FOR=ON´ or ´FOR=OFF´
23                     ´TIT=ON´ or ´TIT=OFF´
24                     ´LAB=ON´ or ´LAB=OFF´
25                     ´PTI=ON´ or ´PTI=OFF´
26                     ´FQN=ON´ or ´FQN=OFF´
27                     ´CHR=ON, or ´CHR=OFF´
28
29                   If an option is turned ´ON´ then the STRNG2, NUMBER, and
30                   ILCH arguments can be used to override the default settings
31                   of that option.
32
33                   If the value of a STRING option is ´OFF´ then the next
34                   three arguments of the HSTOPC call can be any dummy value.
35                   Option settings will be returned to their default values.
36
37                   The following options are defined by this subroutine:
38
39                   FOR     Format for class labels.  The ´FOR=OFF´ default is
40                            ´(G10.3)´. Although class values are real numbers,
41                           integer formats are allowed, in which case HISTGR
42                           will convert from real to integer before plotting
43                           labels.
44
45                   TIT     A main title of up to 96 characters.  Only 45
46                           characters are written per line so up to 3 lines
47                           may be written.  The ´TIT=OFF´ default is no title.
48
49                   LAB     A label for the class interval (histogram bar)
50                           axis.  The ´LAB=OFF´ default value is ´CLASS
51                           INTERVALS´ when the HSTOPL option ´MID=OFF´ is
52                           selected, and ´CLASS MIDVALUES´ when ´MID=ON´.
53
54                           In order to delete this axis label, select ´LAB=ON´
55                           for STRING and ´NOLABEL´ for STRNG2.
56
57                   PTI     The percent axis label.  Default value when
58                           ´PTI=OFF´ is ´PERCENT OCCURRENCE´ when IFLAG = 0,
59                           or 1, and ´PERCENT of MAXIMUM´ when IFLAG = 2, or
60                           3.
61
62                   FQN     The frequency axis label.  The ´FQN=OFF´ default
63                           value is ´FREQUENCY´.
64
65                           In order to delete this axis label, select ´FQN=ON´
66                           for STRING and ´NOLABEL´ for STRNG2.
67
68                   CHR     A concatenated string of alphanumeric class
69                           interval labels.  The default value is a set of
70                           internally computed numeric class labels.
71
72       STRNG2      Character, input -- A string of up to 45 characters.
73
74                    ´FOR=ON´, STRNG2 is a format for the class labels.
75
76                    ´TIT=ON´, STRNG2 is a histogram main title.
77
78                    ´LAB=ON´, STRNG2 is a label for the class interval axis.
79
80                    ´PTI=ON´, STRNG2 is a label for the percentage axis.
81
82                    ´FQN=ON´, STRNG2 is a label for the frequency axis.
83
84                    ´CHR=ON´, STRNG2 is a concatenated string of class labels.
85
86                   The length of this character string will be NUMBER*ILCH,
87                   where NUMBER is the number of class intervals and ILCH is
88                   the number of characters in the interval label.
89
90       NUMBER      Integer, input -- It only applies to the following options:
91
92                    ´FOR=ON´, NUMBER specifies the maximum number of class
93                   intervals (histogram bars) that will be labeled.  The
94                   default values (´FOR=OFF´) are 9 labels for vertical bars
95                   and 15 labels for horizontal bars.
96
97                    ´CHR=ON´, NUMBER must be set to NCLASS, an argument of the
98                   next call to be made to routine HISTGR.
99
100                   NUMBER is not used under any other option setting.
101
102                   Calls to HSTOPC with either ´FOR=ON´ or ´CHR=ON´ may be
103                   performed in any order; the parameters set by NUMBER are
104                   mutually exclusive.
105
106       ILCH        Integer, input -- It only applies in the following
107                   instance.
108
109                   If ´CHR=ON´, ILCH specifys the number of characters in each
110                   label of a class interval (histogram bar).   ILCH cannot be
111                   greater than 15.
112

C-BINDING DESCRIPTION

114       The C-binding argument descriptions are the same as the FORTRAN
115       argument descriptions.
116

USAGE

118       HSTOPC is called to set parameters of type CHARACTER before entry
119       HISTGR is called to generate the histogram.  Options are main and axes
120       titles, class interval (bar) labels, and class interval formats.
121
122       For a complete list of parameters available in this utility, see the
123       histogram_params man page.
124

EXAMPLES

126       Use the command "ncargex thstgr" to generate a three frame example of
127       histogram options.  The following code causes the second frame to have
128       a class interval axis of 12 intervals, each with a 3 character label
129       that specifies a month of the year.
130
131       PARAMETER (NCLASS=12, ILCH=3)
132       CHARACTER*55 MON
133       MON=´JANFEBMARAPRMAYJUNJULAUGSEPOCTNOVDEC´
134       CALL HSTOPC(´CHR=ON´,MON,12,3)
135
136       Example  "ncargex thstmv" shows three examples of histograms with
137       missing values in the input data.
138

ACCESS

140       To use HSTOPC or c_hstopc, load the NCAR Graphics libraries ncarg,
141       ncarg_gks, and ncarg_c, preferably in that order.
142

MESSAGES

144       See the histogram man page for a description of all Histogram error
145       messages and/or informational messages.
146

COPYRIGHT

154       Copyright (C) 1987-2009
155       University Corporation for Atmospheric Research
156       The use of this Software is governed by a License Agreement.
157
158
159
160UNIX                              March 1993                    HSTOPC(3NCARG)