WRITE_HISTOGRAM_RZ 

Call: WRITE_HISTOGRAM_RZ


reference

The Histogram is referenced via a global variable or an expression in terms of global variables.

Histogram references can be created with calls to BOOK_HISTOGRAM or GET_HISTOGRAM. Histogram references are also created by arithmetic between existing histograms.

This parameter may be omitted, or be set to `ALL`, in which case all histograms are written to the RZ file.

[Default: all histograms are written.]


PAW_identifier

Garfield assigns a PAW identifier to the histogram which is the same as the internal Garfield identifier - but which does not bear an immediate relation to the global variable associated with the histogram (if any).

For this reason, Garfield prints the identifier when the histogram is written.

Garfield also prints the cycle number assigned by PAW. The cycle number will be 1 if the histogram identifier is not yet in use in the RZ file. The first cycle of a histogram can be accessed from PAW without special precautions:

h/pl 5

In case, however, that the RZ file already contains an histogram with the same identifier, then the newly written histogram will be assigned a higher cycle number. The histogram now has to be accessed as follows, assuming the cycle number is 3:

h/pl 5;3

file

A String which contains the name of the RZ file to which the histogram should be written.

The file may exist before the call is issued, but doesn't have to. If the file already exists, then it must be an RZ file formatted with a record length of 1024. The file may already contain other histograms.

[Default: `garfield.rz`.]


title

A String with the title to be assigned to the histogram.

The title is ignored if all histograms are to be written out. In that case, the histograms are given the name of the variable with which they are associated, as title.

[Default: the name of the global variable if the histogram is associated with a global variable, otherwise the field is left blank.]


Go to the top level, to Call, to WRITE_HISTOGRAM_RZ, to the topic index, to the table of contents, or to the full text.

Formatted on 21/01/18 at 16:55.