SED navigation bar go to SED home page go to Dataplot home page go to NIST home page SED Home Page SED Staff SED Projects SED Products and Publications Search SED Pages
Dataplot Vol 1 Vol 2

SUBREGION

Name:
    SUBREGION
Type:
    Plot Control Command
Purpose:
    Specifies whether subregions on subsequent plots are on (active) or off (inactive).
Description:
    Dataplot now supports subregions on plots. Subregions are motivated by the desire to denote "engineering limits" on a plot. That is, a rectangle, denoting an acceptance region in both the X and Y directions, is drawn and then the plot is overlaid on top of this.

    Although the subregion capability was motivated for the purpose of denoting engineering limits, they can in fact be used for whatever purpose you want. Subregions apply to all subsequent 2-D plots (but not 3-D plots).

    Currently, subregions are limited to rectangular regions. This will be upgraded to polygonal regions in a future implementation.

    The SUBREGION command is used to turn subregions on or off and up to 10 subregions can be specified. In most cases where subregions are defined, only a single subregion is used.

Syntax:
    SUBREGION <ON/OFF> <ON/OFF> ... <ON/OFF>
    where <ON> specifies that the subregion is active and OFF specifies that it is inactive. Up to 10 subregion switches can be set.

    In most cases, only a single subregion is specified.

Examples:
    SUBREGION ON
    SUBREGION OFF
    SUBREGION ON ON ON
Note:
    The coordinates for the subregion areas are set with the SUBREGION LIMITS command.
Note:
    The subregions are plotted before any of the plot curves. The significance of this is that a solid filled subregion will be drawn and then the regular plot points are drawn on top. The effect of this can be hardware dependent. On X11 and Postscript devices, a solid character can be seen on top of a light gray scale box (if the gray scale gets too dark, the plot points are no longer distinguishable). However, on some hardware devices, you may not be able to see points plotted on top of a solid fill region. In this case, plot the border of the subregion and leave the interior blank.

    It is this order of plotting that distinguishes the subregion from simply using a BOX <id> command to plot rectangular regions on the screen.

Note:
    For the first subregion defined, Dataplot returns the following internal parameters on subsequent plots:

      NACCEPT = number of plot points inside the subregion.
      NREJECT = number of plot points outisde the subregion.
      NTOTAL = number of plot points (NACCEPT + NREJECT).

Note:
    You do not need to adjust the settings for the CHARACTER, LINE, BAR, and SPIKE when using subregions. DATAPLOT automatically shifts these in the background. The attributes for the subregion are set with the following commands:

      REGION FILL
      REGION COLOR
      REGION BORDER LINE
      REGION BORDER COLOR

    The REGION FILL and REGION COLOR determine the attributes of the interior of the rectangle. The two most common choices are to leave it blank or to fill it with some type of light gray scale color. The attributes of the rectangle border are set with the REGION BORDER LINE and REGION BORDER COLOR commands. The standard line types (SOLID, BLANK, DASH, DOTTED) are supported. If you have more than one subregion defined, you should specify multiple settings on the above commands. For example,

      REGION FILL ON ON ON
      REGION COLOR G25 G25 G25

Note:
    The SUBREGION command with no argument turns off all subregions.
Default:
    No subregions are drawn.
Synonyms:
    None
Related Commands: Applications:
    Denoting "Engineering Limits" on plots.
Implementation Date:
    2000/1
Program:
    dimension 50 variables
    skip 25
    read simon1.dat y1 y2 x1 x2 x3 x4 x5 block runseq
    .
    char x
    line blank
    .
    subregion on
    subregion xlimits 0.35 0.42
    subregion ylimits 2000 3000
    region fill on
    region border line dash
    region color g90
    .
    plot y1 vs x1
    .
    move 20 80
    text n = ^ntotal
    move 20 75
    text accept = ^naccept
    move 20 70
    text reject = ^nreject

    plot generated by sample program

Privacy Policy/Security Notice
Disclaimer | FOIA

NIST is an agency of the U.S. Commerce Department.

Date created: 06/05/2001
Last updated: 11/05/2015

Please email comments on this WWW page to alan.heckert@nist.gov.