STScI Logo

counts_plot xray.xspectral


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

NAME

counts_plot -- plots the observed and predicted spectra

USAGE

counts_plot

DESCRIPTION

Plots the data points of the observed spectrum, as well as a histogram of the predicted spectrum, if one has been computed. The data points that were used in the fit will be labeled with boxes. 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_obs.tab]

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

The file names of one or more observed data sets to be plotted. Multiple observation data sets can be specified by entering the file names, separated by semicolons, e.g. "foo1; foo2; foo3", etc. counts_plot will plot the first dataset; cursor commands allow paging to other datasets. Normally the dataset files have a "_obs.tab" extension. This extension need not be input explicitly; if the files do not follow this convention the explicit name should be typed.

Channels to fit for a given data set may be selected by appending a bracket notation to the file name. Thus "foo[3:11,15]" will cause channels 3 to 11 (inclusive) and 15 to be fit. If channels are not explicitly specified, the default channels for the given instrument are retrieved from the pkgpars parameter file.

(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 = "") [string]

The title of the plot. If this is null ("") the task will choose "Photon Counts" as the default.

(x_axis_title = "") [string]

The x axis title. If this is null ("") the task will choose "keV" as the default.

(y_axis_title = "") [string]

The y axis title. If this is null ("") the task will choose "counts" as the default.

(ipc_minimum_energy = 0.1) [real]

The minimum energy to be displayed on an IPC plot.

(ipc_maximum_energy = 10.0) [real]

The maximum energy to be displayed on an IPC plot.

(mpc_minimum_energy = 1.0) [real]

The minimum energy to be displayed on an MPC plot.

(mpc_maximum_energy = 25.0) [real]

The maximum energy to be displayed on an MPC plot.

(ein_hri_minimum_energy = 0.1) [real]

The minimum energy to be displayed on an Einstein HRI plot.

(ein_hri_maximum_energy = 10.0) [real]

The maximum energy to be displayed on an Einstein HRI plot.

(pspc_minimum_energy = 0.1) [real]

The minimum energy to be displayed on a PSPC plot.

(pspc_maximum_energy = 3.0) [real]

The maximum energy to be displayed on a PSPC plot.

(ros_hri_minimum_energy = 0.1) [real]

The minimum energy to be displayed on a ROSAT HRI plot.

(ros_hri_maximum_energy = 3.0) [real]

The maximum energy to be displayed on a ROSAT HRI plot.

(hepc1_minimum_energy = 2.0) [real]

The minimum energy to be displayed on an SRG HEPC1 plot.

(hepc1_maximum_energy = 30.0) [real]

The maximum energy to be displayed on an SRG HEPC1 plot.

(lepc1_minimum_energy = 0.2) [real]

The minimum energy to be displayed on an SRG LEPC1 plot.

(lepc1_maximum_energy = 8.0) [real]

The maximum energy to be displayed on an SRG LEPC1 plot.

(device = "stdgraph") [string]

The output graphics device.

(cursor = "") [*gcur]

Graphics cursor input.

EXAMPLES

The following example plots the predicted and the observed data, but changes the default plot title from "Photon Counts" to "My fit results".


	xs> counts_plot plot_title="My fit results"
	observed spectrum [root_obs.tab]: snr

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

TIME REQUIREMENTS

This tasks normally executes promptly, in less than 10 seconds.

BUGS

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

bal_plot, grid_plot, fit, singlefit, pkgpars


Search Form · STSDAS