1HSTOPR(3NCARG) NCAR GRAPHICS HSTOPR(3NCARG)
2
6 HSTOPR - Specifies various REAL arrays to be used by the the Histogram
7 utility.
8
10 CALL HSTOPR (STRING,ARRAY,LARR)
11
13 #include <ncarg/ncargC.h>
14 void c_hstopr (char *string, float *array, int larr)
16
18 STRING Character, input -- Selects an internal parameter. The
19 possibilities are:
20 ´WIN=ON´ or ´WIN=OFF´
22 ´SPA=ON´ or ´SPA=OFF´
23 ´MVA=ON´ or ´MVA=OFF´
24 WIN defines the portion of the frame that will receive the
26 histogram. SPA determines the spacing between histogram
27 bars. MVA requests a test to detect input special values
28 which denote missing data.
29 ARRAY Real, input -- It has a different use depending upon which
31 parameter is specified by argument STRING. See the
32 examples following argument LARR.
33 LARR Integer, input -- Dimension of ARRAY.
35 The following arrays may be defined by this routine:
37 Windowing:
39 STRING is ´WIN=ON´
41 LARR = 4
42 ARRAY(1) = XMIN
43 ARRAY(2) = XMAX
44 ARRAY(3) = YMIN
45 ARRAY(4) = YMAX
46 These coordinates define a rectangular region of the total
48 frame in NDC´s where the current histogram is to be
49 plotted. The range of allowed values is between 0. and 1.
50 in both dimensions.
51 For example, XMIN=0., XMAX=.5, YMIN=.5, and YMAX=1. would
53 specify the upper left quadrant of the frame.
54 IF ´WIN=OFF´, the default window for the histogram will be
56 the entire frame. Spacing:
57 STRING is ´SPA=ON´
59 LARR = 2
60 ARRAY(1) = SPAC
61 ARRAY(2) = OVERLP
62 SPAC determines the spacing of histogram bars between 0.
64 (no spacing) and 4. (maximum spacing). Default spacing is
65 SPAC = 2.0.
66 OVERLP determines the overlap of adjacent histogram bars
68 when two datasets are compared. Valid values are -4.0
69 (maximum overlap) to 4.0 (little or no overlap). The
70 Default is 0.
71 When STRING = ´SPA=OFF´, there is no spacing or overlap.
73 Detecting missing values:
74 STRING is ´MVA=ON´
76 LARR = 2
77 ARRAY(1) = SETMVA
78 ARRAY(2) = SETEPS
79 SETMVA is the special value used to denote missing data.
81 The default value is -9999.
82 SETEPS is an epsilon to use in the special value test. If
84 the difference between a data point and SETMVA is less than
85 SETEPS, then the data point is assumed to be a missing
86 value. The Default is 1.E-10.
87 When STRING = ´MVA=OFF´, there is no testing for missing
89 values.
90
92 The C-binding argument descriptions are the same as the FORTRAN
93 argument descriptions.
94
96 HSTOPR is called to set parameters of type REAL before entry HISTGR is
97 called to generate the histogram. Options are the portion of the frame
98 to receive the graphic, and the amount of spacing and overlap of
99 histogram bars.
100 For a complete list of parameters available in this utility, see the
102 histogram_params man page.
103
105 Use the command "ncargex thstgr" to generate a three frame example of
106 histogram options. The following code defined the window and bar
107 spacing of plot 1 on frame 3.
108 C
109 C Plot 1 goes into the top left quadrant of the frame.
110 C
111 C ARR7 coordinates are XMIN, XMAX, YMIN, YMAX.
112 C
113 ARR7(1) = 0.
114 ARR7(2) = .5
115 ARR7(3) = .5
116 ARR7(4) = 1.
117 CALL HSTOPR(´WIN=ON´,ARR7,4)
118 C
119 SPAC(1) = 3.0
120 SPAC(2) = 0.0
121 CALL HSTOPR(´SPA=ON´,SPAC,2)
122 Example "ncargex thstmv" shows three examples of histograms with
124 missing values in the input data.
125
127 To use HSTOPR or c_hstopr, load the NCAR Graphics libraries ncarg,
128 ncarg_gks, and ncarg_c, preferably in that order.
129
131 See the histogram man page for a description of all Histogram error
132 messages and/or informational messages.
133
135 Online: histogram, histogram_params, hstopc, hstopi, hstopl,
136 ncarg_cbind
137 Hardcopy: NCAR Graphics Fundamentals, UNIX Version
139
141 Copyright (C) 1987-2009
142 University Corporation for Atmospheric Research
143 The use of this Software is governed by a License Agreement.
144UNIX March 1993 HSTOPR(3NCARG)