Gridall(3NCARG)

πŸ’– Gridall(3NCARG) β€” the NCAR GRAPHICS glow-up πŸ’–

okay bestie, so this is a page from the NCAR GRAPHICS manual, and it's literally all about Gridall β€” the friend group that draws backgrounds for your X/Y plots πŸŽ€. We're talking grids, perimeters, and pairs of axes, all the aesthetic scaffolding so your data can be the main character.

And it's not just vibes β€” Gridall has internal parameters that control everything: the color indices and line width scale factors used to draw the various parts of the background, the formats used for labels, the sizes of the characters used for labels, the amount by which labels get offset from the axes, and even which routine gets called to draw the labels β€” either the SPPS routine WTSTR or the Plotchar routine PLCHHQ. Choices, choices πŸ’…


✨ NAME ✨

Gridall β€” allows one to draw backgrounds for X/Y plots πŸ¦‹. Included are routines for drawing grids, perimeters, and pairs of axes. Its internal parameters control such things as the color indices and line width scale factors used to draw various parts of the background, the formats to be used for labels, the sizes of the characters to be used for labels, the amount by which labels are to be offset from the axes, and the routine to be called to draw the labels (the SPPS routine WTSTR or the Plotchar routine PLCHHQ).


🌈 SYNOPSIS 🌈

Each of the routines GRID, GRIDL, HALFAX, PERIM, PERIML, and GRIDAL draws a background of some sort within the part of the plotter frame occupied by the current GKS viewport. Like, each one does a different flavor of background, and here's the whole menu:

  • GRID draws an unlabeled grid. πŸ“
  • GRIDL draws a labeled grid. 🏷️
  • HALFAX draws a pair of intersecting axes. βž•
  • PERIM draws an unlabeled perimeter. πŸ–ΌοΈ
  • PERIML draws a labeled perimeter. πŸ·οΈπŸ–ΌοΈ
  • GRIDAL draws any of the above. πŸ‘‘

The positioning of ticks and grid lines is determined partly by the arguments of these routines and partly by the nature of the current mapping from the "user" coordinate system to the "fractional" coordinate system β€” as determined by the current definitions of the GKS viewport and window, and by the values of two internal parameters of the package SPPS: Β΄LSΒ΄ and Β΄MIΒ΄. Numeric labels reflect values in the "user" coordinate system. no cap, that's the whole deal πŸ”

Note: Calling the SPPS routine SET defines the GKS viewport and window and the values of the parameters Β΄LSΒ΄ and Β΄MIΒ΄. The parameter Β΄LSΒ΄ determines whether the mappings of user coordinates to fractional coordinates are linear or logarithmic, and the parameter Β΄MIΒ΄ determines whether the mappings are mirror-imaged or not. πŸͺž

🧚 the parameter system, iykyk 🧚

Each of the internal parameters of Gridall has a three-character mnemonic name of the form Β΄xxxΒ΄. And then there's the little accessor squad β€” GAGETC, GAGETI, GAGETR, GASETC, GASETI, and GASETR β€” each one either retrieving the value of a specific internal parameter of Gridall or giving it a whole new value. Here's who does what:

  • GAGETC is called with the name of an internal parameter of type CHARACTER and a character variable in which the value of the parameter is to be returned.
  • GAGETI is called with the name of an internal parameter of type INTEGER or REAL and an integer variable in which the integer equivalent of the value of the parameter is to be returned.
  • GAGETR is called with the name of an internal parameter of type INTEGER or REAL and a real variable in which the real equivalent of the value of the parameter is to be returned.
  • GASETC is called with the name of an internal parameter of type CHARACTER and a character expression that is to become the new value of the parameter.
  • GASETI is called with the name of an internal parameter of type INTEGER or REAL and an integer expression that is to become the new value of the parameter.
  • GASETR is called with the name of an internal parameter of type INTEGER or REAL and a real expression that is to become the new value of the parameter.

These six routines let you access all of the internal parameters of Gridall in a manner consistent with other NCAR Graphics utilities, and they're intended to replace some older routines, each of which allows access to only a limited subset of the internal parameters. That said, the older routines are still available and will remain so for the foreseeable future β€” they're not going anywhere, bestie 🫢:

  • GACOLR sets the value of internal parameters that control the color of various parts of the background. 🎨
  • LABMOD sets the value of internal parameters that affect the appearance of labels. πŸ”€
  • TICKS and TICK4 set the value of internal parameters that determine the length and direction of ticks. πŸ“

🌟 C-BINDING SYNOPSIS 🌟

the C-binding girlies, all lined up:

c_grid
c_gridl
c_halfax
c_perim
c_periml
c_gridal
c_gagetc
c_gageti
c_gagetr
c_gasetc
c_gaseti
c_gasetr
c_gacolr
c_labmod
c_ticks
c_tick4

πŸ™ˆ USER-MODIFIABLE INTERNAL ROUTINES πŸ™ˆ

None. literally none, that's it, moving on πŸ’€


πŸ”₯ ACCESS πŸ”₯

To use Gridall C or Fortran routines, load the NCAR Graphics libraries ncarg, ncarg_gks, and ncarg_c, preferably in that order. order matters, don't play with me πŸ‘‘


πŸ’€ MESSAGES πŸ’€

Various error conditions can occur in Gridall. Each of these results in a call to the error-handling routine SETER, with a final argument indicating that the error is recoverable. By default, an error message is printed and execution is terminated β€” like, rip 😭 β€” but if you turn on error recovery (as described in the "man" page for error_handling), you can get control back. 🫢

The error messages are as follows; all should be more or less self-explanatory:

GACOLR - UNCLEARED PRIOR ERROR
GAGETC - UNCLEARED PRIOR ERROR
GAGETC - UNRECOGNIZED PARAMETER NAME
GAGETI - UNCLEARED PRIOR ERROR
GAGETR - UNCLEARED PRIOR ERROR
GAGETR - UNRECOGNIZED PARAMETER NAME
GASETC - UNCLEARED PRIOR ERROR
GASETC - UNRECOGNIZED PARAMETER NAME
GASETI - UNCLEARED PRIOR ERROR
GASETR - UNCLEARED PRIOR ERROR
GASETR - UNRECOGNIZED PARAMETER NAME
GRID - UNCLEARED PRIOR ERROR
GRIDAL - ERROR EXIT FROM GQCLIP
GRIDAL - ERROR EXIT FROM GQLWSC
GRIDAL - ERROR EXIT FROM GQPLCI
GRIDAL - ERROR EXIT FROM GQTXCI
GRIDAL - UNCLEARED PRIOR ERROR
GRIDL - UNCLEARED PRIOR ERROR
HALFAX - UNCLEARED PRIOR ERROR
LABMOD - UNCLEARED PRIOR ERROR
PERIM - UNCLEARED PRIOR ERROR
PERIML - UNCLEARED PRIOR ERROR
TICK4 - UNCLEARED PRIOR ERROR
TICKS - UNCLEARED PRIOR ERROR

πŸ¦‹ SEE ALSO πŸ¦‹

Online: gridall_params, gacolr, gagetc, gageti, gagetr, gasetc, gaseti, gasetr, grid, gridal, gridl, halfax, labmod, perim, periml, tick4, ticks, 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 πŸ’– this was the UNIX version of Gridall(3NCARG), dated March 1993 β€” iconic behavior from 1993 fr fr, slay πŸŒΈπŸŽ€βœ¨