current_histogram

Context: py.chips

Syntax

current_histogram( ChipsId )
current_histogram( "histogram_id" )
current_histogram( "all" )

Description

The current_histogram command sets the histogram indicated by the argument as the current histogram; see "ahelp currency" for general information on currency.

ChipsId - an optional ChipsId structure containing values to modify the currency state for the command.
histogram_id - identification tag given to each object that is created; use this to select a specific histogram.
all - sets all histograms to be current.

Use the info_current command to retrieve a list of all the current items in the ChIPS session, as shown in Example 1.

Example 1

chips> id = ChipsId()
chips> add_histogram([5,8,13], [10, 15, 20], [12, 17, 22], "id=basic")
chips> add_histogram([8,10,14], [12, 17, 22], [14, 19, 24], [1,1,2],
["id", "witherrs", "symbol.style", "diamond", "err.style", "capped"])
chips> id.histogram = "basic"
chips> current_histogram(id)
chips> info_current()

Two histograms are created; the second histogram is current after it is created. The id.histogram command sets the histogram value of the ChipsId structure to the first histogram, then the current_histogram command makes that histogram current.

The output of info_current for this session is:

Window [win1]
  Frame [frm1]
    Plot [plot1]
        X Axis [ax1]
        Y Axis [ay1]
        Histogram [basic]
   Coord Sys [Data]
   Coord Sys ID [plot1_ax1ay1]

Example 2

chips> add_histogram([5,8,13], [10, 15, 20], [12, 17, 22],
"id=Histogram1")
chips> add_histogram([1,2,3], [10, 15, 20],["dropline", "off"])
chips> current_histogram("Histogram1")

Two histograms are created. After the second histogram is created, it is current. The current_histogram command then sets the first histogram as the current histogram.

Example 3

chips> add_histogram([5,8,13], [10, 15, 20], [12, 17, 22], "id=basic")
chips> add_histogram([8,10,14], [12, 17, 22], [14, 19, 24], [1,1,2],
["id", "witherrs", "symbol.style", "diamond", "err.style", "capped"])
chips> current_histogram("all")

Two histograms are created. After the second histogram is created, it is current. The current_histogram command then makes all histograms current.

Bugs

See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.