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

NAME

6       CPCLAM - Adds contour lines to an area map. This is part of the process
7       of drawing a solid-fill contour plot.
8

SYNOPSIS

10       CALL CPCLAM (ZDAT, RWRK, IWRK, IAMA)
11

C-BINDING SYNOPSIS

13       #include <ncarg/ncargC.h>
14
15       void c_cpclam (float *zdat, float *rwrk, int *iwrk,
16       int *iama)
17

DESCRIPTION

19       The first three arguments are arrays used in the last call to CPRECT,
20       CPSPS1, or CPSPS2, the contents of which must not have been changed
21       since that call.
22
23       ZDAT        (REAL array, dimensioned as specified in the last call to
24                   CPRECT, CPSPS1, or CPSPS2, input) is the data array.
25
26       RWRK        (REAL array, dimensioned as specified in the last call to
27                   CPRECT, CPSPS1, or CPSPS2, input/output) is the real
28                   workspace array.
29
30       IWRK        (INTEGER array, dimensioned as specified in the last call
31                   to CPRECT, CPSPS1, or CPSPS2, input/output) is the integer
32                   workspace array.
33
34       IAMA        (INTEGER array, dimensioned as specified in a call to
35                   ARINAM, in the package Areas) is the array containing the
36                   area map to which contour lines are to be added.
37

C-BINDING DESCRIPTION

39       The C-binding argument descriptions are the same as the FORTRAN
40       argument descriptions.
41

USAGE

43       The routine CPCLAM, which adds contour lines generated from the data in
44       the array ZDAT to the area map in the array IAMA, may be called at any
45       time after the initialization call to CPRECT, CPSPS1, or CPSPS2. The
46       area map must previously have been initialized by a call to the routine
47       ARINAM in the utility Areas.
48
49       The contour lines added to the area map are as specified by the first
50       'NCL' elements of the parameter arrays 'CLV', 'AIA', and 'AIB'. If
51       'NCL' is zero, CPPKCL is called to generate these values.
52
53       The contour levels defined by the first 'NCL' elements of the parameter
54       array 'CLV' are examined.  If a given contour level is associated with
55       a non-zero value of 'AIA' and/or a non-zero value of 'AIB', then
56       contour lines at that contour level are added to the area map.  If
57       there is an associated non-zero value of 'AIA', it is used as the area
58       identifier for the area "above" the line (where field values are
59       greater than they are along the line); otherwise, a zero is used.  If
60       there is an associated non-zero value of 'AIB', it is used as the area
61       identifier for the area "below" the line (where field values are less
62       than they are along the line); otherwise, a zero is used.  Note that a
63       given contour level may occur more than once in the internal parameter
64       array 'CLV', but there must be at most one non-zero value of 'AIA' and
65       at most one non-zero value of 'AIB' associated with it; otherwise, an
66       error exit occurs.
67
68       If the parameter 'T2D' has a non-zero value, the contour lines are
69       smoothed, using cubic splines under tension.
70
71       Four other types of lines are added to the area map by CPCLAM: (1) the
72       edge of the current viewport and possibly a set of vertical lines
73       within the viewport, (2) the edge of the grid, (3) the edges of
74       special-value areas, if any, and (4) the edges of out-of-range areas,
75       if any. The area identifier for the outside of the viewport is always
76       -1. You can use elements of the parameter array 'AIA' for 'PAI' = -1,
77       -2, and -3 to specify the area identifiers to be used for the outside
78       of the grid, the inside of a special-value area, and the inside of an
79       out-of-range area, respectively; the default values of all three are
80       -1's. Area identifiers for all other sides of these edges are
81       determined from the area-identifier information given for the contour
82       levels.
83
84       Lines are added to the area map in the following order:
85
86       ·  the edge of the viewport and the vertical lines within it,
87
88       ·  the edges of the out-of-range areas, if any,
89
90       ·  the edge of the grid,
91
92       ·  the edges of the special-value areas, if any, and,
93
94       ·  the contour lines, in order of increasing contour level.
95
96       The edge of the viewport may actually be added to the area map twice:
97
98       ·  as part of the edge group with group identifier 'GIC', and
99
100       ·  as part of the edge group with group identifier 'GIS'.
101
102       Vertical lines, if any, are added with group identifier 'GIS'.
103
104       The object of the edge group with group identifier 'GIS' is to break up
105       the areas represented by the area map into smaller pieces. Whether this
106       is done or not is under your control, by means of the internal
107       parameters 'NVS' and 'GIS'.  For more information, see the descriptions
108       of those internal parameters in the conpack_params man page.
109
110       If, during the last call to CPRECT, CPSPS1 or CPSPS2, the data being
111       contoured were found to be essentially constant, then no contour lines
112       are added to the area map; the other lines are added, however.
113

EXAMPLES

115       Use the ncargex command to see the following relevant examples:
116       ccpcldm, ccpfil, ccplbam, ccpllb, ccpllc, ccplll, ccpllo, ccpllp,
117       ccpllt, ccpllw, ccppc, ccppc1, ccppc2, ccppc3, ccppc4, ccppole, ccprc,
118       ccpscam, ccpt2d, ccpvs, colcon, cpex01, cpex02, cpex03, cpex04, cpex05,
119       cpex07, cpex08, vvex01, tconpa, fsfsgfa.
120

ACCESS

122       To use CPCLAM or c_cpclam, load the NCAR Graphics libraries ncarg,
123       ncarg_gks, and ncarg_c, preferably in that order.
124

MESSAGES

126       See the conpack man page for a description of all Conpack error
127       messages and/or informational messages.
128

SEE ALSO

130       Online: conpack, cpback, cpchcf, cpchcl, cpchhl, cpchil, cpchll,
131       cpcica, cpcldm, cpcldr, cpcltr, cpcnrc, cpdrpl, cpezct, cpgetc, cpgeti,
132       cpgetr, cplbam, cplbdr, cpmpxy, cpmviw, cpmvrw, cppkcl, cppklb, cprect,
133       cprset, cpscae, cpsetc, cpseti, cpsetr, cpsps1, cpsps2, ncarg_cbind
134
135       Hardcopy: NCAR Graphics Contouring and Mapping Tutorial
136
138       Copyright (C) 1987-2007
139       University Corporation for Atmospheric Research
140
141       This documentation is free software; you can redistribute it and/or
142       modify it under the terms of the GNU General Public License as
143       published by the Free Software Foundation; either version 2 of the
144       License, or (at your option) any later version.
145
146       This software is distributed in the hope that it will be useful, but
147       WITHOUT ANY WARRANTY; without even the implied warranty of
148       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
149       General Public License for more details.
150
151       You should have received a copy of the GNU General Public License along
152       with this software; if not, write to the Free Software Foundation,
153       Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
154
155
156
157
158UNIX                              March 1993                    CPCLAM(3NCARG)
Impressum