STScI Logo

chiplot xray.xtiming


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

NAME

chiplot - Graph a Chi-Square Table

USAGE

chiplot table

DESCRIPTION

CHIPLOT graphs the output file created by the task PERIOD . CHIPLOT has default parameters set to plot a histogram of Chisq vs. Period (seconds). The input is the root_chi.tab file. Further customizations effecting titles, axes labels and tics, and plotting data subsets are available to the user. The iraf IGS plot commands are available to the user to further expand, zoom, and query the plot.

PARAMETERS

table = prompt = Input Table File

Table file to be plotted.

outplt = prompt = Plot output file

Filename of output plot. Required when parameter hdcopy is yes . This file is left in the user's directory after termination of this task. It can be reprinted using the STPLOT package SGIKERN task.

(column = "chisq") [string]

Column name of plot data. The name must be input as it appears in the table. The data corresponding to the column name is read from the table file and plotted.

(plot_type = "histo") [string]

Type of plot, either histo or bar . If plot_type is "histo" a histogram of the column data will be plotted. If the plot_type is "bar" the column data will be plotted as horizontal bars. Default is set to histo .

(ecolumn = "") [string]

Column name of error data to be plotted. This is an option only if plot_type is "histo" and will appear as error bars on the graph. Ecolumn is the name of the error data associated with the column. The name must be input as it appears in the input table.

(plot_title = "Chi Square :") [string]

Title for plot.

(x_title = "period (seconds)") [string]

Title for X-axis.

(y_title = "") [string]

Title for Y-axis.

(hdcopy = no) [boolean]

yes prints a hardcopy of the plot to the printer and no displays the plot on the screen. Default is set to no .

(gclose = no) [boolean]

No leaves task in graphics window - type q to quit. Yes closes plot and returns to the cl. Default is set to no .

(num_plots = 1) [int]

Number of plot windows in which to display the data. Data will be evenly divided among the specified number of windows.

(x_units = "seconds") [string]

X-axis label. Default is seconds . Header parameters must be present for seconds to work. x_units will default to bin if header parameters are missing. If the input _chi.tab file was made with the PERIOD parameter `chisq_thresh` set to exclude chisq values. (See example 2 below.)

(x_tics = 4.) [real]

Number of tic labels on x-axis. This is the approximate number of tics and corresponding labels along the x-axis. The task chooses evenly spaced round numbers for labels and thus the actual number of labels may not be exactly that which was chosen.

(y_tics = 4.) [real]

Number of tic labels on y-axis. This is the approximate number of tics and corresponding labels along the y-axis. The task chooses evenly spaced round numbers for labels and thus the actual number of labels may not be exactly that which was chosen.

(label_size = 0.75) [real]

Plotting Header and axis labels format size. This is the size of the labels for the plot header and X & Y axis labels. The format is set to a reasonable size. Adjust this value by 1/10's to change the size of the labels.

(tlabel_size = 0.5) [real]

Strip plot tic label format size. This is the size of the labels on the axis tic marks. Small adjustments to this value dramaticly affect the size. This value should be decreased slightly (by 1/10's) when the number of plots is large and the labels run into adjoining plot windows.

(x_range = "auto") [string]

Either auto which will plot entire file length or a Range consisting of a min and max.

(y_range = "auto") [string]

Either auto which will plot all histogram values or a Range consisting of a min and max.

(clobber = no) [boolean]

Boolean flag specifying whether or not the plot file can be overwritten if it already exists (i.e. postscript plot file). Does not apply to window graphics. Used when hardcopy equals yes .

(cursor = "") [string]

Stores cursor commands taken in interactive graphics mode.

EXAMPLES

1. Plot a histogram of the chisq table snr1_chi.tab.


        xt> chiplot
        Input Table File: snr1_chi

2. Plot a histogram of the chisq table snr1chi15_chi.tab. Input file contains only those chisq values that exceed 15. See example 2 of the PERIOD help file for information on generating input file. x_units will default to BIN. Close the plot window by setting gclose = yes.

	xt> chiplot "snr1chi15_chi" gclose+

** Period Increment NOT constant - will plot bins **

	xt>

TIME REQUIREMENTS

BUGS

SEE ALSO

Documentation on making a chisq (help period)

Documentation on graphing timing tables (help timplot)

Documentation on graphics cursor commands (help cursors)


Source Code · Search Form · STSDAS