STScI Logo

bal_plot xray.xspectral


NAME · USAGE · DESCRIPTION · PARAMETERS · EXAMPLES · TIME_REQUIREMENTS
BUGS_AND_LIMITATIONS · SEE_ALSO

NAME

bal_plot -- plots the BAL histogram for the current dataset (Einstein IPC data only).

USAGE

bal_plot

DESCRIPTION

Plots the BAL histogram for the indicated dataset. Note that a BAL histogram is only meaningful for Einstein IPC data. Also, note that the task leaves you in "cursor input" mode. Type a "?" to obtain a help menu in cursor input mode. Type a "q" to exit back to the CL.

PARAMETERS

observed = "" prompt = observed spectrum [root_bal.tab]

This is a package wide parameter, found in the pkgpars parameter file.

The file name normally defaults to the data set just analyzed and will be set automatically. However, for doing BAL_PLOTS that have not just been analyzed, please enter just the main filename root (before the _) and the task will generate the correct filename extensions.

dataset_numb = prompt = data set number

If there is more then one dataset given in the observed prompt, this parameter will be queried to determine which of these to plot.

(pkgpars = "") [pset]

The name of the file containing the xspectral package wide parameters. If the name is null ("") then the parameters found for the pkgpars task will be used.

(plot_title = "BAL histogram") [string]

The title of the plot.

(x_axis_title = "BAL") [string]

The x axis label.

(y_axis_title = "percent") [string]

The y axis label.

(listout = no) [boolean]

A boolean flag which indicates whether a listing is preferred instead of a plot.

(device = "stdgraph") [string]

The output graphics device.

(cursor = "") [*gcur]

Graphics cursor input.

EXAMPLES

The following example shows how to display the BAL histogram for one data set.


	xs> bal_plot
	observed spectrum [root_obs.tab]: snr

	[Type "q" to quit from graphics display.]

TIME REQUIREMENTS

This task normally executes in less than 10 seconds.

BUGS AND LIMITATIONS

The _obs.tab file name must not begin with a numeral. Beginning the file names of these files with a numeral causes the parser to attempt to process the numeral, resulting in an error.

SEE ALSO

counts_plot, grid_plot, pkgpars


Search Form · STSDAS