dish - Tool

Postscript file available

dish tool (user functions)

include "dish.g"

Constructors

dish	single dish analysis tool

Functions

accum	Add spectrum to the accumulator.
addstack	Append new scans to the stack.
ave	Average the contents of the accumulator.
aver	Average a group of scans or subscans.
avgpols	Average the polarizations in the globalscan1 spectrum
base	Perform a polynomial baseline fit, all in one function. An alternative step-by-step method is to use the nfit, setregion, bshape, and baseline functions
baseline	Perform a polynomial baseline fit to spectrum in globalscan1
bdrop	Set number of channels to drop from the beginning of a spectrum, used only in displaying.
bias	Add a bias to the scan in memory
boxcar	Perform a boxcar smoothing
bshape	Show the baseline fit
cal	Apply calibration to a scan (GBT only currently).
calib	Apply calibration to a scan (GBT only currently).
clearrm	Clear all variables from results manager
clip	Clip/Edit data (set flags)
copy	Copy a variable in the global record to another location
dcbase	Subtract a DC baseline (0th order poly) from the spectrum
delete	Delete a single entry from the stack.
divide	Divide globalscan1 by offscan1.
done	Exits dish and destroys the current dish tool.
edrop	Set number of channels to drop from the end of a spectrum, used only in displaying.
empty	Clear the stack.
filein	Sets the scan group used by scan access functions.
fileout	Sets the scan group that can be written to.
files	Prints the currently set values for filein and fileout.
find	Search all glish variables for a specified string.
flag	Flag data based on various specifications.
galactic	Provide coordinates of the globalscan1 spectrum in the Galactic reference frame.
gauss	Fit gaussian profiles.
gbtsum	Summarize scans in GBT projects from the /home/gbtdata area (GB only)
getc	Retrieve calibrated data (from the CORRECTED_DATA column)
getr	Retrieve raw data (from the FLOAT_DATA column)
getscan	Retrieve a scan (SDRecord) from a scan group.
getvf	Prints the velocity and frequency for a specified channel.
getvfarray	Return the velocities and frequencies for the globalscan1 spectrum.
gms	Summarize the scans in the currently opened data set.
gsflag	Flag some channels in the globalscan1 spectrum
gsget	Retrieves the globalscan1 record to a glish variable
gsput	Sends an sdrecord from glish to the globalscan1 record
gsread	Retrieve a spectrum saved to disk into the globalscan1 record
gswrite	Write the globalscan1 spectrum to disk
gui	Toggles mapping of DISH main gui (results manager).
hanning	Perform a hanning smooth
header	Print formatted header information to the command line window
help	Provide simple help on dish functions
history	Add a string or vector of strings to the history of a current SDRecord.
imagems	Make an image from all scans in a MeasurementSet.
imcal	Calibrate an imaging/mapping procedure
import	Import GBT data into an AIPS++ MeasurementSet
keep	Saves the current globalscan1 SDRecord to the designated fileout.
listscans	List the scan numbers from the active scan group.
logcommand	Writes command to scripter.
lsoutfile	Lists scans in the fileout scangroup
makeim	Make an image from scans in a MeasurementSet.
message	Writes text to the DISH GUI message line.
minus	Subtract offscan1 from globalscan1.
mscal	Calibrate a MeasurementSet.
mult	Scales (multiplies) a scan by a value.
multiply	Multiply globalscan1 by offscan1.
nfit	Set the order of the polynomial for baseline subtraction.
nogui	Dismisses the DISH main GUI.
nregion	Set the channel ranges for baseline subtraction.
open	Load a scan group from disk into DISH and perform a filein on it.
page	Clears the DISH plotter display.
peak	Obtain the peak amplitude, half-width and center in the displayed spectrum
plotc	Plot calibrated data (from the CORRECTED_DATA column)
plotr	Plot raw data (from the FLOAT_DATA column)
plotscan	Plot an SDRecord.
plotxy	Plot two vectors in the DISH plotter.
plus	Add offscan1 to globalscan1.
qscan	Query characteristics of scan.
reference	Designate the reference spectrum
restore	Retrieve the contents of the uni Record from disk.
restorestate	Restore the state of DISH's GUIs.
rmadd	Add an SDRecord to the results manager.
rms	Display statistics on baseline regions.
save	Save an SDRecord to file.
savestate	Save the current state of DISH.
saxis	Set the units of the x axis in the plotter
scale	Multiply the globalscan1 spectrum by a value.
scanadd	Add scan1 and scan2.
scanbias	Adds a bias level to a scan.
scandiv	Divide scan 1 by scan 2.
scanmult	Multiply scan 1 by scan 2.
scanscale	Multiply an sdrecord's spectrum by a value or array
scansrr	Performs a (signal-reference)/reference.
scansub	Subtract scan2 from scan1.
sclear	Clear the contents of the accumulator.
select	Select a subset of a scangroup.
setYUnit	Set the y-axis unit for a spectrum
setregion	Set the channel range for use in baseline subtraction
show	Display the globalscan1 SDRecord
show1	Display one polarization of the globalscan1 SDRecord
showref	Display the vref SDRecord
signal	Designate the signal spectrum
smooth	Smooth (hanning, boxcar or gaussian) an SDRecord.
stat	Generate statistics over a line region.
statefile	Changes file for state saving.
stats	Generate statistics over a region.
store	Store the contents of the uni Record to disk.
summary	List a summary for a Measurement Set
tellstack	Return contents of the stack.
upr	Print the current value of variables in the uni-record.
utable	Print channel and data columns to command window
writetofile	Write X,Y axes to an ascii file on disk.
zline	Draw a horizontal line at zero intensity on the plotter.

Description

Including ``dish.g'' loads the single-dish analysis environment and creates a default tool, d, for use.

dish knows how to read from and write to AIPS++tables which have been created from Single Dish FITS files (SDFITS). The documentation for dishdemodata provides more details. The Using Dish note has an appendix which describes the SDFITS convention. You can load one of these AIPS++tables (for example, the sample data generated by dishdemodata) into dish by using one of the two options in the File/Open menu. The difference between ``Read Only'' and ``Reading and writing'' when opening a dish data set is whether you can save a result to this data set through the save operation. It is generally a good idea to save to a different data set from your raw data. The File/New menu can be used to create an empty AIPS++table suitable for storing dish results. Choosing any one of the menu options (Read Only, Reading and writing or New) will launch a file chooser window. Simply select one of the files (or type in a new file) and press ``ok''. The program is now ready to use the contents of that table.

The ``Results Manager'' is where all of the variables created by dish are shown. These are all global symbols which you can manipulate directly at the glish prompt. There are three types of variables which dish creates and manipulates.

SDRecord - a glish record with a known structure. This holds the data plus header values for a single ``scan''. dish knows how to display SDRecords in the plotter. Selecting an SDRecord in the results manager window will always cause that SDRecord to be displayed on the plotter. SDRecords may also be browsed. In this context, pushing the browse button will launch a window which will allow you to browse the header values of this record. See the SDRecord information in the sditerator Tool.
SDIterators - these are also called working sets in the dish GUI. They are collections of SDRecords. The disk files which dish reads from and writes to are SDIterators/working sets as are any selections which are made from these files. Dish knows how to browse these. Pushing the browse button will launch a window which will allow you to select any of the records in this collection. When selected, it will be plotted. The header values for each selection may also be browsed through this browser. See also the sditerator tool documentation.
Anything else. Dish knows very little about these values. They can neither be plotter or browsed although they can be inspected.

The variables in the results manager come with a description which you can change by simply editing the description shown and pressing the return or enter key. Similarly, you can change the name of any variable by entering a new name in the entry in the results manager and pressing the return or enter key. The ``Delete'' button removes a variable completely from glish although it will not delete any files on disk.

To bring up the GUI for the operations, select one from the ``Operations'' menu. Due to the limited amount of screen real estate typically available, you will only be able to see a few operations at once. The operations each have a ``Dismiss'' button generally towards the lower left corner which will remove that frame from the dish window. This can also be achieved by re-selecting that operation from the ``Operations'' menu.

There are two types of operation: operations which operate on entire working sets and operations which operate on single SDRecords. Of the current operations, selection and averaging operate on entire working sets (selection produces a new working set and averaging produces a new record). The operations which operate on a single spectra always use the most recently viewed spectra (i.e. the one you see in the plotter). This is true even if the working set from which it came or the single record which produced that plot have been ``Delete''d from the results manager. What you see is what dish operates on. When a new scan is produced, the focus of the plotter and the program is automatically set to that result (i.e. it becomes the most recently displayed SD Record).

Baseline regions are all set through the ``Baselines'' operation. Whether you enter the ranges by hand or by using the plotter, if the "Plot ranges" option has been turned on, the ranges will be plotted on top of the data. The height of each range box on the plotter indicates the local RMS of the data and the center Y value of each range box indicates the local mean of the data. The statistics for all baseline regions are shown on the plotter in the statistics line.

A full example session, suitable for a demonstration, is given in AIPS++ Note 205.

Next: dish - Constructor Up: dish - Module Previous: dish - Module Contents Index

	Package	dish
	Module	dish