diff options
Diffstat (limited to 'noao/onedspec/irsiids/doc')
-rw-r--r-- | noao/onedspec/irsiids/doc/addsets.hlp | 66 | ||||
-rw-r--r-- | noao/onedspec/irsiids/doc/batchred.hlp | 145 | ||||
-rw-r--r-- | noao/onedspec/irsiids/doc/bswitch.hlp | 228 | ||||
-rw-r--r-- | noao/onedspec/irsiids/doc/coefs.hlp | 57 | ||||
-rw-r--r-- | noao/onedspec/irsiids/doc/coincor.hlp | 101 | ||||
-rw-r--r-- | noao/onedspec/irsiids/doc/extinct.hlp | 49 | ||||
-rw-r--r-- | noao/onedspec/irsiids/doc/flatdiv.hlp | 94 | ||||
-rw-r--r-- | noao/onedspec/irsiids/doc/flatfit.hlp | 188 | ||||
-rw-r--r-- | noao/onedspec/irsiids/doc/powercor.hlp | 62 | ||||
-rw-r--r-- | noao/onedspec/irsiids/doc/process.hlp | 20 | ||||
-rw-r--r-- | noao/onedspec/irsiids/doc/slist1d.hlp | 59 | ||||
-rw-r--r-- | noao/onedspec/irsiids/doc/subsets.hlp | 49 | ||||
-rw-r--r-- | noao/onedspec/irsiids/doc/sums.hlp | 44 | ||||
-rw-r--r-- | noao/onedspec/irsiids/doc/widstape.hlp | 90 |
14 files changed, 1252 insertions, 0 deletions
diff --git a/noao/onedspec/irsiids/doc/addsets.hlp b/noao/onedspec/irsiids/doc/addsets.hlp new file mode 100644 index 00000000..6ce49122 --- /dev/null +++ b/noao/onedspec/irsiids/doc/addsets.hlp @@ -0,0 +1,66 @@ +.help addsets Feb85 noao.imred.iids/noao.imred.irs +.ih +NAME +addsets - Add subsets of a string of spectra +.ih +USAGE +addsets input records +.ih +PARAMETERS +.ls input +The root file name for the input spectra in the string. +.le +.ls records +The range of spectra indicating the elements of the string. +The names of the spectra will be formed by appending the range +elements to the input root name. +.le +.ls output +This is the root file name for the names of the spectra which will +be created by the addset operation. +.le +.ls start_rec = 1 +The starting record number to be appended to the root name of the +created spectra. +.le +.ls subset = 2 +The length of the substring of spectra which will be added together. +For IIDS/IRS data which has been processed through BSWITCH, this +parameter should be 2. This implies that spectra will be taken +2 at a time, added, and the sum written as a new spectrum. +.le +.ls weighting = yes +If set to yes, an average of the substring of spectra is generated +(if flux calibrated) weighted by the integration times of the +individual spectra. If set to no, a simple average is generated. +If not flux calibrated, this parameter has no effect - a simple +sum is generated. +.le +.ih +DESCRIPTION +Every "subset" group of spectra will be accumulated and the sum will be +written as a new spectrum. For example, if the input string contains +100 spectra, and subset=2, then 50 new spectra will be created. Each +new spectrum will be the sum of the consecutive pairs in the original string. + +If there are insufficient spectra to complete a subset accumulation, +the sum is written out anyway and a warning printed. For example, +if the input string contains 23 spectra, and subset=4, there will be +6 new spectra created, but the last one will be based on only 3 spectra. + +Subset may be set to 1 to allow a copy operation although this is not +a very efficient way to do so. +.ih +EXAMPLES +The following three examples are those described above. + +.nf + cl> addsets nite1 2001-2100 + cl> addsets nite1 2001-2023 subset=4 + cl> addsets nite1 2001-2010 subset=1 output=nite2 \ + >>> start_rec=2001 +.fi +.ih +SEE ALSO +bswitch +.endhelp diff --git a/noao/onedspec/irsiids/doc/batchred.hlp b/noao/onedspec/irsiids/doc/batchred.hlp new file mode 100644 index 00000000..9301f8b0 --- /dev/null +++ b/noao/onedspec/irsiids/doc/batchred.hlp @@ -0,0 +1,145 @@ +.help batchred Feb85 noao.imred.iids/noao.imred.irs +.ih +NAME +batchred - Automated processing of IIDS/IRS spectra +.ih +USAGE +batchred +.ih +PARAMETERS +This script task has many parameters, but most are used as +variables internal to the task and are not user parameters. +There are 5 parameters having similar purposes: standard, +sensfunc, bswitch, calibrate, and addsets. Each corresponds +to the ONEDSPEC task of the same name and BATCHRED will generate +the commands necessary to invoke those tasks if the associated +parameter is set to yes (the default in all cases). + +.ls standard = yes +.le +.ls sensfunc = yes +.le +.ls bswitch = yes +.le +.ls calibrate = yes +.le +.ls addsets = yes +.le +.ls fnu = no +This parameter is identical to the fnu parameter for CALIBRATE. +.le +.ls wave1 = 0.0 +This parameter is identical to the wave1 parameter for BSWITCH. +.le +.ls wave2 = 0.0 +This parameter is identical to the wave2 parameter for BSWITCH. +.le +.ls subset = 32767 +This parameter is identical to the subset parameter for BSWITCH. +.le +.ih +DESCRIPTION +Through a question and answer session, a series of commands to +ONEDSPEC is generated which are then processed as a batch job +to reduce "typical" spectra from the IIDS and IRS spectrographs. + +By setting the appropriate hidden parameters, the user may +"turn off" command generation for any of the possible tasks. + +A script task is generated having the name "process.cl" which is +submitted to the CL as the final command of BATCHRED. +All terminal output which would normally appear during the course +of running each of the individual tasks is redirected to a log file +(default=ttylog). + +After the script has been generated, the user may suppress running +the processing task. The script file remains on disk so that subsequent +cases may be appended, such as when +several independent runs of data are to be processed in one +stream (e.g. several nights of data, each to be reduced separately). + +The questions which are asked are described below: + +"Root name for spectra file names:" This is the input root file name +for all spectra which will be run through STANDARD and BSWITCH. + +"Root name for spectra to be created:" This is the output root file +name which all newly created spectra will use. It is also the +input file name for tasks CALIBRATE and ADDSETS since these tasks +operate on spectra created by BSWITCH. + +"Starting record number for spectra to be created:" All created spectra +will have a suffix number starting with this value and incremented +by one for each new spectrum created. + +"File name to contain statistics information:" This file will contain +informative output from SENSFUNC and BSWITCH. (default=stats) + +"File name to contain a log of terminal output:" All tasks talk back +to let you know how things are proceding. The backtalk is saved +in this file. (default=ttylog) + +"File name for output from STANDARD and input to SENSFUNC:" Just +what it says. (default=std) + +"Record string to process:" The spectra are assumed to be representable +by strings (try "help ranges" for details on the formats allowed). +Both STANDARD and BSWITCH expect ranges of spectral record numbers +which are appended to the root given in answer to the first question +above. This question is asked repeatedly so that you can enter as +many strings of spectra as you like and is ended by hitting return +without entering a value. There is a short delay after entering +each string of records while a check is made to verify that all +your spectra actually exist. + +"Standard star name:" For each record string STANDARD expects +the name of the standard star observed, but it must be given in +a manner acceptable to STANDARD. (see STANDARD and LCALIB for +more details). + +"Use weighted averages:" If answered yes, then SENSFUNC and BSWITCH +will use their weighted averaging schemes. + +"Apply magnitude fudging:" If answered yes, then SENSFUNC will +use its "fudge" option. (see SENSFUNC) + +"Solve for grey additive extinction constant:" If answered yes, then +SENSFUNC will solve for this value. + +"File name for sensitivity image file:" This will be the root name +for the output sensitivity spectra from SENSFUNC. + +At anytime during the processing phase, you can inquire about the +progress by listing the latest contents of the file "ttylog" +either by "type ttylog" or by "tail ttylog". The latter command +lists the last 12 lines of the file. + +Be sure to have all your record strings, standard star names, +and options well planned and written down so that you can enter +the answers correctly. The batch reductions are not overly +tolerant of incorrect entries although some preliminary checks +are performed during the entry process. + +.ih +EXAMPLES + +The following invokes the batch reductions using all task options; + + cl> batchred + +The following inhibits the STANDARD and SENSFUNC tasks which must have +been run previously. This is equivalent to the IPPS "autoreduce": + + cl> batchred standard- sensfunc- +.ih +BUGS +If you make an error while entering the requested information, there +is no way to effect repairs other than to (1) start all over, or (2) edit +the generated script file "process.cl" using the system editor. + +If a task encounters an irrecoverable error, the background job +hangs until you kill it using "kill N" where N is the job number. +.ih +SEE ALSO +mkscript, standard, sensfunc, bswitch, calibrate, addsets +.endhelp diff --git a/noao/onedspec/irsiids/doc/bswitch.hlp b/noao/onedspec/irsiids/doc/bswitch.hlp new file mode 100644 index 00000000..a50647b4 --- /dev/null +++ b/noao/onedspec/irsiids/doc/bswitch.hlp @@ -0,0 +1,228 @@ +.help bswitch Sep87 noao.imred.iids/noao.imred.irs +.ih +NAME +bswitch - generate sky-subtracted accumulated spectra +.ih +USAGE +bswitch input records +.ih +PARAMETERS +.ls input +The root name for the input spectra to be beam-switched. +.le +.ls records +The range of spectra to be included in the beam-switch operation. +Each range item will be appended to the root name to form an image +name. For example, if "input" is "nite1" and records is "1011-1018", +then spectra nite1.1011, nite.1012 ... nite1.1018 will be included. +.le +.ls output +New spectra are created by the beam-switch operation. This parameter +specifies the root name to be used for the created spectra. +.le +.ls start_rec = 1 +Each new spectrum created has "output" as its root name and a trailing +number appended. The number begins with start_rec and is incremented +for each new spectrum. For example, if "output" is given as "nite1b" +and start_rec is given as 1001, then new spectra will be created as +nite1b.1001, nite1b.1002 ... +.le +.ls stats = "stats" +A file by this name will have statistical data appended to it, or created +if necessary. If a null file name is given (""), no statistical output +is given. For each aperture, a listing of countrates for each +observation is given relative to the observation with the highest rate. +.le +.ls ids_mode = yes +If the data are taken under the usual IIDS "beam-switch" mode, this +parameter should be set to yes so that accumulations will be performed +in pairs. But if the data are taken where there is no sky observation +or different numbers of sky observations, ids_mode should be set to no. +If weighting is in effect, ids_mode=yes implies weighting of the +object-sky sum; if ids_mode=no, then weighting is applied to the +object and sky independently because then there is no guarantee that +an object and sky observation are related. +.le +.ls extinct = yes +If set to yes, a correction for atmospheric extinction is applied. +The image header must have either a valid entry for AIRMASS or +for hour angle (or right ascension and sidereal time) and declination. +.le +.ls weighting = no +If set to yes, the entire spectrum or a specified region will be used +to obtain a countrate indicative of the statistical weight to be +applied to the spectrum during the accumulations. +.le +.ls subset = 32767 +A subset value larger than the number of independent spectra to be +added indicates that the operation is to produce a single spectrum +for each aperture regardless of how many input spectra are entered. +If subset is a smaller number, say 4, then the accumulations +are written out after every 4 spectra and then re-initialized to zero +for the next 4. +.le +.ls wave1 = 0.0 +If weighting=yes, this parameter indicates the starting point in the +spectrum for the countrate to be assessed. For emission-line objects, +this is particularly useful because the regime of information is then +confined to a narrow spectral region rather than the entire spectrum. +Defaults to the beginning of the spectrum. +.le +.ls wave2 = 0.0 +This provides the ending wavelength for the countrate determination. +Defaults to the endpoint of the spectrum. +.le +.ls observatory = "observatory" +Observatory at which the spectra were obtained if +not specified in the image header by the keyword OBSERVAT. The +observatory may be one of the observatories in the observatory +database, "observatory" to select the observatory defined by the +environment variable "observatory" or the task \fBobservatory\fR, or +"obspars" to select the current parameters set in the \fBobservatory\fR +task. See help for \fBobservatory\fR for additional information. +.le +.ls extinction = ")_.extinction" +The the name of the file containing extinction values. +Required if extinct=yes. +.le +.ih +DESCRIPTION +Data from multiaperture spectrographs are summed according to +aperture number and sky subtracted if sky observations are available. +Data for up to 50 apertures may be simultaneously accumulated. +The accumulated spectra are written to new images. + +The exposure times for each observation may be different. All +internal computations are performed in terms of count rates, +and converted back to counts (for statistical analysis) prior to writing +the new image. Therefore, the time on the sky and object may +be different as well. When these extensions to the normal +mode are required, the flag ids_mode must be set to no. +Then object and sky accumulations are performed totally +independently and a difference is derived at the conclusion +of the operation. + +If ids_mode is set to yes, then the usual IIDS/IRS "beam-switch" +observing mode is assumed. This implies that an equal number of +sky and object spectra are obtained through each aperture +after 2N spectra have been accumulated, where N is the number +of instrument apertures (2 for the IIDS/IRS). It is also assumed +that the object and sky exposure times are equal for each aperture. +Note that the "nebular" mode (where all instrument apertures +point at an extended object simultaneously, and then all apertures +point at sky simultaneously) is an acceptable form for +beam-switched data in ids_mode. + +The accumulations are optionally weighted by the countrate +over a region of the spectrum to improve the statistics during +variable conditions. The user may specify the region of spectrum +by wavelength. In ids_mode, the statistics are obtained from +object-sky differences; otherwise, the statistics are performed +on object+sky and sky spectra separately. + +The spectra may be extinction corrected if this has not already +been performed. +In order to perform either the extinction correction or the +weighting process, the spectra must have been placed on a linear +wavelength scale (or linear in the base 10 logarithm). + +Strings of spectra are accumulated to produce a single +summed spectrum for each observing aperture. But in some cases +it is desirable to produce summed spectra from subsets of the +entire string to evaluate the presence of variations either due +to observing conditions or due to the physical nature of the +object. A subset parameter may be set to the frequency at which +spectra are to be summed. + +In order that the processing occur with minimal user interaction, +elements from the extended image header are used to direct the +flow of operation and to obtain key observing parameters. +The required parameters are: object/sky flag (OFLAG=1/0), exposure +time in seconds (ITM), beam (that is, aperture) number (BEAM-NUM), airmass (AIRMASS) +or alternatively hour angle (HA) and declination (DEC), or +right ascension (RA), sidereal time (ST), declination (DEC), and the +observatory (OBSERVAT), +starting wavelength (W0), and wavelength increment per channel (WPC), +where the names in parenthesis are the expected keywords in the +header. If the observatory is not specified in the image the +observatory parameter is used. See \fBobservatory\fR for further +details on the observatory database. + +The following header flags are used as well: DC_FLAG +for dispersion corrected data (must=0), BS_FLAG for beam-switching +(must not be 1 which indicates the operation was already done), +EX_FLAG for extinction correction (if = 0 extinction is assumed already +done). + +The headers may be listed with the IMHEADER task, setting +the parameter "long" = yes. The values for the parameters follow +the rules used for IIDS and IRS data. + +After the beam-switch operation, the newly created spectra will +have header elements taken from the last object spectrum. +A few parameters will be updated to reflect the operation +(e.g. integration time, processing flags). + +.ih +EXAMPLES +The following example will accumulate a series of 16 spectra obtained +in the normal beam-switched mode and create two new extinction corrected +spectra having names nite1bs.1 and nite1bs.2: + + cl> bswitch nite1 1011-1026 nite1bs 1 + +The following example performs the same functions but accumulates the data +to produce 8 new spectra representing the individual object-sky pairs: + + cl> bswitch nite1 1011-1026 nite1bs 1 subset=4 + +The following example produces an extinction corrected spectrum for every +input spectrum. Note that ids_mode is set to off to generate separate object and +sky sums, and subset is set to 2 so that every pair of spectra (one object and +one sky) are written out as two new spectra: + + cl> bswitch nite1 1011-1026 nite1bs 1 subset=2 ids_mode- + +The next example produces a pair of spectra for each of 3 independent +objects observed, provided that each was observed for the same number +of observations (16 in this case). + +.nf + cl> bswitch nite1 1011-1026,1051-1066,1081-1096 nite1bs 1 \ + >>> subset=16 +.fi + +The next example shows how to use the weighting parameters where +the indicative flux is derived from the region around the emission-line +of 5007A. + +.nf + cl> bswitch nite1 1011-1026 nite1bs 1 weighting- \ + >>> wave1=4990, wave2=5020 +.fi +.ih +TIME REQUIREMENTS +The principle time expenditure goes toward extinction correcting the +data. For IIDS type spectra (length=1024 pixels), approximately 30 cpu +seconds are required to beam-switch a series of 16 spectra. +.ih +BUGS +The number of apertures is restricted to 50 and must be labeled +between 0 and 49 in the image header (the IIDS uses 0 and 1). + +Until an image header editor is available, BSWITCH +can be applied only to data with properly prepared headers +such as IIDS/IRS data read by RIDSMTN, RIDSFILE and some data via RFITS. + +When used to perform the function of extinction correction only (the +third example above), the statistics file fails to note the output +image name for the sky spectrum. + +The data must be on a linear wavelength scale. +The starting wavelength, W0, and a wavelength +per channel, WPC, are required header information, and the DC_FLAG +must be set to 0. +.ih +SEE ALSO +observatory, sensfunc, imheader, lcalib, ridsmtn, ridsfile, rfits +.endhelp diff --git a/noao/onedspec/irsiids/doc/coefs.hlp b/noao/onedspec/irsiids/doc/coefs.hlp new file mode 100644 index 00000000..777933bc --- /dev/null +++ b/noao/onedspec/irsiids/doc/coefs.hlp @@ -0,0 +1,57 @@ +.help coefs May85 noao.imred.iids/noao.imred.irs +.ih +NAME +coefs -- Extract dispersion coefs from mtn HeNeAr headers +.ih +USAGE +coefs input records database +.ih +PARAMETERS +.ls input +The input image root name for the spectral images containing the +dispersion coefficients. +.le +.ls records +The range of records for which the root name applies. +.le +.ls database +The database file name which will contain the coefficients. +.le +.ih +DESCRIPTION +The spectra specified by the combination of the root name +and the records are scanned for the presence of dispersion +coefficients. If present, the coefficients and necessary +information are written to the file indicated by the database +parameter. This file an then be used by the linearization +program DISPCOR to correct any spectra for which the +database is appropriate. + +Each invocation of COEFS appends to the database file, or +creates a new file if necessary. + +The following assumptions are made concerning the coefficients, +which are always correct for IIDS and IRS mountain reduced +data at Kitt Peak. +.ls 5 (1) +The coefficients represent Legendre polynomials. +.le +.ls (2) +The coefficients apply to pixels 1 through 1024 in the original data. +.le +.ih +EXAMPLES +The following example reads the coefficients from the headers +for nite1 arc spectra taken near the beginning and end of the +night and creates a database file called nite1.db: + + cl> coefs nite1 3-4,201-202 nite1.db + +.ih +TIME REQUIREMENTS +Approximately 1 second per spectrum is required. This is primarily +overhead due to file access. +.ih +SEE ALSO +dispcor, identify +.endhelp diff --git a/noao/onedspec/irsiids/doc/coincor.hlp b/noao/onedspec/irsiids/doc/coincor.hlp new file mode 100644 index 00000000..74e002f3 --- /dev/null +++ b/noao/onedspec/irsiids/doc/coincor.hlp @@ -0,0 +1,101 @@ +.help coincor Feb87 noao.imred.iids/noao.imred.irs +.ih +NAME +coincor -- Correct detector count rates +.ih +USAGE +coincor input records +.ih +PARAMETERS +.ls input +The root file name of the input spectra. +.le +.ls records +The range of spectra. +The names of the spectra will be formed by appending the range +elements to the input root name. +.le +.ls output +This is the root file name for the corrected spectra. If no root name +is specified (specified with the null string "") then the operation +is done in place. +.le +.ls start_rec = 1 +The starting record number to be appended to the root name of the +created spectra. +.le +.ls ccmode = )_.ccmode +The mode used to model the detector count rate corrections. +In the following C(obs) is the observed count rate and C(cor) is the +corrected count rate. +.ls "photo" +Photoelectric photometer with discriminator mode. The count rate +correction is + + C(cor) = C(obs) * exp (C(obs) * deadtime) + +where the parameter \fIdeadtime\fR is the representative deadtime in seconds. +.le +.ls "iids" +IIDS correction given by + + C(cor) = (-ln(1-C(obs)*deadtime)/deadtime)**power + +where \fBdeadtime\fR is a parameter related to the sweep time used to +correct for coincidence losses and \fBpower\fR is a power law coefficient. +.le +.le +.ls deadtime = )_.deadtime +For the "photo" mode this parameter is the period, in seconds, during +which no counts can be registered by the detector. Note that this is +based on a per pixel basis. So if the discriminator dead period is of +order 50 nanoseconds and 2000 pixels are observed per readout, the +effective deadtime is about 10E-4 seconds. For the "iids" mode this +parameter defines the sweep time correction and has a value of 1.424E-3 +seconds. +.le +.ls power = )_.power +The IIDS power law coefficient. The standard value is 0.975. +.le +.ih +DESCRIPTION +The input spectra are corrected for detector count rate errors. If no +output root name is given then the operation is done in place. The type +of correction is specified by the parameter \fIccmode\fR. The available +modes are for a general photomultiplier with discriminator coincidence +correction, and the NOAO IIDS. The parameters for these modes are +\fIdeadtime\fR and \fIpower\fR. The exposure time, in seconds, is a +required image header parameter (keyword = EXPOSURE). + +The default mode is for the NOAO IIDS. The IIDS correction includes a +power law correction for a nonlinear effect in the IIDS image tube chain +which is not included by the mountain reduction software at the telescope. +If the spectra have been coincidence corrected at the telescope +then only the nonlinear power law correction is applied. + +The coincidence correction flag may take the values -1 for no correction, +0 for the IIDS correction with \fIpower\fR = 1 (the correction +applied by the mountain reduction software), 1 for the full IIDS +correction, and 2 for the photomuliplier mode correction. +.ih +EXAMPLES +The following example corrects a series of IIDS spectra: + + cl> coincor nite1 1-250 output=nite1cc start_rec=1 + +The following example corrects a series of spectra from the +Lick ITS: + +.nf + cl> coincor its 1-250 output=itscc start=1 ccmode=photo \ + >>> deadtime=2.4E-4 power=1 +.fi +.ih +TIME REQUIREMENTS +\fBCoincor\fR requires approximately 1 second per spectrum of length 1024. +.ih +SEE ALSO +.nf +The \fBimred.iids\fR package is designed for reducing NOAO IIDS spectra. +.fi +.endhelp diff --git a/noao/onedspec/irsiids/doc/extinct.hlp b/noao/onedspec/irsiids/doc/extinct.hlp new file mode 100644 index 00000000..66aca3d6 --- /dev/null +++ b/noao/onedspec/irsiids/doc/extinct.hlp @@ -0,0 +1,49 @@ +.help extinct Apr85 noao.onedspec +.ih +NAME +extinct -- Correct spectra for atmospheric extinction +.ih +USAGE +extinct root records output +.ih +PARAMETERS +.ls root +The root name for the input spectra to be corrected. +.le +.ls records +The range of spectra to be included in the extinction operation. +.le +.ls output +The root name for the output corrected spectra +.le +.ls start_rec +The starting record number for the output corrected spectra. +.le +.ls nr_aps = 2 +The number of instrument apertures for this data set. +.le +.ih +DESCRIPTION +The input spectra are corrected for atmospheric extinction. +EXTINCT redirects the spectra through the task BSWITCH so all +procedures are identical to those described for that task. + +Because BSWITCH attempts to perform a beam-switch operation +unless the subset parameter is equal to the number of +instrument apertures (in which case beam-switching degenerates +to a copy operation), the hidden parameter nr_aps should be set +appropriately to the instrument. For IIDS and IRS data, this +is 2. +.ih +EXAMPLES + + cl> extinct nite1 1001-1032 nite1ex +.ih +BUGS +The input string of spectra must be ordered so that only +one spectrum from each aperture is present among substrings +of length nr_aps. +.ih +SEE ALSO +bswitch +.endhelp diff --git a/noao/onedspec/irsiids/doc/flatdiv.hlp b/noao/onedspec/irsiids/doc/flatdiv.hlp new file mode 100644 index 00000000..e6e8c22e --- /dev/null +++ b/noao/onedspec/irsiids/doc/flatdiv.hlp @@ -0,0 +1,94 @@ +.help flatdiv Dec86 noao.imred.iids/noao.imred.irs +.ih +NAME +flatdiv -- Divide spectra by flat field spectra +.ih +USAGE +flatdiv input records +.ih +PARAMETERS +.ls input +The root file name for the input records to be divided. +.le +.ls records +The range of spectra to be included in the divide operation. +Each range item will be appended to the root name to form an +image file name. +.le +.ls output +New spectra are created by the flatdiv operation. This parameter +specifies the root name to be used for the created spectra. +.le +.ls start_rec +Each new spectrum created as "output" has its root name and a +trailing number appended starting with "start_rec". Subsequent +output images will have an incremented trailing number. +Note that even if an output image is not created because the input +image has already been flattened or the input image is not found the +output record number is still incremented. +.le +.ls flat_file +The root name for the sensitivity spectra as produced by FLATFIT. +Normally with multi-aperture instruments, FLATFIT will produce a +spectrum appropriate to each aperture and the file name will have +"flat_file" as the file name root and the aperture number appended. +.le +.ls coincor = )_.coincor +If set to yes, coincidence correction is applied to the data during +the division, and the following three parameters are required. +For more about this correction see \fBcoincor\fR. +.ls ccmode = )_.ccmode +The mode by which the coincidence correction is to be performed. +This may be "iids" or "photo". +.le +.ls deadtime = )_.deadtime +The detector deadtime in seconds. +.le +.ls power = )_.power +Power law IIDS non-linear correction exponent. +.le +.le +.ih +DESCRIPTION +The input spectra are divided by the flat fields which are +represented by spectra produced by FLATFIT. + +To avoid possible division by zero, any zeroes in the flat field +spectra generated by FLATFIT are replaced by 1.0. + +The input spectra may optionally be corrected for coincidence losses. + +If the input and output spectra (after appending the record numbers) are +the same then the division is performed in-place; i.e. the flattened spectra +replace the original input spectra. +Note that even if an output image is not created because the input +image has already been flattened or the input image is not found the +output record number is still incremented. This is to insure that if +in-place division is desired that the input and output names remain +matched. +.ih +EXAMPLES +The following example divides a series of spectra to produce 20 new +spectra having names nite1.1221 ... nite1.1240. + + cl> flatdiv nite1 1201-1220 nite1 1221 + +The same spectra as above are simultaneously corrected for +coincidence losses. + + cl> flatdiv nite1 1201-1220 nite1 1221 coincor=yes + +The flattened spectra replace the unflattened spectra. + + cl> flatdiv nite1 1201-1220 nite1 1201 + +Note that the input record numbers must be contiguous and the starting +output record number must be the same as the first input record number. +.ih +TIME REQUIREMENTS +Approximately 1 second is required to correct a spectrum of length +1024 points. +.ih +SEE ALSO +coincor, flatfit +.endhelp diff --git a/noao/onedspec/irsiids/doc/flatfit.hlp b/noao/onedspec/irsiids/doc/flatfit.hlp new file mode 100644 index 00000000..af84cb3c --- /dev/null +++ b/noao/onedspec/irsiids/doc/flatfit.hlp @@ -0,0 +1,188 @@ +.help flatfit Dec86 noao.imred.iids/noao.imred.irs +.ih +NAME +flatfit -- Sum and normalize flat field spectra +.ih +USAGE +flatfit root records +.ih +PARAMETERS +.ls root +The root file name for the input names of the flat field +spectra to be accumulated and fit for normalization. +.le +.ls records +The range of spectra indicating the elements of the string. +The names of the spectra will be formed by appending the range +elements to the input root name. +.le +.ls output +This is the root file name for the names of the spectra which will +be created during normalization. The aperture number for the observation +will be appended to the root in form "root.nnnn" where nnnn is the aperture +number with leading 0's. +.le +.ls function = "chebyshev" +The accumulated spectra are fit by this function type - either +chebyshev or legendre polynomials, or spline3 or spline1 interpolators. +.le +.ls order = 4 +The order of the fit using the above function. This should generally be +a low order fit to avoid introduction of high spatial frequency wiggles. +.le +.ls niter = 1 +The number of iterations to reject discrepant pixels upon initial +startup of the solution. +.le +.ls lower = 2.0 +The number of sigmas for which data values less than this cutoff are +rejected. +.le +.ls upper = 2.0 +The number of sigmas for which data values greater than this cutoff are +rejected. +.le +.ls ngrow = 0 +The number of pixels on either side of a rejected pixel to also be rejected. +.le +.ls div_min = 1.0 +During the normalization process, a division by zero will produce +this value as a result. +.le +.ls interact = yes +If set to yes, graphical interaction with the normalization process +is provided for at least the first aperture for which sums are available. +If set to no, no interaction is provided. +.le +.ls all_interact = no +If set to yes, then interaction will be provided for all apertures +for which sums have been accumulated. If set to no then the parameter interact +will determine if the first aperture data is to be interactive. +.le +.ls coincor = )_.coincor +If set to yes, coincidence correction is applied to the data during +the summation process, and the following three parameters are required. +See \fBcoincor\fR for more about this correction. +.ls ccmode = )_.ccmode +The mode by which the coincidence correction is to be performed. +This may be "iids" or "photo". +.le +.ls deadtime = )_.deadtime +The detector deadtime in seconds. +.le +.ls power = )_.power +Power law IIDS non-linear correction exponent. +.le +.le +.ls cursor = "" +Graphics cursor input. When null the standard cursor is used otherwise +the specified file is used. +.le +.ih +DESCRIPTION +The specified spectra are added by aperture number to produce +summations which are then fit by a specified fitting function. +The fitting function is then divided into the sum to produce a +normalized (to 1.0) sum in which the low frequency spatial +response has been removed. + +The resultant normalized images may then be divided into all other +data to remove the pixel-to-pixel variations without introducing +any color terms. The spectra may be used directly if they happen +to be object spectra in which the low frequency response is to be +removed. + +During the accumulation process the spectra may be corrected for +coincidence losses if the detector is subject to the phenomenon. + +After accumulating all input spectra, the pixels in each sum are +fit according to +the specified function. If the interactive switches are set, then +graphical interaction is made available. If only the interact parameter +is set to yes, then only the data from the first aperture will +be available for interaction. Data from subsequent apertures will +be fit using the same parameters and number of iterations as the +first. If the all_interact parameter is also +set, then data from each aperture will be presented for interaction. + +At each step in the fit, pixels which are discrepant by more than +"upper" sigmas above the fit, or "lower" sigmas below the fit, are +rejected. The rejection process may be applied many times (iterations) +to continue rejecting pixels. If the upper and lower sigmas are +not equal, the resulting fit will be biased slightly above the mean +(for lower < upper) or below the mean (upper < lower). This is useful +when the spectrum being fit is that of a star having either absorption +or emission lines. + +A display is presented of the sum and the fit through the data. +A status line is printed containing the fit type, the order of +the fit, the rms residual from the fit, and the number of data +points in the fit after one iteration of rejection. + +The following cursor keystrokes are then active: +.ls ? +Clear the screen and display the active keystrokes +.le +.ls / +Indicate active keystrokes on the status line +.le +.ls e +Change plot mode to an error plot. This display is defined +as the deviation from the fit divided by the data values [ (data - fit)/ data] +at each pixel +.le +.ls f +Change plot mode back to the fit through the data display +.le +.ls o +Change the order of the fit. +.le +.ls l +Change the lower rejection criterion (in units of sigma). +.le +.ls u +Change the upper rejection criterion. +.le +.ls s +Change both rejection criteria to the same value. +.le +.ls r +Reinstate rejected pixels. +.le +.ls i +Iterate one more time. +.le +.ls n +Iterate several more times - the user is prompted for the count. +.le +.ls q +Quit and accept the solution +.le +.ls <CR> +RETURN is the same as 'q' but a confirmation request to exit must be +answered as yes. +.le + +All keystrokes but ?,/,e,f, and q force another iteration which will +reject additional pixels. To fully inhibit pixel rejection, the sigmas +should be set to a large value (e.g. 100). +.ih +EXAMPLES +The following example will accumulate 8 spectra and fit the first +aperture data interactively but not the second, and apply coincidence +corrections to the sums. The upper and lower rejection criteria +have been altered to bias the seventh order fit to a higher level. + + cl> flatfit nite1 1-4,201-204 coin+ low=1.4 up=3 order=7 +.ih +BUGS +For some reason, the error plot is supposed to have a zero level line +drawn, but none appears. + +As in most of the IRAF software, the order of a fit refers to the number +of terms in the fit, so that a fit of order 1 implies a constant and order +2 implies a linear fit. +.ih +SEE ALSO +coincor, flatdiv +.endhelp diff --git a/noao/onedspec/irsiids/doc/powercor.hlp b/noao/onedspec/irsiids/doc/powercor.hlp new file mode 100644 index 00000000..e1f9c70e --- /dev/null +++ b/noao/onedspec/irsiids/doc/powercor.hlp @@ -0,0 +1,62 @@ +.help powercor Oct86 noao.imred.iids/noao.imred.irs +.ih +NAME +powercor -- Apply power law correction to mountain reduced spectra +.ih +USAGE +powercor input records +.ih +PARAMETERS +.ls input +The root file name of the input spectra. +.le +.ls records +The range of spectra. +The names of the spectra will be formed by appending the range +elements to the input root name. +.le +.ls output +This is the root file name for the corrected spectra. +.le +.ls start_rec = 1 +The starting record number to be appended to the root name of the +created spectra. +.le +.ls power = )iids.power +The power law coefficient. +.le +.ih +DESCRIPTION +A power law correction to the IIDS count rates is applied to the input +spectra. The mountain reduction software applies a coincidence correction +to the observed IIDS count rates but does not correct for a nonlinear effect +in the image tube chain. This second correction takes the form of a +power law + + C(out) = C(in) ** power + +where C(in) is the input, coincidence corrected, count rate and C(out) +is the corrected count rate. The power is a parameter of the task +which defaults to the \fBiids\fR package parameter set to the appropriate +value for the IIDS. The exposure time, in seconds, is a required +image header parameter (keyword = EXPOSURE) used to convert the +total counts to count rates. + +Note that if the original raw spectra are being reduced then the either +\fBcoincor\fR or \fBpowercor\fR may be used to apply both the coincidence +correction and the power law correction at the same time. In other words, +the tasks apply the coincidence correction if the coincidence flag (CO-FLAG) is +-1 (uncorrected) and the power law correction alone if the flag is zero +(coincidence corrected only). The flag is 1 when both the coincidence and +nonlinear correction have been applied. + +This task is a script calling \fBcoincor\fR with \fIccmode\fR = "iids". +.ih +EXAMPLES +The following example corrects a series of IIDS spectra: + + cl> powercor nite1 1-250 output=nite1cc start_rec=1 +.ih +SEE ALSO +coincor +.endhelp diff --git a/noao/onedspec/irsiids/doc/process.hlp b/noao/onedspec/irsiids/doc/process.hlp new file mode 100644 index 00000000..5cedcde3 --- /dev/null +++ b/noao/onedspec/irsiids/doc/process.hlp @@ -0,0 +1,20 @@ +.help process Oct85 noao.imred.iids/noao.imred.irs +.ih +NAME +process -- A task generated by BATCHRED +.ih +USAGE +process +.ih +DESCRIPTION +The task \fBbatchred\fR creates a script called process.cl for batch +reductions. \fBBatchred\fR also has an option to automatically run +this script. +.ih +EXAMPLES +The task \fBbatchred\fR is run to setup a set of beam switching operations. +It creates the script \fBprocess.cl\fR which the user runs as a background +process as follows: + + cl> process& +.endhelp diff --git a/noao/onedspec/irsiids/doc/slist1d.hlp b/noao/onedspec/irsiids/doc/slist1d.hlp new file mode 100644 index 00000000..6c7d2702 --- /dev/null +++ b/noao/onedspec/irsiids/doc/slist1d.hlp @@ -0,0 +1,59 @@ +.help slist1d Jan92 noao.imred.irs/iids +.ih +NAME +slist1d -- List spectral header information +.ih +USAGE +slist1d input records +.ih +PARAMETERS +.ls input +The image root name for the spectra to be listed. +.le +.ls records +The record string for the spectra to be listed. The records will be appended +to the root name to form image names of the type "root.xxxx". +.le +.ls long_header = no +If set to yes, then a complete listing of the header elements +is given. If set to no, then a single line per spectrum is given which lists +in the following order: the image name, object or sky spectrum, exposure +time, spectrum length, and image title. +.le +.ih +DESCRIPTION +Each spectrum in the list implied by the root name and the record string +is opened and the header is read. The pixel file is not accessed in order +to save time. The header listing is directed to STDOUT and may be +redirected for printing. + +A warning message is issued if +a requested image is not found, but otherwise proceeds. +.ih +EXAMPLES +The following example lists 8 spectral headers in long form on the printer: + +.nf + cl> slist1d nite1 1001-1008 | lprint +.fi + +The next example lists the same spectral headers but in short form +on the terminal + +.nf + cl> slist1d nite1 1001-1008 long- +.fi +.ih +REVISIONS +.ls SLIST1D V2.10 +This task is the same as V2.9 \fBslist\fR and applies only to the older +IRS/IIDS record extension spectra. In V2.10 \fBslist\fR +has been revised for multiaperture spectra. +.le +.ih +BUGS +SLIST1D does not inform the user if the pixel file can or cannot be read. +.ih +SEE ALSO +slist, imheader +.endhelp diff --git a/noao/onedspec/irsiids/doc/subsets.hlp b/noao/onedspec/irsiids/doc/subsets.hlp new file mode 100644 index 00000000..a9f0ae68 --- /dev/null +++ b/noao/onedspec/irsiids/doc/subsets.hlp @@ -0,0 +1,49 @@ +.help subsets May85 noao.imred.iids/noao.imred.irs +.ih +NAME +subsets - Subtract pairs of spectra in a string +.ih +USAGE +subsets input records +.ih +PARAMETERS +.ls input +The root file name for the input spectra in the string. +.le +.ls records +The range of spectra indicating the elements of the string. +The names of the spectra will be formed by appending the range +elements to the input root name. +.le +.ls output +This is the root file name for the names of the spectra which will +be created by the subtraction operation. +.le +.ls start_rec +The starting record number to be appended to the root name of the +created spectra. +.le +.ih +DESCRIPTION +Pairs of spectra are formed from the input string in the order that +the record numbers would suggest. +The first spectrum in the pair is assumed to be the +principle spectrum and the second spectrum in the pair is subtracted +from the first. The result is written out as a new spectrum. + +No compensation is made for exposure time during the subtraction. +The header from the principle spectrum is assigned to the output +spectrum. + +.ih +EXAMPLES +The following example forms 50 new spectra from nite1.2001-nite1.2002, +nite1.2003-nite1.2004, ... + + cl> subsets nite1 2001-2100 + +The following example creates new spectra from the pairs nite2.2001-nite2.2002, +nite2.2003-nite2.2004 in spite of the order of the record numbers entered. + + cl> subsets nite2 2001,2003,2002,2004 +.endhelp diff --git a/noao/onedspec/irsiids/doc/sums.hlp b/noao/onedspec/irsiids/doc/sums.hlp new file mode 100644 index 00000000..0d8b27e9 --- /dev/null +++ b/noao/onedspec/irsiids/doc/sums.hlp @@ -0,0 +1,44 @@ +.help sums Jul85 noao.imred.iids/noao.imred.irs +.ih +NAME +sums -- Generate sums of the sky and object spectra for each aperture +.ih +USAGE +sums input records +.ih +PARAMETERS +.ls input +The root file name for the input spectra in the string. +.le +.ls records +The range of spectra indicating the elements of the string. +The names of the spectra will be formed by appending the range +elements to the input root name. +.le +.ls output +This is the root file name for the names of the spectra which will +be created by the summation operation. +.le +.ls start_rec +The starting record number to be appended to the root name of the +created spectra. +.le +.ih +DESCRIPTION +All the object spectra for each aperture are summed, and the +sky spectra are also summed to produce two new spectra for +each observing aperture. Exposure times are accumulated. +No tests are made to check whether the object is consistent +among the specified spectra. This could be accomplished by +checking the titles or telescope positions, but it isn't. + +The header parameters OFLAG and BEAM-NUM must be properly +set in the headers. +.ih +EXAMPLES +The following example forms 4 new spectra from nite1.2001-nite1.2002, +nite1.2003-nite1.2004, ... assuming this string is derived from +IIDS spectra. + + cl> sums nite1 2001-2100 +.endhelp diff --git a/noao/onedspec/irsiids/doc/widstape.hlp b/noao/onedspec/irsiids/doc/widstape.hlp new file mode 100644 index 00000000..855f223d --- /dev/null +++ b/noao/onedspec/irsiids/doc/widstape.hlp @@ -0,0 +1,90 @@ +.help widstape Mar85 noao.imred.iids/noao.imred.irs +.ih +NAME +widstape -- Write a Cyber style IDSOUT tape +.ih +USAGE +widstape idsout input records +.ih +PARAMETERS +.ls idsout +The output file name to receive the card-image data. This may be a +magtape specification (e.g. mta, mtb) or disk file name. +.le +.ls input +The input root file name for the spectra to be written +.le +.ls records +The record string to be appended to the root name to create the image +names of the spectra to be written. +.le +.ls new_tape = no +If set to yes, the tape is rewound and output begins at BOT. If no, +output begins at EOT unless an explicit file specification is given +as part of the magtape file name for parameter "idsout" (e.g. mta[2]). +If idsout contains a file specification of [1], then writing begins +at BOT regardless of the value for new_tape. +.le +.ls block_size = 3200 +The tape block size in bytes. This must be an integral factor of 80. +.le +.ls ebcdic = no +The default character code is ASCII, but if this parameter is set to yes, +the output character will be in EBCDIC. +.le +.ih +DESCRIPTION +The specified spectra are copied to the output file in a card-image format +defined in the IPPS-IIDS/IRS Reduction Manual. Values from the extended +image header are used to fill in the observational parameters. + +The basic format consists of 4 - 80 byte header cards, 128 data cards +having 8 data elements per card in 1PE10.3 FORTRAN equivalent format, +and a trailing blank card for a total of 133 cards. +Thus spectra up to 1024 points may be contained in the IDSOUT format. +The format is outlined below: + +.nf + Line Column Type + 1 1-5 Integer Record number within IDSOUT text file + 6-10 Integer Integration time + 11-25 Real Wavelength of first bin + 26-40 Real Dispersion + 41-45 Integer 0 (Index of first pixel) + 46-50 Integer Line length - 1 (Index of last pixel) + 71-80 Integer UT time + 2 1-10 Real Siderial time + 11-25 Real Right Ascension + 26-40 Real Declination + 3 21-35 Real Hour Angle + 36-50 Real Air mass + 51-58 Integer UT date + 60-76 String Image title + 78-80 String END + 4 1-64 String Record label + 78-80 String END +5-132 Real 1024 pixel values, 8 per line + 133 Blank line +.fi + +The data of type real are in exponent format; i.e FORTRAN 'E' format (1.234e3). + +There are no special marks between spectral images, +and when multiple spectra are written with a single command, the first card +of a subsequent spectrum may be within the same physical tape block +as the last card of the previous spectrum. This assures that all tape +blocks (except the very last one in the tape file) are all the same +length. A double end-of-mark is written after the last spectrum. +.ih +EXAMPLES +The following example writes an IDSOUT format tape starting at the +beginning of the tape. + + cl> widstape mta nite1 1001-1200 new_tape+ +.ih +TIME REQUIREMENTS: UNIX/VAX 11/750 +Each spectrum of 1024 points requires about 2 second. +.ih +SEE ALSO +rcardimage, ridsout +.endhelp |