STScI Logo

pros xray


NAME · DESCRIPTION · STANDARD_HELP · KEYWORD_HELP · PERSONAL_HELP
SCIENTIFIC_SPECIFICATIONS · SEE_ALSO

NAME

pros -- Supporting documentation (help files) for the xray package

DESCRIPTION

In addition to standard package and task help, which is available throughout all of IRAF, there are other types of help files available within the IRAF/XRAY package.

"Explain" help files give background information for the packages within the xray package (PROS) and contain detailed algorithm information. These are usually of the form:

                help explain_<package>   or phelp explain_<package>
Since PROS is designed as a set of independent tools, to provide maximum flexibility and user-customization, it is often necessary to run several individual tasks to perform a complete analysis. Help with accomplishing this type of approach is usually of the form:
                help using_<package>	or phelp using_<package>
and gives an overview of the interaction of the related tasks within the package.

"Extra" help files available in the PROS/XRAY package include:

    XRAY                                                
	    bugs                 filter
	    coords               missions
            exposure             qpoe 
            extensions           qpmerge 
            explain_errors    *  rosat_files
            explain_xdata        regions
            explain_screens   *  release_xray
            extensions        *  wcsbug
            file_compare         xspec_interface

    XSPATIAL
            prf (or psf)

    XSPATIAL.DETECT
            explain_detect
            using_detect

    XPLOT
            using_xplot

    XTIMING.TIMCOR
            using_timcor
            utc

    XSPECTRAL              
            using_spectral                          
            pspc_fitting                                     

      (  * = new help file in PROS 2.4.  )

STANDARD HELP

Standard package or task help is invoked with the desired task-name:

                help <task-name or package-name>
For a package name, this will provide a menu listing all tasks within the package with one-line descriptions of their functions, e.g.,
                help xray
                help xspectral

For a task name, detailed information about how to run specific tasks is displayed, including a description of input parameters, and examples of output, e.g.,

                help imcnts

KEYWORD HELP

Often times, it is more useful to do a keyword search, to find all TASKS relevant to a particular topic. For this there are two possible methods:

		references <keyword>
which is an IRAF facility available on all systems and also:
		xapropos  <keyword>
which is dependent on the CTIO/APROPOS task. PROS has built reference libraries from IRAF/NOAO/TABLES/PROS and STSDAS which will be searched.

PERSONAL HELP

If you have questions or need specific help unavailable in the on-line help, you can use e-mail to get support from:

		mail rsdc@cfa.harvard.edu
		mail 6699::RSDC

SCIENTIFIC SPECIFICATIONS

Some of the format Science Specification documents are also available in TeX format, as follows:


science spec:           	description:
------------			------------

xspatialdoc$spatial.<tex,dvi>	specs imsmooth,immodel,vignetting,
				imcontour, qpotate
xspatialdoc$arrayers.<tex,dvi>  specs for dealing with errors (imsmooth)
xtimingdoc$timing.<tex,dvi>	specs for timing tasks, ltcurv,fft,etc.
xspectraldoc$spectral.<tex,dvi>	specs for spectral fitting

Note that these files are tex (or dvi) files. You can `cd <package>doc$' and then use pstex or equivalent to make a hardcopy. Remember to cd back to your working directory afterwards.

SEE ALSO

See the help documentation in help help

See the phelp documentation, for paging the help file, in help phelp

See the xapropos documentation in help xapropos

See the references documentation in help references


Search Form · STSDAS