STScI Logo

timplot xray.xtiming


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

NAME

timplot - Make a strip plot of table stored timing data

USAGE

timplot table ycolumn outplt

DESCRIPTION

TIMPLOT makes a plot of data stored in table format. The parameters are set to reasonable default values but most of the values to customize a plot are available as hidden parameters. Changes can be made to the range of data plotted along the x and y axis, number of strips that the data is plotted in, specified x and y data ranges, and font sizes. The default is to plot all of the rows in the input table file along with the entire column range from minimum to maximum value. The iraf IGS plot commands are available to the user to further expand, zoom, and query the plot.

The input column names must be input as they appear in the file, and are plotted against the number of table rows. Error bars are optional. Outplt filename is only required when making a hardcopy.

PARAMETERS

table = prompt = Input Table File

Table file to be plotted.

column = prompt = Plot data column name

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.

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.

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

Title for plot.

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

X-axis label, either bin or seconds or freq phase . Default is bin . Header parameters must be present for seconds or freq or phase to work. x_units will default to bin if header parameters are missing.

(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. (i.e. If plotting x_unit=BIN, then x_range="10 200" will start the plot at bin 10 and end at 200.) (Use TIMPRINT to view table and choose range of values.)

(y_range = "auto") [string]

Either auto which will plot the entire range of histogram values or a Range consisting of a min and max value (i.e. y_range="0.5 2.9"), where the y-axis will be labelled and will display those points in the range (i.e. between 0.5 and 2.9 inclusive).

(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

Type `help ltcurv`, `help period` and `help fft` for information concerning
input files.

1. Plot a histogram of the count rate of light curve table snr_ltc.tab.


	xt> timplot
	Input Table File: snr_ltc
	Plot data column name: ctrt

2. Plot the power density distribution table sumd_pwr.tab plotting npower vs. bin. Increase the number of y_tics and x_tics to 8. Close the plot window when finished.

	xt> timplot.x_tics=8
	xt> timplot.y_tics=8
	xt> timplot.gclose=yes
	xt> timplot
	Input Table File: sumd_pwr
	Plot data column name: npower

	xt>

3. As in example 2 only in command line format.

	xt> timplot "sumd_pwr" "npower" x_tics=8 y_tics=8 gclose+

TIME REQUIREMENTS

BUGS

SEE ALSO


Source Code · Search Form · STSDAS