Cp 10. Conpack parameter descriptions

Previous Chapter          Tutorial Home          Index

AIA

Integer array---Area Identifier Above. Each element of the parameter array AIA is an area identifier for the area above the contour level specified by the corresponding element of the parameter array CLV. The corresponding element of the parameter array AIB is an area identifier for the area below that level. If, for a particular contour level, both AIA and AIB are zero, that level is ignored by the CPCLAM routine; otherwise, contour lines at that level are added to the area map and the given values of AIA and AIB are used as left and right area identifiers.

There are three special elements in the parameter array AIA, corresponding to PAI values of 1, 2, and 3:

-----------------------------------------------
PAI  AIA                                         
-----------------------------------------------
-1   Specifies an area identifier for the area   
     outside the edge of the grid.               
-2   Specifies an area identifier for any area   
     filled with special values.                 
-3   Specifies an area identifier for any area   
     in which the mapping routine CPMPXY         
     returns the out-of-range value ORV.         
-----------------------------------------------

If contour levels are chosen automatically, rather than being supplied by you, the value supplied for the Ith element of AIA is I+1 and the value supplied for the Ith element of AIB is I.

Default: See description above.

AIB

Integer array---Area Identifier Below. See the description of AIA.

Default: See description of AIA.

CAF

Integer---Cell Array Flag. CAF determines the way in which the routine CPCICA (which is called to store color indices in a user cell array) gets from an area identifier associated with a particular cell to a color index for that cell. Let IAID be the area identifier that is associated with a given cell; then for CAF values of:

<0 The routine CPSCAE is called. The default version of CPSCAE behaves as follows: if IAID>=0, the value of IAID is stored in the cell array as as a color index; if IAID<0, the cell array is unchanged. A user version of CPSCAE may be supplied to do something more complicated; since the value of CAF is one of the arguments of CPSCAE, its value may be used to select one of a number of color-setting schemes built into the routine.

>=0 The value CAF+IAID is computed. If that value is greater than or equal to zero, it is stored in the cell array as a color index; otherwise the cell array is unchanged. In this case, CAF acts as an offset, mapping the area identifiers to a unique portion of the color table.

Default: 0

CFA

Real---Constant Field label Angle. CFA specifies the angle (in degrees counterclockwise from a vector pointing to the right) at which a constant field label is to be written.

Default: 0.

CFB

Integer---Constant Field label Box flag.

0 Constant field label is not boxed at all. This is the default.

1 Perimeter of the box is drawn (in the same color as the label) after the label is drawn.

2 Box is filled (in the color specified by LBC) before the label is drawn.

3 Both 1 and 2 above.

CFC

Integer---Constant Field label Color index.

<0 Constant field label and the box around it (if any) are drawn in the color specified by the current text color index.

>=0 Specifies the desired color index for the label and the box. If a box is drawn around the label, it is made the same color as the label itself.

Default: -1

CFF

Integer---Constant Field Found flag. CFF may not be set by you; its retrieved value will be nonzero if and only if CPRECT, CPSPS1, or CPSPS2 detected a constant field.

Default: 0 (prior to any call to CPRECT, CPSPS1, or CPSPS2)

CFL

Real---Constant Field label Line width.

<=0. Line width is not set before drawing a box around the constant field label.

>0. Specifies the desired width, as a multiple of the normal line width.

Default: 0.

CFP

Integer---Constant Field label Positioning flag. CFP determines how the constant field label is to be positioned. There are nine possible values, each of which specifies a point of the label box that is to lie on the point defined by CFX and CFY:

-4 Lower left corner of label box.

-3 Center of bottom of label box.

-2 Lower right corner of label box.

-1 Center of left edge of label box.

0 Center of label box. This is the default.

+1 Center of right edge of label box.

+2 Upper left corner of label box.

+3 Center of top edge of label box.

+4 Upper right corner of label box.

Left, right, bottom, and top are defined from the viewpoint of someone reading the label right side up.

CFS

Real---Constant Field label Size. CFS specifies the nominal size (width) of a character in the constant field label, as a fraction of the width of the viewport. This nominal size is multiplied by CWM.

Default: .012

CFT

Character expression---Constant Field label Text string. CFT specifies the text of the constant field label, which is written when a constant data field is detected; it is a character string of 40 characters or less. The embedded string '$ZDV$' will be replaced by the numeric value of the field.

If CFT is given the value ' ', (a single blank), the constant field label will not be written.

Default: 'CONSTANT FIELD - VALUE IS $ZDV$'

CFW

Real---Constant Field label White space width. CFW specifies the nominal width of white space to be left around the constant field label, as a fraction of the width of the viewport. This nominal width is multiplied by CWM.

Default: .005

CFX

Real---Constant Field label X coordinate. CFX specifies the X coordinate of the basepoint of the constant field label. The given value is mapped linearly onto the viewport:

<0. Beyond the left edge of the viewport.

0. Left edge of the viewport.

0.<CFX<1.
Between the left edge and the right edge of the viewport.

1. Right edge of the viewport.

>1. Beyond the right edge of the viewport.

Default: .5 (centered horizontally in the viewport)

CFY

Real---Constant Field label Y coordinate. CFY specifies the Y coordinate of the basepoint of the constant field label. The given value is mapped linearly onto the viewport:

<0. Below the bottom edge of the viewport.

0. Bottom edge of the viewport.

0.<=CFY<=1.
Between the bottom edge and the top edge of the viewport.

1. Top edge of the viewport.

>1. Above the top edge of the viewport.

Default: .5 (centered vertically in the viewport)

CIS

Real---Contour Interval Specifier. See the description of CLS. When CLS>0, CIS is used.

<=0. Conpack is to choose the contour interval. (See also the description of the parameter arrays CIT and LIT).

>0. The actual contour interval to be used; in this case, LIS may be given a nonzero value n to specify that every nth contour level should be labeled. See also the descriptions of CMN and CMX.

Default: 0.

CIT

Real array---Contour Interval Table. Each nonzero element of the ten-element parameter array CIT is a real number greater than or equal to 1. and less than 10. When Conpack picks the contour interval, it chooses a number of the form "c x 10k ", where c is one of the elements of CIT and k is an integer. The nonzero elements of CIT must be sorted in ascending order, and they must appear at the beginning of the array.

CIT and LIT are used together. Each element of CIT specifies a set of contour levels that may be used, and the corresponding element of LIT specifies which of those levels are to be labeled. A contour at "nc x 10k " is labeled if n is a multiple of l, where l is the element of LIT corresponding to the element c of CIT. For example, if the first element of CIT is 1. and the first element of LIT is 5, then Conpack is allowed to use contour levels 1., 2., 3., 4., etc., with labels at 5., 10., 15., 20., etc. (1. x 5, 2. x 5, etc.).

The default contents of CIT and LIT are:

-------------
PAI  CIT  LIT  
-------------
1    1.0  5    
2    2.0  5    
3    2.5  4    
4    4.0  5    
5    5.0  5    
6    0.0  0    
7    0.0  0    
8    0.0  0    
9    0.0  0    
10   0.0  0    
-------------

CIU

Real---Contour Interval Used. CIU is normally intended for output only. When the selection of the contour interval is left up to Conpack, CIU gets the value it chooses. When contour levels are completely set by you, the value of CIU should be set as well, for two reasons:

To make the desired value appear in an information label (in place of the embedded string '$CIU$')

So that it may be used by the penalty scheme for positioning labels

CIU must be set after the contour levels are set. (As a side effect of setting element 1 of CLV, CIU is set to zero.) If you supply contour levels, but do not set the value of CIU, and the penalty scheme is used to position labels, the required contour interval is estimated. In certain situations, this can cause problems (if, for example, the same contour level appears twice in CLV, once to force lines at that level to be drawn and once to force that level to be used as the boundary for a shaded area).

Default: 0.

CLC

Integer array---Contour Line Color index. Each element of the parameter array CLC, if greater than or equal to zero, is a color index for contour lines at the level specified by the associated element of CLV. CLC values less than zero imply that the lines will be drawn in the color specified by the current polyline color index. There are three special elements in the array CLC, corresponding to PAI values of 1, 2, and 3:

---------------------------------------------
PAI  CLC                                       
---------------------------------------------
-1   Specifies a color index for the edge of   
     the grid.                                 
-2   Specifies a color index for the edge of   
     any area filled with special values.      
-3   Specifies a color index for the edge of   
     any area in which the mapping routine     
     CPMPXY returns the out-of-range           
     value ORV.                                
---------------------------------------------

Default value of each element of CLC: -1

CLD

Character array---Contour Line Dash pattern. Each element of the parameter array CLD is a dash pattern (as expected by the Dashline utility) to be used, when DPU is nonzero, to draw contour lines at the level specified by the associated element of the contour level array CLV. Elements of CLD may be set using a call to CPSETI, with a 16-bit integer as the second argument, or using a call to CPSETC, with a character string of 32 or fewer characters as the second argument. In either case, the result will be a character string internally.

There are three special elements in the parameter array CLD, corresponding to PAI values of 1, 2, and 3:

----------------------------------------------
PAI  CLD                                        
----------------------------------------------
-1   Specifies a dash pattern for the edge of   
     the grid.                                  
-2   Specifies a dash pattern for the edge of   
     any area filled with special values.       
-3   Specifies a dash pattern for the edge of   
     any area in which the mapping routine      
     CPMPXY returns the out-of-range            
     value ORV.                                 
----------------------------------------------

When Conpack picks the contour levels, the default value supplied for each associated dash pattern is the character constant '$$$$$$$$$$$$$$$$'. This is also the default value for each of the three special elements.

Default: '$$$$$$$$$$$$$$$$'

CLL

Real array---Contour Line Line width. Each element of the parameter array CLL specifies the line width used to draw contour lines at the level specified by the associated element of the contour level array CLV. Each is expressed as a multiple of the normal line width; values less than or equal to zero imply that line width should not be set.

There are three special elements in the parameter array CLL, corresponding to PAI values of 1, 2, and 3:

--------------------------------------------
PAI  CLL                                      
--------------------------------------------
-1   Specifies a line width for the edge of   
     the grid.                                
-2   Specifies a line width for the edge of   
     any area filled with special values.     
-3   Specifies a line width for the edge of   
     any area in which the mapping routine    
     CPMPXY returns the out-of-range          
     value.                                   
--------------------------------------------

When Conpack picks the contour levels, the default value supplied for each associated line width is 0. This is also the default value for each of the three special elements.

Default: See description above.

CLS

Integer---Contour Level Selection flag. CLS specifies how contour levels are to be selected. Set the value of CLS before calling CPRECT, CPSPS1, or CPSPS2, as follows:

0 Conpack will not pick contour levels at all; the current values of the parameters NCL, CLV, and associated arrays will not be changed. They will thus retain the values chosen by Conpack during a previous call or the values supplied by you.

-n Conpack will generate n contour levels, splitting the range from the minimum field value to the maximum field value into n+1 equal intervals.

+n If CIS is less than or equal to zero, Conpack will use values of the form b*k, where b is a base value chosen by Conpack and k is an integer. The base value b will be a nice value (as defined by the contents of the parameter array CIT), chosen in such a way as to give at least n contour levels (with the default contents of the array CIT, you may get as many as 2n levels).

If CIS>0 and CMN>CMX, Conpack will use values of the form CIS*k, where k is an integer.

If CIS>0 and CMN<=CMX, Conpack will use values of the form CMN+CIS*k which are greater than or equal to CMN and less than or equal to CMX, where k is an integer.

Default: 16

CLU

Integer array---Contour Level Use flags. Each element of the parameter array CLU indicates how the associated contour level, in the parameter array CLV, is to be used.

0 No contour line is to be drawn at the associated level.

1 The line is to be drawn without labels.

2 The labels are to be drawn, but not the line.

3 Both the line and the labels are to be drawn.

There are three special elements in the parameter array CLU, corresponding to PAI values of 1, 2, and 3:

------------------------------------------
PAI  CLU                                    
------------------------------------------
-1   Specifies a flag for the edge of the   
     grid.                                  
-2   Specifies a flag for the edge of any   
     area filled with special values.       
-3   Specifies a flag for the edge of any   
     area in which the mapping routine      
     CPMPXY returns the out-of-range        
     value.                                 
------------------------------------------

In each case, if the flag is zero, the associated edge is not drawn; otherwise, the associated edge is drawn.

When Conpack chooses the contour levels, the associated elements of CLU are given one of the values 1 or 3, depending on whether the line is to be labeled or not. The default values of the special elements are all zeros.

Default: See description above.

CLV

Real array---Contour Level Values. Each of the first NCL elements of the parameter array CLV is a contour level for which something is to be done, such as the drawing of contour lines, the drawing of contour labels, and/or the addition of contour lines to an area map.

Only elements 1 through NCL may be accessed via the parameter-setting routines. Thus, code to set the contour levels and associated quantities must begin with a call to set NCL.

A side effect of setting the element numbered PAI of CLV is that the associated element number PAI in each of the parameter arrays AIA, AIB, CLC, CLD, CLL, CLU, LLC, and LLT is also given a default value. These values are as follows:

-------------------------------
Parameter  Default value         
-------------------------------
AIA        PAI+1                 
AIB        PAI                   
CLC        -1.                   
CLD        $$$$$$$$$$$$$$$$      
CLL        0.                    
CLU        1                     
LLC        -1                    
LLT        ' ' (a single blank)  
-------------------------------

Thus, in code to set contour levels and associated quantities, each contour level must be set before the quantities associated with it.

A side effect of setting element number 1 of CLV is that the CIU parameter, which indicates what contour interval was used, is set to zero. It is assumed that this will only happen when you are providing all the contour levels, in which case the concept of the contour interval may or may not be well defined. See the description of CIU for more information.

Default: See description above.

CMN

Real---Contour MiNimum. When CLS>0 and CIS>0, if CMN<=CMX, then the contour levels used will be CMN, CMN+CIS, CMN+2*CIS, ..., CMN+n*CIS, where n is the largest integer such that CMN+n*CIS<=CMX. The labeled levels will be those for which n is a multiple of LIS.

Default: 1.

CMX

Real---Contour MaXimum. See CMN, above.

Default: 0.

CTM

Character expression---Character TeMporary. The parameter name CTM refers to a temporary character buffer in Conpack; CTM may be used in the CPCHCL routine to get the dash pattern for the current line and in the CPCHHL, CPCHIL, and CPCHLL routines to get the text of the label being written or to change it.

Default: None

CWM

Real---Character Width Multiplier. All character size parameters are multiplied by CWM; this makes it easy to scale the sizes up or down simultaneously. This affects the parameters:

-----------------------
 CFS  DPS  HLS  ILS  LLS  
 CFW  DPV  HLW  ILW  LLW  
-----------------------

Default: 1.

DPS

Real---Dash Pattern Size. DPS specifies the nominal size (width) of a character in a dash pattern, as a fraction of the width of the viewport. This nominal size is multiplied by CWM.

Default: .010

DPU

Integer---Dash Pattern Use flag.

<=0 No dash patterns are used. Contour lines are drawn using calls to CURVE.

n>0
Dash patterns are used. Contour lines are drawn using calls to CURVED. When ABS(LLP)=1, contour lines are caused to be labeled by using a dash pattern formed by concatenating n repetitions of the appropriate element of CLD (the nominal dash pattern for the line) and the appropriate element of LLT (the numeric label for the line); in this case, DPU specifies the value of n.

Default: 3

DPV

Real---Dash Pattern Vector length. DPV specifies the nominal length of the solid vector generated by a dollar sign, or the gap vector generated by an apostrophe, in a dash pattern, as a fraction of the width of the viewport. This nominal length is multiplied by CWM.

Default: .005

GIC

Integer---Group Identifier for Contour lines. GIC specifies the group identifier for contour lines added to an area map by the CPCLAM routine.

Default: 3

GIL

Integer---Group Identifier for Label boxes. GIL specifies the group identifier for label boxes added to an area map by the CPLBAM routine.

Default: 3

GIS

Integer---Group Identifier for vertical Strips. GIS specifies the group identifier for a group of edges added to an area map by the CPCLAM routine in order to create a set of vertical strips. This is done only if the NVS parameter is nonzero. See NVS, below.

Default: 4

HCF

Integer---Hachuring Flag. HCF specifies the type of hachuring to be used, as follows:

0 Hachuring is turned off. This is the default.

1 All contours will be hachured.

2 Closed contours will be hachured only if the interior of the contour is "downhill." Open contours will be unconditionally hachured.

3 Closed contours will be hachured only if the interior of the contour is "downhill." No open contours will be hachured.

4 Closed contours will be hachured only if the interior of the contour is "downhill." Open contours will be hachured only if the "interior" of the contour is "downhill," where "interior" is defined by computing the total change in direction along the contour. If that total is positive, the "interior" is to the left; if it is negative, the "interior" is to the right.

-1 All contours will be hachured.

-2 Closed contours will be hachured only if the interior of the contour is "uphill." Open contours will be unconditionally hachured.

-3 Closed contours will be hachured only if the interior of the contour is "uphill." No open contours will be hachured.

-4 Closed contours will be hachured only if the interior of the contour is "uphill." Open contours will be hachured only if the "interior" of the contour is "uphill," where "interior" is defined by computing the total change in direction along the contour. If that total is positive, the "interior" is to the left; if it is negative, the "interior" is to the right.

The user is expected to increase the value of the RWC parameter from its default 100 to a value large enough to accommodate any contour that can arise from the data field being used; this may require increasing the size of the real workspace array. (This is so that the hachuring routine is assured of seeing all of each contour line. Otherwise, it can't tell which way the "inside" and the "outside" of the closed contours are.)

Closed contours that are divided into pieces that appear to be open contours will be hachured. Closed contours may appear to be open contours because portions of the closed contour disappear as a result of the mapping implied by nonzero values of the Conpack parameter MAP and the out-of-range value ORV, or because they run through special-value areas, as defined by the parameter SPV, or because the user has forgotten to increase the value of RWC, as described in the preceding paragraph. The rationale for this is that no real confusion can arise from hachuring a contour line that shouldn't be, but confusion may result from not hachuring a contour line that should be.

HCL

Real---HaChure Length. HCL specifies the hachure length, stated as a fraction of the width of the viewport. A positive value implies the use of hachures on the downslope side of the contour. A negative value implies the use of hachures on the upslope side of the contour.

Default: .004

HCS

Real---HaChure Spacing. This is the distance between one hachure and the next along a contour line. HCS specifies the hachure spacing as a fraction of the width of the viewport. The value of HCS is forced to lie in the range .0001 to 10. Values outside this range will be interpreted as the nearest value within the range.

Default: .01

HIC

Integer---HIgh label Color index. HIC is used in determining the color index for high labels. See the description of HLC, below.

Default: -1

HIT

Character expression---HIgh label Text string. HIT specifies the text string to be used in labeling a high. See the description of HLT, below.

Default: 'H:B:$ZDV$:E'

HLA

Real---High/Low label Angle. HLA specifies the angle (in degrees counterclockwise from a vector pointing to the right) at which high and low labels are to be written.

Default: 0.

HLB

Integer---High/Low label Box flag.

0 High and low labels are not boxed at all.

1 Perimeter of the box is drawn (in the same color as the label) after the label is drawn.

2 Box is filled (in the color specified by LBC) before the label is drawn.

3 Both 1 and 2 above.

Default: 0

HLC

Integer---High/Low label Color index. HLC is used in determining the color index for high and low labels.

The color index for high labels is determined in this manner:

If HIC>=0, HIC is used as the color index.

If HIC<0, but HLC>=0, HLC is used as the color index.

If both HIC and HLC are less than zero, the current text color index is used.

The color index for low labels is determined similarly:

If LOC>=0, LOC is used as the color index.

If LOC<0, but HLC>=0, HLC is used as the color index.

If both LOC and HLC are less than zero, the current text color index is used.

If a box is drawn around a label, it is made the same color as the label.

To set the color index of all high and low labels, simply supply the desired value for HLC. To have high and low labels that are colored differently, set HIC and LOC. The default values of HLC, HIC, and LOC are all 1.

Default: -1

HLL

Real---High/Low label Line width.

<=0. Line width is not set before drawing boxes around high and low labels.

>0. The desired width, as a multiple of the normal line width.

Default: 0.

HLO

Integer---High/Low label Overlap flag. The value of HLO determines what is to be done about the problem of high and low labels overlapping other objects. Add one or more of the following values and use the resulting sum to obtain the combination of effects you want:

0 The problem will be ignored. High and low labels will not be checked for overlap with anything else.

1 Omit high and low labels that overlap the information label.

2 Omit high and low labels that overlap other high and low labels found before them.

4 Omit high and low labels that overlap the edges of the viewport.

8 High and low labels that overlap the edges of the viewport should be moved inward by just enough to take care of the problem.

The action implied by the value 4 takes precedence over that implied by the value 8; if you add both 4 and 8, the effect will be as if you had added 4 alone.

Default: 3 (the sum of 1 and 2)

HLS

Real---High/Low label Size. HLS specifies the nominal size (width) of a character in a high or low label, as a fraction of the width of the viewport. This nominal size is multiplied by CWM.

Default: .012

HLT

Character expression---High/Low label Text strings. You can specify the character strings used to label highs and lows individually, by setting HIT and LOT, or together, by setting HLT. If HLT is set, and there are no apostrophes in the given character string, then both HIT and LOT will be set equal to HLT and it will therefore be used as the label for both highs and lows. If there are apostrophes in the string, what precedes the first apostrophe will be used as the value of HIT (the label for a high) and what follows it will be used as the value of LOT (the label for a low).

Remember that, in Fortran, an apostrophe in a string that is delimited by apostrophes is represented by two apostrophes.

The substring '$ZDV$' may be used to represent the numeric value of the high or the low, divided by the current scale factor. The substring '$ZDVU$' may be used to represent the unscaled value.

Examples:

---------------------------------------------------
Fortran string                High label  Low label  
---------------------------------------------------
'H''L'                        H           L          
'HI''LO'                      HI          LO         
'$ZDV$'                       1.362       .764       
'H ($ZDV$)''L ($ZDV$)'        H (1.362)   L (.764)   
'H:B:$ZDV$:E:''L:B:$ZDV$:E:'                         
                              H1.362      L.764      
---------------------------------------------------

Note that, in the final example above, the subscripting capability of the Plotchar utility is used. The terminating function code E ensures that the H or the L will be centered on the high or low. To center the whole thing, either remove the Es or change them to Ns.

Neither of the character strings HIT and LOT may contain more than 20 characters. If HIT is blank, highs will not be labeled. If LOT is blank, lows will not be labeled.

There is no default value for HLT. The default value for HIT is 'H:B:$ZDV$:E:' and the default value of LOT is 'L:B:$ZDV$:E:', as shown in the final example above.

Default: None

HLW

Real---High/Low label White space width. HLW specifies the nominal width of white space to be left around a high or low label, as a fraction of the width of the viewport. This nominal width is multiplied by CWM.

Default: .005

HLX

Integer---High/Low search radius in X.

>0 Specifies the half-width of the index-value neighborhood used in searching the contour field for highs and lows. The "neighborhood" is the area around the index value. See the example below.

<=0 Conpack picks a reasonable value to use (approximately 1/8 of ZDM, but not less than 2 nor greater than 15).

For example: If HLX=3 and HLY=4, then the values in ZDAT examined to determine if (I,J) is a high or a low are those having indices (K,L), where either K<>I, or L<>J, K is between MAX(1,I3) and MIN(ZDM,I+3), inclusive, and L is between MAX(1,J4) and MIN(ZDN,J+4), inclusive.

Default: 0

HLY

Integer---High/Low search radius in Y.

>0 Specifies the half-height of the index-value neighborhood used in searching the contour field for highs and lows. The "neighborhood" is the area around the index value.

<=0 Conpack picks a reasonable value to use (approximately 1/8 of ZDN, but not less than 2 nor greater than 15).

For an example, see the description of HLX, above.

Default: 0

ILA

Real---Information Label Angle. ILA specifies the angle (in degrees counterclockwise from a vector pointing to the right) at which the information label is written.

Default: 0.

ILB

Integer---Information Label Box flag.

0 Information label is not boxed at all.

1 Perimeter of the box is drawn (in the same color as the label) after the label is drawn.

2 Box is filled (in the color specified by LBC) before the label is drawn.

3 Both 1 and 2 above.

Default: 0

ILC

Integer---Information Label Color index.

<0 The information label and the box around it (if any), are drawn in the color specified by the current text color index.

>=0 Specifies the desired color index for the label and the box. If a box is drawn around the label, it is made the same color as the label itself.

Default: -1

ILL

Real---Information Label Line width.

<=0. Line width is not set before drawing a box around the information label.

>0. Specifies the desired width, as a multiple of the "normal" line width.

Default: 0.

ILP

Integer---Information Label Positioning flag. ILP determines how the information label is to be positioned. There are nine possible values, each of which specifies a point of the label box that is to lie on the point defined by ILX and ILY, as shown below:

-4 Lower left corner of label box.

-3 Center of bottom of label box.

-2 Lower right corner of label box.

-1 Center of left edge of label box.

0 Center of label box.

+1 Center of right edge of label box.

+2 Upper left corner of label box.

+3 Center of top edge of label box.

+4 Upper right corner of label box.

Left, right, bottom, and top are defined from the viewpoint of someone reading the label right side up.

Default: 4 (the upper right corner of the label box will be placed on the point (ILX, ILY).

ILS

Real---Information Label Size. ILS specifies the nominal size (width) of a character in the information label, as a fraction of the width of the viewport. This nominal size is multiplied by CWM.

Default: .012

ILT

Character expression---Information Label Text string. ILT is a string of <=100 characters that specifies the text of the information label. The following substrings will be replaced by a numeric value:

--------------------------------------
$CIU$  Contour interval used            
$CMN$  Minimum contour level            
$CMX$  Maximum contour level            
$SFU$  Current scale factor             
$ZMN$  Minimum value in the data array  
$ZMX$  Maximum value in the data array  
--------------------------------------

In each case except $SFU$, the given value will have been divided by the current scale factor. To request the use of an unscaled value, you can insert "U" just before the final "$" (examples: "$CIUU$" or "$CMNU$").

The value that replaces $CIU$ is only correct if Conpack itself has chosen the contour levels; otherwise, it may be necessary for you to set the value of CIU, which is described above.

If ILT is given the value ' ' (a single blank), no information label will be printed.

Default: 'CONTOUR FROM $CMN$TO $CMX$ BY $CIU$'

ILW

Real---Information Label White space width. ILW specifies the nominal width of white space to be left around the information label, as a fraction of the width of the viewport. This nominal width is multiplied by CWM.

Default: .005

ILX

Real---Information Label X coordinate. ILX specifies the X coordinate of the basepoint of the information label. The given value is mapped linearly onto the viewport.

<0. Outside the viewport on the left side.

0. Left edge of the viewport.

0.<ILX<1.
Between the left and right edges of the viewport.

1. Right edge of the viewport.

>1. Beyond the right edge of the viewport.

Default: .98

ILY

Real---Information Label Y coordinate. ILY specifies the Y coordinate of the basepoint of the information label. The given value is mapped linearly onto the viewport.

<0. Outside the viewport on the bottom edge.

0. Bottom edge of the viewport.

0.<ILY<1.
Between the bottom and top edges of the viewport.

1. Top edge of the viewport.

>1. Beyond the top edge of the viewport.

Default: -.02

IWM

Integer---Integer Workspace for Masking. IWM specifies the amount of integer workspace to be allotted for use by CPCLDM, which draws contour lines masked by an area map, in calls to the Areas routine ARDRLN. Assume a parameter value n; the space used will be 2n (n for the array IAI and n for the array IAG, in calls to ARDRLN). The value n must be greater than or equal to the number of group identifiers used in generating the area map.

Default: 10

IWU

Integer---Integer Workspace Usage. For retrieval only, it is set to zero by the call to CPRECT, CPSPS1, or CPSPS2. As Conpack routines are called, the value of IWU is updated to reflect the largest number of words of integer workspace needed at any one time. Therefore, by retrieving its value after an entire plot has been constructed, you can find out how large an integer workspace was actually required.

Default: None

LBC

Integer---Label Box Color index. If label boxes (of whatever type) are filled, the filling is done using the color index specified by LBC.

<0 The current fill area color index is used.

>=0 Specifies the color index to be used.

Default: 0 (the background color)

LBX

Real---Label Box X coordinate. Not to be set by the user. The value may be retrieved in one of the routines CPCHCF, CPCHHL, CPCHIL, or CPCHLL. LBX specifies the X coordinate (in the current world coordinate system) of the center of the box surrounding the label that has caused the routine to be called.

Default: 0.

LBY

Real---Label Box Y coordinate. Not to be set by the user. The value may be retrieved in one of the routines CPCHCF, CPCHHL, CPCHIL, or CPCHLL. LBY specifies the Y coordinate (in the current world coordinate system) of the center of the box surrounding the label that has caused the routine to be called.

Default: 0.

LIS

Integer---Label Interval Specifier. When you give CLS a positive value, indicating that Conpack is to choose contour levels at intervals of the form b*k , where b is a base value and k is an integer, and you give CIS a positive value (indicating that CIS is the desired value of b), then you must set LIS to specify the interval between labeled contour levels. See the descriptions of the CLS and CIS parameters.

For example: If you specify CLS=1, CIS=1/3, and LIS=3, you will get contours at values like 1/3, 2/3, 3/3, 4/3..., with labels at values like 1, 2, 3, 4....

Default: 5

LIT

Integer array---Label Interval Table. See the description of the CIT parameter.

Default: See CIT

LIU

Integer---Label Interval Used. LIU is for retrieval only. When Conpack chooses the contour interval and decides that every nth one should be labeled, it sets LIU to n.

Default: None

LLA

Real---Line Label Angle. LLA specifies the angle (in degrees counterclockwise from a vector pointing to the right) at which contour line labels are to be written when ABS(LLP)>=2 and LLO=0.

Default: 0.

LLB

Integer---Line Label Box flag.

0 Contour line labels drawn by CPLBDR are not boxed at all.

1 Perimeter of the box is drawn (in the same color as the label) after the label is drawn.

2 Box is filled (in the color specified by LBC) before the label is drawn.

3 Both 1 and 2 above.

Default: 0

LLC

Integer array---Line Label Color index. An array of color indices for labels associated with the contour levels specified by CLV.

>=0 The color index for labels on contour lines at the level specified by the associated element of CLV.

<0 The current text color index is to be used.

This parameter only affects line labels when ABS(LLP)=2 or 3 and the labels are therefore drawn by CPLBDR. It does not affect line labels when ABS(LLP)=1 and the line labels are therefore drawn by the Dashline utility, as called by CPCLDM or CPCLDR.

Default: -1 for all elements of LLC

LLL

Real---Line Label Line width.

<=0. Line width is not set before drawing boxes around contour line labels.

0. The desired width, as a multiple of the normal line width.

Default: 0.

LLO

Integer---Line Label Orientation. LLO only has effect when ABS(LLP)>=2, specifying the use of either the regular scheme or the penalty scheme for positioning labels on contour lines.

0 All labels are written at the angle specified by LLA.

<>0 Each label is written in the local direction of the contour line. The local direction is the direction of the tangent to the contour line at the label position.

Default: 0

LLP

Integer---Line Label Positioning. LLP specifies whether or not labels should be produced, and if so, how:

0 No line labels should be produced.

1 or -1
Labels should be positioned along contour lines by using the old CONREC scheme of setting up a character dash pattern including the label and using the software dash utility to draw the labels (which requires having DPU<>0). This scheme has the disadvantages that you cannot control the orientation or shield the labels from having contour lines drawn through them.

2 or -2
Labels should be positioned at regular intervals along the line. See the descriptions of the RC1, RC2, and RC3 parameters.

3 or -3
Labels should be positioned by using a penalty scheme, which can give much better results than either of the other values. See the descriptions of the parameters with names in the form of PCn and PWn.

When LLP=2 or 3, the 2D smoothing, if any, implied by the value of T2D is suspended during label positioning, so that fewer label positions will be considered. This is quite a bit faster and the results are nearly as good as if the smoothing were done. To force smoothing, use LLP=2 or 3.

Default: 1

LLS

Real---Line Label Size. LLS specifies the nominal size (width) of a character in a contour line label, as a fraction of the width of the viewport. This nominal size is multiplied by CWM.

Default: .010

LLT

Character array---Line Label Text string. For each I from 1 to NCL, element I of the parameter array LLT is a string of 20 or fewer characters, to be used as a label for the contour level specified by the Ith element of CLV. Since the character string will be plotted using the Plotchar routine PLCHHQ, it can contain colon-enclosed function codes to do things like create superscripts.

If you do not supply the elements of this array, the elements will be filled in by Conpack.

Default: None

LLW

Real---Line Label White space. LLW specifies the nominal width of white space to be left around a contour line label, as a fraction of the width of the viewport. This nominal width is multiplied by CWM.

Default: .005

LOC

Integer---LOw label Color index. LOC is used in determining the color index for low labels. See the description of the HLC parameter.

Default: -1

LOT

Character expression---LOw label Text string. LOT specifies the text string to be used in labeling a low. See the HLT parameter.

Default: 'L:B:$ZDV$:E:'

MAP

Integer---MAPping flag.

0 Specifies that the X and Y coordinates used to create the contour map are not to be transformed by the user-replaceable CPMPXY routine.

<>0 Specifies that X and Y coordinates are to be transformed by the user-replaceable CPMPXY routine. Two nonzero values for MAP provide useful mappings with the default version of CPMPXY:

1 If the first subscript of the data array is a linear function of the longitude and the second is a linear function of the latitude, then you can transform all graphics output onto a map background created by calls to Ezmap routines just by setting MAP=1, XC1 = minimum longitude, XCM = maximum longitude, YC1 = minimum latitude, and YCN = maximum latitude. Also, the Conpack parameter SET must be given the value 0 to prevent Conpack from calling SET and thereby overriding the call done by Ezmap.

2 If the first subscript of the data array is a linear function of rho and the second is a linear function of theta, where rho and theta are polar coordinates, then to map all graphics output properly, you can set MAP=2, XC1 = minimum rho, XCM = maximum rho, YC1 = minimum theta, and YCN = maximum theta. In this case, you must either use SET=0 and do an appropriate SET call or use SET=1 and give the parameters WDB, WDL, WDR, and WDT values consistent with the mapped values of X and Y, which will all be of the form "rho*cos(theta)" and "rho*sin(theta)", respectively.

Using any other nonzero value of MAP will result in the identity mapping (X→X, Y→Y, a→a, 1→1, and so on.)

You can supply your own version of the CPMPXY routine and build as many different mappings into it as desired. See the description of CPMPXY.

Default value of MAP: 0

NCL

Integer---Number of Contour Levels. If Conpack is to pick contour levels (see the description of the CLS parameter), then the initial call to CPRECT, CPSPS1, or CPSPS2 causes NCL to be set to zero. Subsequently, during the first call to a Conpack routine requiring contour levels to have been chosen, NCL will be set as part of the process of choosing them. If you choose the contour levels, the first parameter that you must set is NCL.

Default: None

NEL

Integer---Numeric Exponent Length.

<=0 Exponents in numeric labels should be written in the shortest possible form; plus signs are omitted and the exponent magnitude is written with no leading zeros.

n>0
Exponents should be written with a sign (+ or -) and the exponent magnitude should be padded with leading zeros to a length of n characters.

Default: 0

NET

Integer---Numeric Exponent Type. NET determines what characters are to be used between the mantissa of a numeric label and the exponent.

0 Specifies the use of an E, as in Fortran "E format."

1 Specifies the use of function codes, as expected by the Plotchar utility, to generate "x 10n", where n is a superscript exponent.

2 Specifies the use of "x10**".

Default: 1

NEU

Integer---Numeric Exponent Use flag.

<=0 Forces the use of the exponential form in all numeric labels.

n>0
Specifies use of the form without an exponent as long as it requires no more than n characters; otherwise the form requiring the fewest characters should be used.

NLS

Integer---Numeric Leftmost Significant digit flag.

0 Leftmost nonzero digit of a number represented by a numeric label is to be considered its first significant digit.

<>0 Digit in the same digit position as the leftmost nonzero digit of the largest number (in absolute value) in the data field being contoured is to be considered the leftmost significant digit.

Using NLS<>0 tends to make the numeric labels more nearly consistent with one another.

For example: Assume the use of three significant digits.

Using NLS=0:

--------------------------------------
 .500  1.00  1.50  ...  9.50  10.5  ...  
--------------------------------------

Using NLS=1:

---------------------------------
 .5  1.0  1.5  ...  9.5  10.5  ...  
---------------------------------

Default: 1

NLZ

Integer---Numeric Leading Zero flag.

<>0 A zero is placed before any numeric label that would otherwise begin with a decimal point (0.345 rather than .345).

0 No zero is added to numeric labels.

Default: 0

NOF

Integer---Numeric Omission Flags. Specifies what parts of a numeric label may be omitted. Add one or more of the following values and use the resulting sum to obtain the combination of effects you want:

0 Specifies that no part may be omitted.

1 Omit trailing zeros after a decimal point (as in 46.200).

2 Omit a trailing decimal point (as in "13.").

4 Omit an unnecessary leading "1" or "1." (as in "1 x 1013").

Contour line labels generated by Conpack and values in the information label that are known to have been rounded to nice values (like '$CIU$', '$CMN$', and '$CMX$') will have trailing zeros trimmed in any case, regardless of the value of NOF.

Default: 6 (the sum of 4 and 2)

NSD

Integer---Number of Significant Digits. NSD specifies the maximum number of significant digits used in numeric labels representing contour field values.

n<0
Specifies that ABS(n) significant digits should be used.

n>=0
Specifies that m+n digits should be used, where m is the number of digits that are the same for all values in the contour field. For example, if the minimum value is 1123.6 and the maximum value is 1125.9, then the value of m is 3.

Default: 4

NVS

Integer---Number of Vertical Strips. When NVS is nonzero, an extra group of edges, with group identifier GIS, is added to the area map by the CPCLAM routine. These edges include the boundary of the viewport and enough vertical lines to break the area occupied by the viewport up into NVS vertical strips. The object of this is to break up the contour bands that are to be filled into smaller and simpler pieces; this may be necessary if the graphics device in use limits the number of points that may be used to define a polygon to be filled. The area identifier for the outside of the viewport is 1; all other area identifiers used are 0s.

Default: 1

ORV

Real---Out-of-Range Value.

0. No out-of-range value specified.

<>0. Specifies an out-of-range value, to be used as the value of X and Y coordinates returned by the mapping routine CPMPXY to say that a point is out-of-range (invisible) under the current mapping.

Default: 0.

PAI

Integer---Parameter Array Index. The value of PAI must be set, before accessing any Conpack parameter that is an array, to indicate which element of the array is meant. (The Conpack parameter access routines have the form CPGETx and CPSETx.) For example, to set the tenth contour level to zero, use code like this:

CALL CPSETI ('PAI', 10)
CALL CPSETR ('CLV', 0.)

PC1

Real---Penalty scheme Constant 1. PC1 is the "largest gradient" constant used in the penalty scheme for positioning labels. The largest gradient allowed at the position of a label will be:

GRAV + PC1 * GRSD

where GRAV is the average gradient and GRSD is the standard deviation of the gradients.

Default: 1.

PC2

Real---Penalty scheme Constant 2. PC2 is the "crossing contours" constant used in the penalty scheme for positioning labels. It specifies the maximum (estimated) number of contour bands allowed to cross a label.

Default: 5.

PC3

Real---Penalty scheme Constant 3. PC3 is the "tight curves" constant used in the penalty scheme for positioning labels. It specifies, in degrees, the maximum cumulative change in direction to be allowed along that portion of the contour line covered by a circle centered on a label and having a radius equal to half the width of the label.

Default: 60.

PC4

Real---Penalty scheme Constant 4. PC4 is the "optimum distance" constant used in the penalty scheme for positioning labels. It specifies the optimal distance in the term in the penalty function that attempts to force labels to be at an optimal distance from each other.

Default: .05

PC5

Real---Penalty scheme Constant 5. PC5 is the "folding distance" constant used in the penalty scheme for positioning labels, in the term that attempts to force labels to be at an optimal distance from each other.

Default: .15

PC6

Real---Penalty scheme Constant 6. PC6 is the "minimum distance" constant used in the penalty scheme for positioning labels. It specifies the minimum distance to be allowed between any two labels on the same contour line, as a fraction of the width of the viewport.

Default: .30

PIC

Integer---Point Interpolation flag for Contours. PIC specifies the number of points to interpolate between each pair of points defining a segment of a contour line, prior to any mapping implied by the Conpack parameter MAP.

0 No points are interpolated.

<>0 Should normally be used only if MAP<>0, which turns mapping on, and T2D=0, which turns the 2D smoother off. The intent is to map straight-line segments of contour lines more nearly correctly into curved-line segments on a background (one drawn by Ezmap, for example). If the 2D smoother is turned on, the additional points will be used and the smoothed curve will be constrained to pass through them; this may be useful.

<0 Causes ABS(PIC) points to be interpolated, but the interpolated points are not, in general, used to draw the line segment. The object, in this case, is simply to do a finer search for changes in visibility (out-of-range state, as defined by values of ORV returned by the CPMPXY routine) along the segment.

Default: 0

PIE

Integer---Point Interpolation flag for Edges. PIE specifies the number of points to interpolate between each pair of points defining a segment of an edge (the edge of the grid, the edge of an out-of-range area, or the edge of a special-value area).

0 No points are interpolated.

<>0 Should normally be used only if MAP<>0, which turns mapping on. The intent is to map straight-line segments of edge lines more nearly correctly into curved-line segments on a background (one drawn by the Ezmap utility, for example).

<0 Causes ABS(PIE) points to be interpolated, but the interpolated points are not, in general, used to draw the line segment. The object, in this case, is simply to do a finer search for changes in out-of-range state (visibility) along the segment. (The edges of out-of-range areas, however, are drawn using all such interpolated points.)

Using too large a value of PIE, either positive or negative, will cause the tracing of the edges of out-of-range areas to be very time-consuming, because the number of points to be examined is ZDM*ZDN*PIE*PIE.

Default: 0

PW1

Real---Penalty scheme Weight 1. PW1 specifies the weight for the "gradient" term in the penalty function.

Default: 2.

PW2

Real---Penalty scheme Weight 2. PW2 specifies the weight for the "crossing contours" term in the penalty function.

Default: 0.

PW3

Real---Penalty scheme Weight 3. PW3 specifies the weight for the "tight curves" term in the penalty function.

Default: 1.

PW4

Real---Penalty scheme Weight 4. PW4 specifies the weight for the "optimum distance" term in the penalty function.

Default: 1.

RC1

Real---Regular scheme Constant 1. RC1 specifies the desired distance from the beginning of a contour line to the first label on that line when they are positioned using the regular scheme. The nth label on each labeled contour line will be at a distance RC1+RC2*(n1)+RC3*Rn units (in the fractional coordinate system) from the beginning of the line, where "Rn" is a random number between 1 and 1.

Default: .25

RC2

Real---Regular scheme Constant 2. RC2 specifies the desired nominal distance between labels when they are positioned using the regular scheme. See the description of RC1, above.

Default: .25

RC3

Real---Regular scheme Constant 3. RC3 specifies the desired maximum variation in the distance between labels when they are positioned using the regular scheme. See the description of RC1, above.

Default: .05

RWC

Integer---Real Workspace for Contours. RWC specifies the amount of real workspace to be allotted to hold coordinates of points defining contour lines and associated quantities. Assume a parameter value n. If no 2D smoothing is requested, the total space used will be 2n (n for X coordinates and another n for Y coordinates). If 2D smoothing is requested, the total space used will be 7n (n for X coordinates, n for Y coordinates, and 5n for scratch arrays).

Normally, the value of RWC is of no particular interest to you, since the same contour lines are produced with a small value as would be produced with a larger value. There are two situations in which it becomes of more interest: 1) When the penalty scheme is used to position labels, the length of the portion of the contour line over which the penalty function is evaluated is limited by the value of RWC. If RWC is set too small, too many labels may be put on a given contour line and some of them may be too close to each other. 2) When hachuring has been activated (HCF<>0), it is important that the routine that does the hachuring see entire contours at once, so that it may properly decide whether a contour is open or closed, and, in the latter case, where the interior of the closed contour is.

In both of these situations, the solution is to increase the value of RWC.

Default: 100

RWG

Integer---Real Workspace for Gradients. RWG specifies the amount of real workspace to be allotted to hold gradients that are to be computed and used in positioning labels using the penalty scheme. Using a larger value provides for a more accurate representation of the gradient field, up to the point at which it exceeds ZDM*ZDN.

Default: 1000

RWM

Integer---Real Workspace for Masking. RWM specifies the amount of real workspace to be allotted for use by CPCLDM, which draws contour lines masked by an area map, in calls to the Areas routine ARDRLN. Assume a parameter value n: the space used will be 2n (n for the Xcoordinate array XCS and n for the Ycoordinate array YCS, in calls to ARDRLN). Any value of n greater than or equal to 2 will work; smaller values will cause the generation of more calls to the user subroutine RTPL (one of the arguments of CPCLDM).

Default: 100

RWU

Integer---Real Workspace Usage. For retrieval only, RWU is set to zero by the call to CPRECT, CPSPS1, or CPSPS2. Thereafter, as Conpack routines are called, the value of RWU is updated to reflect the largest number of words of real workspace needed at any one time. Therefore, by retrieving its value after an entire plot has been constructed, you can find out how large a real workspace was actually required.

Default: None

SET

Integer---do-SET-call flag.

0 No SET call is to be done by Conpack.

1 SET call is to be done by CPRECT, CPSPS1, or CPSPS2.

Arguments 5 through 8 of a SET call done by the user must be consistent with the ranges of the X and Y coordinates being used by Conpack, as specified by the values of the parameters XC1, XCM, YC1, YCN, and MAP. See the descriptions of those parameters

Default: 1

SFS

Real---Scale Factor Selector. The scale factor is that value (usually, but not necessarily, a power of 10) by which the actual values of contour field values are to be divided to get the value of a numeric label.

>0. The value selected is the scale factor used.

If SFS is given a value less than or equal to zero, the value is truncated to form an integer directing Conpack to select a scale factor, as follows:

0. Scale factor should be selected in such a way as to reduce the ZDAT element having the largest absolute value to the range from .1 to .999.

-1. Scale factor should be selected in such a way as to reduce the ZDAT element having the largest absolute value to the range from 1. to 9.999.

-2. Scale factor should be selected in such a way as to place the decimal point in the ZDAT element having the largest absolute value after the rightmost significant digit of that value (as defined by the values of NSD and NLS).

-3. Scale factor should be selected in such a way as to remove extra zeros from the ends of the ZDAT element having the largest absolute value. For example, if that element were .000136, the scale factor would be 10 to the power 3; if that element were 136000 (assuming three significant digits are desired), the scale factor would be 10 to the power 3. If there are no extra zeros on either end of the ZDAT element having the largest absolute value, the scale factor will be 1.

<=-4.
Scale factor should be selected in such a way as to reduce all contour labels to integers.

Default: 1.

SFU

Real---Scale Factor Used. For retrieval only, SFU gives the value of the scale factor selected for use by Conpack.

Default: None

SPV

Real---SPecial Value.

0. No special value is used.

<>0. Specifies a special value, which may be used in data fields to signal missing data. No contour lines will be drawn within any grid cell with a special value at one or more of its four corners.

Default: 0.

SSL

Real---Smoothed Segment Length. SSL specifies the distance between points used to draw the curves generated by 2D smoothing; it is expressed as a fraction of the width of the window in the coordinate system in which the smoothing is being done.

Default: .01

T2D

Real---Tension on 2-Dimensional splines.

0. No 2D smoothing is done.

<0. 2D smoothing (using cubic splines under tension) is done. The absolute value of T2D is the desired tension. Smoothing is done before the mapping, if any, requested by the Conpack parameter MAP.

>0. 2D smoothing (using cubic splines under tension) is done. The absolute value of T2D is the desired tension. Smoothing is done after mapping.

Default: 0.

T3D

Real---Tension on 3-Dimensional splines. T3D specifies the tension on the 3D (bicubic) splines used by CPSPS1 or CPSPS2 to smooth the data being contoured.

Default: 1.

VPB

Real---ViewPort Bottom. VPB is only used when the Conpack parameter SET<>0, specifying that Conpack should do the call to SET. It specifies the position of the bottom edge of the area in which the viewport is to be placed, expressed as a fraction between 0. (the bottom edge of the plotter frame) and 1. (the top edge of the plotter frame). See the description of VPS.

Default: .05

VPL

Real---ViewPort Left. VPL is only used when the Conpack parameter SET<>0, specifying that Conpack should do the call to SET. It specifies the position of the left edge of the area in which the viewport is to be placed, expressed as a fraction between 0. (the left edge of the plotter frame) and 1. (the right edge of the plotter frame). See the description of VPS.

Default: .05

VPR

Real---ViewPort Right. VPR is only used when the Conpack parameter SET<>0, specifying that Conpack should do the call to SET. It specifies the position of the right edge of the area in which the viewport is to be placed, expressed as a fraction between 0. (the left edge of the plotter frame) and 1. (the right edge of the plotter frame). See the description of VPS.

Default: .95

VPS

Real---ViewPort Shape. VPS is only used when the Conpack parameter SET<>0, specifying that Conpack should do the call to SET. It specifies the desired viewport shape, as follows:

<0. Specifies the exact shape of the viewport; the absolute value is the ratio of the width of the viewport to its height.

0. Specifies a viewport completely filling the area specified by VPL, VPR, VPB, and VPT.

0.<VPS<1.
Specifies a plot of the shape determined by the values of XC1, XCM, YC1, and YCN, reverting to the shape specified by VPL, VPR, VPB, and VPT if the ratio of the shorter side to the longer side would be less than the value of VPS.

>=1. Specifies a plot of the shape determined by the values of XC1, XCM, YC1, and YCN, reverting to a square if the ratio of the longer side to the shorter side would be greater than the value of VPS.

The viewport, whatever its final shape, is centered in, and made as large as possible in, the area specified by the VPB, VPL, VPR, and VPT parameters.

Default: .25

VPT

Real---ViewPort Top. VPT is only used when the Conpack parameter SET<>0, specifying that Conpack should do the call to SET. It specifies the position of the top edge of the area in which the viewport is to be placed, expressed as a fraction between 0. (the bottom edge of the plotter frame) and 1. (the top edge of the plotter frame). See the description of VPS.

Default: .95

WDB

Real---WinDow Bottom. When Conpack does the call to SET, the WDB parameter is used to determine argument number 7, the user Y coordinate at the bottom of the window. If WDB<>WDT, WDB is used. If WDB=WDT, but YC1<>YCN, then YC1 is used. Otherwise, the value 1. is used.

Default: 0.

WDL

Real---WinDow Left. When Conpack does the call to SET, the WDL parameter is used to determine argument number 5, the user X coordinate at the left edge of the window. If WDL<>WDR, WDL is used. If WDL=WDR, but XC1<>XCM, then XC1 is used. Otherwise, the value 1. is used.

Default: 0.

WDR

Real---WinDow Right. When Conpack does the call to SET, the WDR parameter is used to determine argument number 6, the user X coordinate at the right edge of the window. If WDR<>WDL, WDR is used. If WDR=WDL, but XCM<>XC1, then XCM is used. Otherwise, the value REAL(ZDM) is used.

Default: 0.

WDT

Real---WinDow Top. When Conpack does the call to SET, the WDB parameter is used to determine argument number 8, the user Y coordinate at the top of the window. If WDT<>WDB, WDT is used. If WDT=WDB, but YCN<>YC1, then YCN is used. Otherwise, the value REAL(ZDN) is used.

Default: 0.

WSO

Integer---WorkSpace Overflow flag. WSO determines what to do when a real or integer workspace overflow occurs, as follows:

0 Execution terminates with a fatal-error call to SETER.

1 An error message is written to the error file, then execution continues.

2 No error message is written, and execution continues.

When execution continues, the resulting plot will be incomplete. The values of IWU and RWU may be retrieved to find out how much workspace would have been used if the call did not cause a workspace overflow. Note that if you provide these amounts on a subsequent run, you are not assured that workspace overflow will be averted.

Default: 1

XC1

Real---X Coordinate at index 1. XC1 specifies the X coordinate value that corresponds to a value of 1 for the first subscript of the data array, prior to any mapping implied by a nonzero value of MAP. If XC1=XCM, 1. is used.

Default: 0.

XCM

Real---X Coordinate at index M. XCM specifies the X coordinate value that corresponds to a value of ZDM for the first subscript of the data array, prior to any mapping implied by a nonzero value of MAP. If XC1=XCM, REAL(ZDM) is used.

Default: 0.

YC1

Real---Y Coordinate at index 1. YC1 specifies the Y coordinate value that corresponds to a value of 1 for the second subscript of the data array, prior to any mapping implied by a nonzero value of MAP. If YC1=YCM, 1. is used.

Default: 0.

YCN

Real---Y Coordinate at index N. YCN specifies the Y coordinate value that corresponds to a value of ZDN for the second subscript of the data array, prior to any mapping implied by a nonzero value of MAP. If YC1=YCN, REAL(ZDN) is used.

Default: 0.

ZD1

Integer---Z data array Dimension 1. ZD1 specifies the first dimension of the array ZDAT, which contains the data to be contoured. If CPRECT is called, it sets ZD1 (the argument KZDT is the desired value). If CPSPS1 or CPSPS2 is called, it either picks a value of ZD1 (if ZDS<>0) or expects the user to have done so (if ZDS=0).

Default: 1

ZDM

Integer---Z data array Dimension M. ZDM specifies the first dimension of the array of data to be contoured. Its value will be less than or equal to the value of ZD1. If CPRECT is called, it sets ZDM (the argument MZDT is the desired value). If CPSPS1 or CPSPS2 is called, it either picks a value of ZDM (if ZDS<>0) or expects the user to have done so (if ZDS=0).

Default: 1

ZDN

Integer---Z data array Dimension N. ZDN specifies the second dimension of the array of data to be contoured. If CPRECT is called, it sets ZDN (the argument NZDT is the desired value). If CPSPS1 or CPSPS2 is called, it either picks a value of ZDN (if ZDS<>0) or expects the user to have done so (if ZDS=0).

Default: 1

ZDS

Integer---Z data array Dimension Selector.

<>0 CPSPS1 or CPSPS2 will select values for ZD1, ZDM, and ZDN

0 ZD1, ZDM, and ZDN will be expected to have been set by the user.

Note that, if the size of the dense array is not a product of the size of the sparse array and some perfect square, the aspect ratio of the dense grid may be slightly different from that of the sparse grid.

Default: 1

ZDU

Real---Z Data value, Unscaled. See ZDV, the next entry.

Default: None

ZDV

Real---Z Data Value. ZDV is mostly for output. Its value may be retrieved in a user version of CPCHHL to retrieve the value of the high or low that is being labeled.

If a character string representing the value is desired, CPGETC may be used to obtain it (as modified by the current scale factor); thus, to obtain the character representation of an arbitrary value in a form consistent with the other values on a contour plot, set ZDV with a call to CPSETR and retrieve the value of ZDV with a call to CPGETC; if an unscaled value is desired, use the parameter name ZDU in the call to CPGETC.

Default: None

ZMN

Real---Z MiNimum value. The minimum value in the field, as found by CPRECT, CPSPS1, or CPSPS2. For output only.

Default: None

ZMX

Real---Z MaXimum value. The maximum value in the field, as found by CPRECT, CPSPS1, or CPSPS2. For output only.

Default: None

Previous Chapter          Tutorial Home          Index