ncl_hstopl (3) - Linux Manuals

ncl_hstopl: Turns options off and on for the Histogram utility.

Command to display ncl_hstopl manual in Linux: $ man 3 ncl_hstopl

NAME

HSTOPL - Turns options off and on for the Histogram utility.

SYNOPSIS

CALL HSTOPL (STRING)

C-BINDING SYNOPSIS

#include <ncarg/ncargC.h>

void c_hstopl (char *string)

DESCRIPTION

STRING

Character, input -- Selects an internal parameter. The possibilities are:

'HOR=ON' or 'HOR=OFF'

'PER=ON' or 'PER=OFF'

'MID=ON' or 'MID=OFF'

'SHA=ON' or 'SHA=OFF'

'DRL=ON' or 'DRL=OFF'

'MED=ON' or 'MED=OFF'

'NMV=ON' or 'NMV=OFF'

'PMV=ON' or 'PMV=OFF'

'PRM=ON' or 'PRM=OFF'

'FRA=ON' or 'FRA=OFF'

'LIS=ON' or 'LIS=OFF'

'DEF=ON' or 'DEF=OFF'

The following options are defined by this subroutine:

HOR: The histogram bars are drawn horizontally if 'HOR=ON', vertically if 'HOR=OFF'. The default is 'HOR=OFF'.
PER: If 'PER=ON', a labeled percent axis is drawn on the right side of the histogram (top if 'HOR=ON'.) If 'PER=OFF', no percent axis is drawn. The default is 'PER=ON'.
This places a second axis on the opposite side of the frame from the normal frequency axis.
MID: If 'MID=ON', class labels are placed at the midpoint of each class interval. If 'MID=OFF', the class interval end points are labeled. (MID defaults to ON if IFLAG = 2 or 3.) The default is 'MID=ON'.
SHA: If 'SHA=ON', the histogram bars are shaded. If 'SHA=OFF', the bars are not shaded. The default is 'SHA=ON'.
Devices will vary as to how they interpret shading.
DRL: If 'DRL=ON', lines are drawn through the histogram bars where Y-axis tick marks would occur. When comparing two datasets (IFLAG=3), lines are only drawn through the bars associated with the first dataset. If 'DRL=OFF', no lines are drawn. The default is 'DRL=OFF'.
MED: If 'MED=ON', a line is drawn through the median value of all points. If 'MED=OFF', this line is not drawn. MED does not apply when assigning Y-values to X-values; it is valid only for IFLAG = 1 or 2. The default is 'MED=OFF'.
NMV: If 'NMV=ON', histogram bar percentages will be calculated with respect to the number of input data values (NPTS) minus the number of detected missing values (MISS), or NMVA = NPTS - MISS. If 'NMV=OFF', histogram bar percentages will be normalized to NPTS.
PMV: If 'PMV=ON', missing value counts will be written on the plot. If 'NMV=OFF', they will not.
PRM: If 'PRM=ON', a perimeter is drawn around the histogram. If 'PRM=OFF', no perimeter is drawn. The default is 'PRM=OFF'.
FRA: If 'FRA=ON', the frame is advanced automatically after the histogram is drawn. If 'FRA=OFF', the frame is not advanced, and the user must call FRAME. The default is 'FRA=ON'.
LIS: If 'LIS=ON', all the options along with their values are printed on the standard output. If 'LIS=OFF', nothing is printed on the standard output. The default is 'LIS=OFF'.
DEF: If 'DEF=ON', ALL the options are reset to their default values. 'DEF=OFF' has no effect. All parameters begin at their default values.

C-BINDING DESCRIPTION

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

USAGE

HSTOPL is called to toggle histogram options before entry HISTGR is called to generate the histogram.

EXAMPLES

Use the command "ncargex thstgr" to generate a three frame example of various types of histograms. "ncargex thstmv" will show three examples of histograms with missing values in the input data.

ACCESS

To use HSTOPL or c_hstopl, load the NCAR Graphics libraries ncarg, ncarg_gks, and ncarg_c, preferably in that order.

MESSAGES

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

COPYRIGHT

Copyright (C) 1987-2009
University Corporation for Atmospheric Research
The use of this Software is governed by a License Agreement.