HSTOPR(3NCARG)

๐Ÿ’– HSTOPR ๐Ÿ’– โ€” the NCAR GRAPHICS girlies' guide

okay bestie, welcome to HSTOPR, a member of the NCAR Graphics family, and literally the moment you've been waiting for: this is the routine that lets you feed a bunch of REAL arrays to the Histogram utility. no cap. it's giving "setting the vibes before the plot even shows up." ๐Ÿ’…


โœจ NAME โœจ

HSTOPR โ€” Specifies various REAL arrays to be used by the the Histogram utility.

yes bestie, "the the." we're keeping it. the original said it. iconic typo behavior fr fr ๐Ÿ™ˆ

๐ŸŒธ SYNOPSIS ๐ŸŒธ

CALL HSTOPR (STRING,ARRAY,LARR)

๐Ÿฆ‹ C-BINDING SYNOPSIS ๐Ÿฆ‹

#include <ncarg/ncargC.h>

void c_hstopr (char *string, float *array, int larr)

๐Ÿ’œ DESCRIPTION ๐Ÿ’œ

  • STRING โ€” Character, input โ€” this is the lil selector that picks which internal parameter you're setting. The possibilities are:
ยดWIN=ONยด or ยดWIN=OFFยด
ยดSPA=ONยด or ยดSPA=OFFยด
ยดMVA=ONยด or ยดMVA=OFFยด

WIN defines the portion of the frame that will receive the histogram. SPA determines the spacing between histogram bars. MVA requests a test to detect input special values which denote missing data. three whole moods, one string. periodt. โœจ

  • ARRAY โ€” Real, input โ€” it has a different use depending upon which parameter is specified by argument STRING. See the examples following argument LARR. (yes, the answer key is literally below, keep scrolling bestie ๐Ÿซถ)
  • LARR โ€” Integer, input โ€” Dimension of ARRAY.

The following arrays may be defined by this routine:

๐ŸชŸ Windowing ๐ŸชŸ

 STRING is ยดWIN=ONยด
 LARR = 4
 ARRAY(1) = XMIN
 ARRAY(2) = XMAX
 ARRAY(3) = YMIN
 ARRAY(4) = YMAX

These coordinates define a rectangular region of the total frame in NDCยดs where the current histogram is to be plotted. The range of allowed values is between 0. and 1. in both dimensions. ๐Ÿ‘‘

For example, XMIN=0., XMAX=.5, YMIN=.5, and YMAX=1. would specify the upper left quadrant of the frame. main character quadrant energy, honestly.

IF ยดWIN=OFFยด, the default window for the histogram will be the entire frame.

๐Ÿ“ Spacing ๐Ÿ“

 STRING is ยดSPA=ONยด
 LARR = 2
 ARRAY(1) = SPAC
 ARRAY(2) = OVERLP

SPAC determines the spacing of histogram bars between 0. (no spacing) and 4. (maximum spacing). Default spacing is SPAC = 2.0. ๐ŸŒˆ

OVERLP determines the overlap of adjacent histogram bars when two datasets are compared. Valid values are -4.0 (maximum overlap) to 4.0 (little or no overlap). The Default is 0.

When STRING = ยดSPA=OFFยด, there is no spacing or overlap. just bars, raw and unbothered. ๐Ÿ’€

๐Ÿ” Detecting missing values ๐Ÿ”

 STRING is ยดMVA=ONยด
 LARR = 2
 ARRAY(1) = SETMVA
 ARRAY(2) = SETEPS

SETMVA is the special value used to denote missing data. The default value is -9999. (the classic "nothing to see here" number, we love her ๐Ÿ˜ญ)

SETEPS is an epsilon to use in the special value test. If the difference between a data point and SETMVA is less than SETEPS, then the data point is assumed to be a missing value. The Default is 1.E-10.

When STRING = ยดMVA=OFFยด, there is no testing for missing values.


๐Ÿงš C-BINDING DESCRIPTION ๐Ÿงš

The C-binding argument descriptions are the same as the FORTRAN argument descriptions. (same energy, different language, we love a bilingual queen ๐Ÿ’…)


โญ USAGE โญ

HSTOPR is called to set parameters of type REAL before entry HISTGR is called to generate the histogram. Options are the portion of the frame to receive the graphic, and the amount of spacing and overlap of histogram bars.

For a complete list of parameters available in this utility, see the histogram_params man page.


๐ŸŽ€ EXAMPLES ๐ŸŽ€

Use the command "ncargex thstgr" to generate a three frame example of histogram options. The following code defined the window and bar spacing of plot 1 on frame 3.

C
C  Plot 1 goes into the top left quadrant of the frame.
C
C       ARR7 coordinates are XMIN, XMAX, YMIN, YMAX.
C
      ARR7(1) = 0.
      ARR7(2) = .5
      ARR7(3) = .5
      ARR7(4) = 1.
      CALL HSTOPR(ยดWIN=ONยด,ARR7,4)
C
      SPAC(1) = 3.0
      SPAC(2) = 0.0
      CALL HSTOPR(ยดSPA=ONยด,SPAC,2)

Example "ncargex thstmv" shows three examples of histograms with missing values in the input data. go look, it ate. ๐Ÿ”ฅ


๐Ÿ”‘ ACCESS ๐Ÿ”‘

To use HSTOPR or c_hstopr, load the NCAR Graphics libraries ncarg, ncarg_gks, and ncarg_c, preferably in that order. yes, in that order โ€” do not shuffle the playlist bestie, the order matters. ๐Ÿซถ


๐Ÿ“ฌ MESSAGES ๐Ÿ“ฌ

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


๐Ÿ‘€ SEE ALSO ๐Ÿ‘€

  • Online: histogram, histogram_params, hstopc, hstopi, hstopl, ncarg_cbind
  • Hardcopy: NCAR Graphics Fundamentals, UNIX Version

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

and that's the whole page, bestie โ€” go forth and set those parameters ๐Ÿ’–

okay so this was the HSTOPR(3NCARG) page from the UNIX manual, dated March 1993. yes she's a 90s baby and she's still serving. mwah. ๐Ÿ˜˜๐ŸŒธ