[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
LABEL_TAI()
PURPOSE:
This function labels axis with dates based on TAI.
CATEGORY:
Plotting
EXPLANATION:
SYNTAX:
Result = label_tai()
CALLED BY:
SUM_ANA_TEMP
EXAMPLES:
INPUTS:
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
DATE_FORMAT: a format string which may contain the following:
%M for month (3 character abbr)
%N for month (2 digit abbr)
%D for day of month,
%Y for 4 digit year.
%Z for last two digits of year.
%% is %.
%h for hour
%m for minute
%s for second
Other characters are passed directly thru.
For example, '%M %D, %Y' prints DEC 11, 1993
'%M %2Y' yields DEC 93
'%D-%M' yields 11-DEC
'%D/%N/%Y' yields 11/12/1993
'%M!C%Y' yields DEC on the top line, 1993 on
the bottom (!C is the new line graphic command).
MONTHS: The names of the months, a twelve element string array.
If omitted, use Jan, Feb, ..., Dec.
SET_TIME: Set Time Offset for input TAI (i.e. for SYSTIME(1) input)
REL_TIME: Output Values as Relative Time to SET_TIME
SHOW: Show Setup of Label_tai
CALLS: ***
ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2]
COMMON:
LABEL_TAI_COM
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 10, 1998, Dietmar Germerott, MPAE Lindau. Written
based on LABEL_DATE by DMS, RSI
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
LAS_AUTO_EXP
Do a "bootstrap" exposure correction to the currently selected
images.
Usage:
las_auto_exp
Arguments & Keywords: None
Method:
This routine make use of the 64x64 block in the centre of the
occulting disk which is now normally transmitted. It is
assumed that this retains a constant brightness. It is further
assumed that the exposures are correct on average.
CALLS: ***
OFFSET_BIAS, SXADDPAR [1], SXADDPAR [2], SXADDPAR [3], SXPAR [1], SXPAR [2]
SXPAR [3], ghandle, od_bright
Restrictions:
It is assumed that the images have been corrected for offset
bias and nominal exposure and that this is a fine adjustment.
History:
Original: 1/10/96; SJT
[Previous]
[Next]
LAS_EXP_NORM
Normalize images based on the integrated image intensities
Usage:
las_exp_norm, calib[, /store, /use_in_mem]
Arguments:
calib input string The name of the file with the
calibration image; at present this
must be a full path.
Keywords:
store ?? input If set, then add the calibration image
to the set of loaded images -- useful
if you want to form differences
from the calibration image.
all ?? input If set, then normalize ALL images, by
default only the currently selected
images are normalized.
use_in_mem ? input If set, then use the specified image
from the currently loaded images.
CALLS: ***
CHANDLE, READFITS [1], READFITS [2], READFITS [3], RSTRPOS, SXPAR [1], SXPAR [2]
SXPAR [3], chk_h4s, ghandle, mask_out, sigma_mask
CALLED BY:
w_las_exp_norm
Restrictions:
The STORE key is ignored if USE_IN_MEM is specified.
Side Effect:
Changes the values of the images.
History:
Original: Mar 96; SJT
[Previous]
[Next]
Project : SOHO - LASCO
Name : LASCO_FITSHDR2STRUCT
Purpose : Read a LASCO FITS file to obtain an image and header array.
Explanation : This routine calls the IDL Astronomy Library routine READFITS
to read the LASCO FITS file. It then fills in a LASCO header
structure with the header information.
Use : IDL> lasco_hdr = LASCO_FITSHDR2STRUCT(fits_hdr)
Inputs : fits_hdr FITS header, STRARR
Outputs : lasco_hdr LASCO header structure.
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], FILEPATH, FXPAR [1], FXPAR [2], TRIM
Category : Data_Handling, I_O
Prev. Hist. : None.
Written : Scott Paswaters, NRL, Feb. 1996.
Modified : 02/22/96 S. Paswaters Modified for DATE-OBS,TIME-OBS change
to FITS header.
08/30/96 S. Paswaters Perform STRTRIM(val,2) on type STR tags
ex: changes 'C1 ' to 'C1'
10/23/96 S. Paswaters added default structure to work with differing fits hdrs
11/10/97 S. Paswaters include multiple comment or history fields
11/30/01, N. Rich - Add Windows SSW compatibility for GSV
8/28/02, N. Rich - Use SSW recommendation for DATE_OBS (includes time) for Level 1 images
9/19/02, N. Rich - Change test for Level 1
4/14/03, N. Rich - Reverse SSW DATE_OBS change (because getbkgimg crashed)
Version :
10/02/02, 04/14/03 @(#)lasco_fitshdr2struct.pro 1.11 :LASCO IDL LIBRARY
CALLED BY
ADD_MISSING_BLOCKS, ADJUST_DATE_OBS, ADJUST_HDR_TCR, C2_CALFACTOR, C2_CALIBRATE
C2_WARP, C3_CALFACTOR [1], C3_CALIBRATE, C3_WARP, CHANDLE, CHECK_OBESUMERROR
DIFBKGND, GETBKGIMG, GET_EXP_FACTOR [1], GET_EXP_FACTOR [2], GET_IMG_CENTER
GET_PT, GET_ROLL_OR_XY, GET_SEC_PIXEL, GET_SOLAR_RADIUS, GET_SUN_CENTER [1]
GET_SUN_CENTER [2], GET_SUN_CENTER [3], IMG2DNPERSEC, LASCO_READFITS [1]
MAKE_IMAGE_EIT img hdr, MKDI_C1, MKMOVIE
MKMOVIE0 obsolete version of mkmoviepro, MK_IMG, MK_MONTHLY_MIN, OFFSET_BIAS
PB_INVERTER, REDUCE_LEVEL_05, REDUCE_STD_SIZE, REMOVE_CR, STDIMGPLOT
TELESCOPE_POINTING, UPDATE_HDR_ROLLXY, WRITE_LAST_IMG [2], poly_diffim, shandle
[Previous]
[Next]
NAME:
LASCO_GEN_HELP
PURPOSE:
This procedure goes through all the LASCO IDL directories and
generates a help file in HTML format of the form help_<directory>.html
CATEGORY:
Utility
CALLING SEQUENCE:
LASCO_GEN_HELP
INPUTS:
NONE
KEYWORD PARAMETERS:
NONE
OUTPUTS:
HTML Help Files in each directory are generated
CALLS: ***
LASCO_MK_HTML_HELP
EXAMPLE:
LASCO_GEN_HELP
MODIFICATION HISTORY:
8/17/05, nbr - use new features in lasco_mk_html_help.pro; do help_all.html;
write idl_pros.html
Written by: Dennis Wang
Created: 28 Jan 2001
@(#)lasco_gen_help.pro 1.1 01/29/01 LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - LASCO
Name : LASCO_IMAGE
Purpose : Read a LASCO FITS file to obtain an image and header array.
Explanation : This routine calls the IDL Astronomy Library routine READFITS
to read the LASCO FITS file. It then fills in a LASCO header
structure with the header information.
Use : IDL> image = LASCO_IMAGE('filename' [,header])
Inputs : filename Name of the LASCO FITS file.
Outputs : image The image array.
Opt. Outputs: header The image header can be returned either as a
LASCO header structure or a STRARR (FITS header).
Keywords : FITS_HDR The header is normally returned as a LASCO header
structure. Set this keyword to return the header
as a STRARR (FITS header).
Calls : ***
DEF_LASCO_HDR, READFITS [1], READFITS [2], READFITS [3]
Category : Data_Handling, I_O
Prev. Hist. : None.
Written : Scott Paswaters, NRL, January 1995.
Modified :
Version : Version 0.1, January 18, 1994
@(#)lasco_image.pro 1.1 10/04/96 LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
LASCO_MK_HTML_HELP
PURPOSE:
Given a list of IDL procedure files (.PRO), VMS text library
files (.TLB), or directories that contain such files, this procedure
generates a file in the HTML format that contains the documentation
for those routines that contain a DOC_LIBRARY style documentation
template. The output file is compatible with World Wide Web browsers.
CATEGORY:
Help, documentation.
CALLING SEQUENCE:
LASCO_MK_HTML_HELP, Sources, Outfile, ext='proc'
INPUTS:
Sources: A string or string array containing the name(s) of the
.pro or .tlb files (or the names of directories containing
such files) for which help is desired. If a source file is
a VMS text library, it must include the .TLB file extension.
If a source file is an IDL procedure, it must include the .PRO
file extension. All other source files are assumed to be
directories.
Outfile: The name of the output file which will be generated.
KEYWORDS:
TITLE: If present, a string which supplies the name that
should appear as the Document Title for the help.
VERBOSE: Normally, MK_HTML_HELP does its work silently.
Setting this keyword to a non-zero value causes the procedure
to issue informational messages that indicate what it
is currently doing. !QUIET must be 0 for these messages
to appear.
STRICT: If this keyword is set to a non-zero value, MK_HTML_HELP will
adhere strictly to the HTML format by scanning the
the document headers for characters that are reserved in
HTML (<,>,&,"). These are then converted to the appropriate
HTML syntax in the output file. By default, this keyword
is set to zero (to allow for faster processing).
EXT: Set equal to another extension (no dot) to make documentation
for.
DESCRIPTION: Set equal to name of an HTML-formatted textfile,
contents of which to be inserted after the title.
RECURSIVE If set, does recursive search (SCCS filtered out)
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], FILEPATH, MHH_GEN_FILE, MHH_GRAB_HDR
MHH_STRICT, READLIST
CALLED BY:
BUILD_LASCO_HELP, CDS_GEN_HELP, LASCO_GEN_HELP
COMMON BLOCKS:
None.
SIDE EFFECTS:
A help file with the name given by the Outfile argument is
created.
RESTRICTIONS:
The following rules must be followed in formatting the .pro
files that are to be searched.
(a) The first line of the documentation block contains
only the characters ";+", starting in column 1.
(b) There must be a line which contains the string "NAME:",
which is immediately followed by a line containing the
name of the procedure or function being described in
that documentation block. If this NAME field is not
present, the name of the source file will be used.
(c) The last line of the documentation block contains
only the characters ";-", starting in column 1.
(d) Every other line in the documentation block contains
a ";" in column 1.
Note that a single .pro file can contain multiple procedures and/or
functions, each with their own documentation blocks. If it is desired
to have "invisible" routines in a file, i.e. routines which are only
for internal use and should not appear in the help file, simply leave
out the ";+" and ";-" lines in the documentation block for those
routines.
No reformatting of the documentation is done.
MODIFICATION HISTORY:
July 5, 1995, DD, RSI. Original version.
July 13, 1995, Mark Rivers, University of Chicago. Added support for
multiple source directories and multiple documentation
headers per .pro file.
July 17, 1995, DD, RSI. Added code to alphabetize the subjects;
At the end of each description block in the HTML file,
added a reference to the source .pro file.
July 18, 1995, DD, RSI. Added STRICT keyword to handle angle brackets.
July 19, 1995, DD, RSI. Updated STRICT to handle & and ".
Changed calling sequence to accept .pro filenames, .tlb
text librarie names, and/or directory names.
Added code to set default subject to name of file if NAME
field is not present in the doc header.
Mar 14, 1996, SEP, NRL-LASCO, Made "See" a hypertext link to file.
Fix to handle case of no valid headers.
Jun 4, 2003, NBR, NRL-SECCHI - Add EXT keyword
Jan 12, 2004, NBR, NRL-SECCHI - Fix EXT keyword test
@(#)lasco_mk_html_help.pro 1.2 08/17/05 LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - LASCO
Name : LASCO_READFITS
Purpose : Read a LASCO FITS file to obtain an image and header array.
Explanation : This routine calls the IDL Astronomy Library routine READFITS
to read the LASCO FITS file. It then fills in a LASCO header
structure with the header information.
Use : IDL> image = LASCO_READFITS('filename' [,header])
Inputs : filename Name of the LASCO FITS file.
Outputs : image The image array.
Opt. Outputs: header The image header can be returned either as a
LASCO header structure or a STRARR (FITS header).
Keywords : FITS_HDR The header is normally returned as a LASCO header
structure. Set this keyword to return the header
as a STRARR (FITS header).
NO_IMG Set this keyword if you only want the header returned.
REFCOORD Set this keyword to define CRPIX if needed.
SILENT Set this keyword to turn off printing of remarks
CACHE Set equal to list of fits files; if set, then will copy
at most 25 files to /tmp and uses these copies
Calls : ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], FILE_STAT [1], FILE_STAT [2], FXPAR [1], FXPAR [2], HEADFITS [1]
HEADFITS [2], HEADFITS [3], LASCO_FITSHDR2STRUCT, MLO_FITSHDR2STRUCT
READFITS [1], READFITS [2], READFITS [3], REDUCE_REFCOORD, break_file [4]
file_stat [3]
Category : Data_Handling, I_O
Prev. Hist. : None.
Written : Scott Paswaters, NRL, Feb. 1996.
Modified :
Version :
1996/09/27 SEP Added REFCOORD
RAH, 5/23/97, added error handling for call to READFITS
RAH, 8/28/98, added handling of MLO/MK3 images
NBR, 12/1999, retry READFITS if it fails
NBR, 01/2000, Repeat READFITS max 5 times or until it succeeds
NBR, 02/2000, Add 2nd catch function and GOTO function for null image;
IF incr GT 5, return -1
NBR, 05/2000, Also repeat for null hdr
RAH, 7/28/00, added handling of MLO/MK4 images
NBR, 09/06/00, Check for .gz FITS if unable to find file
NBR, 12/04/00, Fix error condition
DW, 12/04/00, Add SILENT Keyword
NBR, 01/17/01, Add help statements
NBR, 02/12/01, Convert all headers to structure, regardless if LASCO or MK
NBR, 11/30/01 - Replace TRIM with STRTRIM
NBR, 01/03/02 - Add CACHE keyword
NBR, 01/07/02 - Edit SILENT usage
01/10/02, @(#)lasco_readfits.pro 1.13 LASCO IDL LIBRARY
CALLED BY
C3_CALIBRATE, C3_CME, C3_CME_FRONT, C3_MASSIMG, CALC_DARK_BIAS, CME_MASS
CME_MASSIMG2TOTAL, COMBINE_IMG, EDITFRAME, GENERIC_MOVIE, GETBKGIMG
MAKE_DAILY_IMAGE, MAKE_GIFS, MKDI_C1, MKMOVIE
MKMOVIE0 obsolete version of mkmoviepro, MKMOVIEM, MK_DAILY_MED, MK_IMG
MK_MONTHLY_MIN, MK_ONE_DEB_GIF, MLO_MASSIMG, MONITOR_EXP_IMG, PB_INVERTER
REDUCE_LEVEL_1, RTMOVIE, RTMVI [1], SUMMARY_PLOT, XEDITFRAME, carrmapmaker2, polariz
rt_carrmapmaker yymmdd num_r rad limb wlimb hdr disp saveset nextrot
[Previous]
[Next]
Project : SOHO - LASCO
Name : LASCO_READFITS
Purpose : Read a LASCO FITS file to obtain an image and header array.
Explanation : This routine calls the IDL Astronomy Library routine READFITS
to read the LASCO FITS file. It then fills in a LASCO header
structure with the header information.
Use : IDL> image = LASCO_READFITS('filename' [,header])
Inputs : filename Name of the LASCO FITS file.
Outputs : image The image array.
Opt. Outputs: header The image header can be returned either as a
LASCO header structure or a STRARR (FITS header).
Keywords : FITS_HDR The header is normally returned as a LASCO header
structure. Set this keyword to return the header
as a STRARR (FITS header).
NO_IMG Set this keyword if you only want the header returned.
REFCOORD Set this keyword to define CRPIX if needed.
Calls : READFITS, HEADFITS
Category : Data_Handling, I_O
Prev. Hist. : None.
Written : Scott Paswaters, NRL, Feb. 1996.
Modified :
Version : Version 0.1, Feb. 12, 1996
1996/09/27 SEP Added REFCOORD
RAH, 5/23/97, added error handling for call to READFITS
RAH, 8/28/98, added handling of MLO/MK3 images
NBR, 12/1999, retry READFITS if it fails
NBR, 01/2000, Repeat READFITS max 5 times or until it succeeds
NBR, 02/2000, Add 2nd catch function and GOTO function for null image;
IF incr GT 5, return -1
NBR, 05/2000, Also repeat for null hdr
11/02/01 @(#)lasco_readfits_mk4.pro 1.1 LASCO IDL LIBRARY
RAH, 7/28/00, added handling of MLO/MK4 images
CALLED BY
C3_CALIBRATE, C3_CME, C3_CME_FRONT, C3_MASSIMG, CALC_DARK_BIAS, CME_MASS
CME_MASSIMG2TOTAL, COMBINE_IMG, EDITFRAME, GENERIC_MOVIE, GETBKGIMG
MAKE_DAILY_IMAGE, MAKE_GIFS, MKDI_C1, MKMOVIE
MKMOVIE0 obsolete version of mkmoviepro, MKMOVIEM, MK_DAILY_MED, MK_IMG
MK_MONTHLY_MIN, MK_ONE_DEB_GIF, MLO_MASSIMG, MONITOR_EXP_IMG, PB_INVERTER
REDUCE_LEVEL_1, RTMOVIE, RTMVI [1], SUMMARY_PLOT, XEDITFRAME, carrmapmaker2, polariz
rt_carrmapmaker yymmdd num_r rad limb wlimb hdr disp saveset nextrot
[Previous]
[Next]
NAME:
LASER8
PURPOSE:
This procedure generates a "nice" layout for printing images
using an interactive menu system.
CATEGORY:
UTIL
CALLING SEQUENCE:
LASER8
INPUTS:
None
OUTPUTS:
None, File written to disk
AUTHOR:
Eric T. Swanson, NRL Summer Student, Aug, 1991
@(#)laser8.pro 1.2 05/14/97 LASCO IDL LIBRARY
+
NAME:
LASER8
PURPOSE:
This procedure generates a "nice" layout for printing images
using an interactive menu system.
CATEGORY:
UTIL
CALLING SEQUENCE:
LASER8
INPUTS:
None
OUTPUTS:
None, File written to disk
AUTHOR:
Eric T. Swanson, NRL Summer Student, Aug, 1991
@(#)laser8.pro 1.2 05/14/97 LASCO IDL LIBRARY
CALLS:
CALLED BY
CONGRID [3]
[Previous]
[Next]
********************************************************************************
LASER8ew.PRO
LASER8 for printing east limb and west limb carrington maps in landscape mode
designed to be significantly more modular than its predecessors
and hopefully more comprehensible to the peruser (and myself).
Eric T Swanson
8/27/91
PROCEDURES CALLED:
makebasecarr.pro
MODIFIED:
Dec. 1996 by N. Rich make output in landscape mode
Jan. 1996 by J. Kraemer add difference and limb option
Jan. 1996 by N. Rich add east/west limb feature; do actual differencing;
display begin and end dates; display max and min (modified common
block PM1)
Feb. 14 96 by N. Rich touch up ew maps
Feb. 26 96 by N. Rich remove factor by which basecarr is multiplied
Mar. 13 97 by N. Rich add B0 angle
Mar. 14 97 by N. Rich add top sub-title; newmax=newmax-1 for row=1
Mar. 18 97 by N. Rich change B0 angle display
Mar. 28 97 by N. Rich use pb0r.pro to compute B0 angle
May 15 97 by N. Rich variable mapsize from filename
May 21 97 by N. Rich add my name to output
Nov 3 97 by N. Rich use ratio instead of difference
Apr 7 98 by N. Rich add today's date to output
Jun 26 98 by N. Rich read fits files
Mar 2000 By N. Rich Add kind to common PM1; edit PRINTMENU
Oct 2000 By N. Rich Use BYTSCL for scaling images
Nov 2001 by N. RIch Add SCCS tags
27Mar02 by N. RIch Change default Top2 title
1Apr02 by N. Rich Auto exit after save
*************************************************************************
%H% %W% - NRL LASCO IDL Library
CALLS:
CALLED BY
CONGRID [1]
[Previous]
[Next]
Project : SOHO - CDS
Name : LAST_KAP_VERS()
Purpose : Gets version number of last KAP file read for given date
Explanation : This routine looks up what the last version number was for the
last KAP file for a given date that was read.
Use : Version = LAST_KAP_VERS( DATE )
Inputs : DATE = The date that the user wishes to look up the version
for. This can be in any of the standard CDS time
formats.
Opt. Inputs : None.
Outputs : The result of the function is the version number of the last
KAP file read for the date in question. If no KAP files have
been read yet for that date, then -1 is returned.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Version = LAST_KAP_VERS(DATE, ERRMSG=ERRMSG)
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1]
DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1]
DBOPEN [2], DBOPEN [3], TRIM
CALLED BY:
READ_KAP, SET_KAP_VERS
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 24 May 1995
Modified : Version 1, William Thompson, GSFC, 24 May 1995
Version : Version 1, 24 May 1995
[Previous]
[Next]
Name: lasteit
Purpose: read and display most recent EIT images
Input Parameters:
number - number of images to read (default=1)
Output Parameters:
info - EIT instrument parameter (string array, 1 per image)
data - EIT image or image cube
Keyword Parameters:
/w171, /w195, /w284, /304 - desired wavelength (default=171)
/wall - show all four wavel.
/norebin - return full size (default reduced to 512x512)
rebin - size to rebin to (assumed sqare!)
/notv - just return the data
quality - minimum quality "accepted" (see data_quality.pro)
(or, if set as flag, default=90%)
Calling Sequence:
lasteit [info, data, number, /w171, /w195, /w284, /304]
Calling Examples:
lasteit ; display most recent 171 image
lasteit,/w195 ; ditto for 195
lasteit,info,data,5,/w304 ; most recent 5 304 images
; return info and data
lasteit,/wall ; most recent all wavelenghts
lasteit,index,data,50, rebin=256,/quality ; last "50" @171,
; rebin->256, quality>90
CALLED BY:
mk_lasteit_movie
History:
5-feb-1996 (S.L.Freeland)
23-apr-1996 (s.l.freeland) tvscl display if /noscale set
3-mar-1997 (S.L.Freeland) use genx (IDL eit_struct based) catalog
instead of old ascii catalog
14-mar-1997 (S.L.Freeland) insure chronological order on output
add QUALITY keyword and function
23-jul-1997 (S.L.Freeland) apply QUALITY *BEFORE* FILL
6-Feb-1998 (S.L.Freeland) allow Al +1 (entrance filter degradation)
17-Oct-1998 (S.L.Freeland) enable PREPIT , optional call to sobel_scale
29-Oct-1998 (S.L.Freeland) pass DERIV_HIST to sobel_scale
28-Nov-2000 (S.L.Freeland) protect against out of order catalog
CALLS: ***
BOX_MESSAGE, DO_EIT_SCALING, EIT_PREP, FILE_EXIST [2], WDEF [1], WDEF [2]
data_quality, eit_colors, eit_dark, eit_file2path, eit_files, eit_fill_cube
eit_genx_cat, file_exist [1], file_exist [3], get_infox, read_eit, sobel_scale
sort_index [1], sort_index [2], xstepper [1], xstepper [2]
Restrictions:
Full disk only, Files in $EIT_QUICKLOOK
[Previous]
[Next]
Name: lastsfd
Purpose: read and display most recent sfd or sfr image(s)
Output Paramters:
index - sxt index
data - sxt data (image or cube)
Input Parameters
nimg (optional) - number to read (default is 1) - last nimg images read
Optional Keyword Parameters:
nar - if set, overlay noaa active regions
notv - if set, just return index/data (no image display)
obsr - if set, read corresponding spr and overlay observing region
color - if set, load color table 3, tone down grid brighteness
sfr - if set, use sfr, not sfd
spr - if set, usd spr (PFI) files, not sfd
spd - if set, usd spd (processed PFI) files, not sfd
rebin - if set, rebin to size (512 or 256 only)
halfres - if set, select most recent Half Res image (if available)
according to the following priority...
1:AlMg(half) 2:-Al.1(half) 3:Quarter(last image in file)
Note - /halfres is ignored if nimg is present
Calling Examples:
lastsfd, /nar ; display sxt image and overlay NOAA regions
lastsfd, /nar,/obsr ; same with recent OR
lastsfd, /nar,/obsr,/color ; same with standard colors
lastsfd, index,data,10,/notv ; return index/data for last 10 sfd images
lastsfd, index,data,10 ; same with display of last
lastsfd, index,data,5,/sfr,/stepper ; use sfr files - select w/stepper
lastsfd, /allobs ; boxes for uniq sprs in corresponding file
lastsfd, /allobs,/oldfile ; same in next to last file
lastsfd, /allobs, oldfile=5 ; same in 5th to last file
lastsfd, /spd,index,data,50 ; return last 50 SPD (pre-processsed pfi)
lastsfd, index,data,/half ; Last Half-Res image if available
Calls newsfd.pro to get recent SFD image(s)
CALLS: ***
FILE_EXIST [2], RD_SDA [1], RD_SDA [2], RD_SDA [3], Rd_Roadmap [2], STEPPER [1]
STEPPER [2], STEPPER [3], STEPPER [4], STEPPER [5], STEPPER [6], STEPPER [7]
WDEF [1], WDEF [2], file_exist [1], file_exist [3], fmt_tim [1], fmt_tim [2]
gt_filtb, gt_res, gt_time [1], gt_time [2], newsfd, plot_nar [1], plot_nar [2]
rd_roadmap [1], stepper_title [1], stepper_title [2], str_replace [1]
str_replace [2], sxt_uniq [1], sxt_uniq [2], tim2dset [1], tim2dset [2]
tim2orbit [1], tim2orbit [2], xrayss
CALLED BY:
FAKE_PATROL, FAXABLE_SFD, FIRST_LIGHT [1], FIRST_LIGHT [2], NAR2COORD, SFD_CDS
SFD_TEK, SOHO_COORDS, TERM_QUICK, TERM_REVIEW, TERM_REVIEW_GIF, chk_pointing
fl_summary [1], fl_summary [2], fl_summary [3], fl_suntoday [1], fl_suntoday [2]
fl_suntoday [3], fl_sxtobsnar [1], fl_sxtobsnar [2], gbo_obs_coord, lastspd
sun_today [1], sun_today [2], sun_today [3], sxt_summary, term_score2, xspr [1]
xspr [2]
Side effects:
may open new window
History: 7-May-1993 SLF (Written)
10-may-1993 add obsr, color
13-may-1993 add stepper keyword and sfr
30-aug-1993 add /allobs keyword
(filter out night PFIs)
9-Dec-1993 add /spd and /spr switches
14-Jul-1994 zbuffer switch to plot_nar
17-Jul-1994 Filter out Non-Xray images in obs plot
(dont display dark-cal / diffuser)
1-Dec-1994 (SLF) update header (spd,spr,half keywords)
22-aug-1995 (SLF) made /half the default
30-aug-1995 (SLF) fixed bug caused by 22-aug (3rd paramter caused crash)
[Previous]
[Next]
Name: laststat
Purpose: format status info for task_wait
CALLS:
[Previous]
[Next]
Name: launch
Purpose: return yohkoh launch day (default) or days since
Optional Keyword Parameter:
dsince - if set, returns number of days since launch
CALLS: ***
ADDTIME [1], ADDTIME [2], anytim2ex [1], anytim2ex [2], syst2ex [1], syst2ex [2]
syst2ex [3]
CALLED BY:
chk_flares [1], chk_flares [2]
History: slf, 25-Mar-92
[Previous]
[Next]
Project : SOHO - LASCO/EIT
Name : LAYOUT
Purpose : draw a layout to the image
Category : DISPLAY
Explanation :
Syntax : layout,image,name,head,hindex
CALLED BY:
MKDI_C1, MK_IMAGE
Examples :
Inputs :
Opt. Inputs :
Outputs :
Opt. Outputs:
Keywords :
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], EPHEMERIX, FXPAR [1], FXPAR [2], GETSUNCEN
GET_SOLAR_RADIUS, MASKN, SUNGRID, TEXTARRAY, shandle
Common : wload.com
Restrictions:
Side effects:
MODIFICATION HISTORY:
Written by: Borut Podlipnik, 15-jan-1993, MPAe
Contact : BP, borut@lasco1.mpae.gwdg.de
[Previous]
[Next]
NAME:
lcur_calc
PURPOSE:
To calculate the light curve averages for the LCUR_IMAGE routine
INPUT:
index - the index structure
data - the data array
marks - The subscripts within the image that were selected. The
output array is NxM where N is the largest number of subscripts
that were selected in a region, and M is the number of
different regions selected. When padding is necessary, the
value is set to -1, so that value needs to be avoided.
OPTIONAL INPUT
uncert - The uncertainty array
satpix - The saturated pixel array
OUTPUT:
plotmark- The plotting mark to be used. If "uncert" and "satpix" are
not passed in, then it is always "1"
for average uncert > 0.25 - value = 4 (diamond)
for any sat pixel in region - value = 5 (triangle)
for over 25% sat pix in region - value = 2 (astrix)
avg_uncert- The average uncertainty
CALLS: ***
gt_expdur [1], gt_expdur [2]
CALLED BY:
lcur_image
OPTIONAL KEYWORD INPUT:
normalize - If set, then divide by the exposure duration to normalize
to DN/sec.
total_cnts - If set, then return the total counts in the region (not
the counts per second)
HISTORY:
Written 18-Oct-93 by M.Morrison
19-Oct-93 (MDM) - Added header information
- Corrected /TOTAL_CNTS option
28-Feb-95 (MDM) - Added avg_uncert output
[Previous]
[Next]
NAME:
lcur_plot
PURPOSE:
To plot the light curve averages for the LCUR_IMAGE routine
INPUT:
win - The light curve plot window number
index - The index structure
lcur - The average (or total) counts for each image (and region)
plotmark- The flag on what plotting symbols to plot for each image
(see LCUR_CALC)
OPTIONAL INPUT:
avg_uncert-The uncertainty of the data points. Plot as error bars
CALLS: ***
ERRPLOT [1], ERRPLOT [2], OUTPLOT [1], OUTPLOT [2], OUTPLOT [3], UTPLOT [1]
UTPLOT [2], UTPLOT [3], UTPLOT [4], UTPLOT [5], UTPLOT [6], int2secarr [1]
int2secarr [2]
CALLED BY:
lcur_image
OPTIONAL KEYWORD INPUT:
ynozero - If set, adjust y scale so it is not zero if necessary
qoplot - If set, do not make a new plot, simply overplot the
data
subscript- The image numbers of the images to plot the light
curve for
ioff - The region number (used when plotting a single
light curve, not needed when doing multiple light
curve plot option)
HISTORY:
Written 18-Oct-93 by M.Morrison
19-Oct-93 (MDM) - Added header information
- Corrected /TOTAL_CNTS option
26-Oct-93 (MDM) - Corrected overplotting symbol bug
28-Feb-95 (MDM) - Added AVG_UNCERT
[Previous]
[Next]
NAME:
lcur_plotr
PURPOSE:
To generate a line plot showing the location of the regions selected.
Overlay the regions selected on top of a contour of an image. Called
by LCUR_IMAGE
SAMPLE CALLING SEQUENCE:
lcur_plotr, image, marks, index
INPUT:
image - A single image array
marks - The subscripts within the image that were selected. The
output array is NxM where N is the largest number of subscripts
that were selected in a region, and M is the number of
different regions selected. When padding is necessary, the
value is set to -1, so that value needs to be avoided.
index - The index for the image so that the time/date can be
provided in the contour image.
CALLS: ***
CONGRID [1], CONGRID [2], CONGRID [3], fmt_tim [1], fmt_tim [2], ocontour [1]
ocontour [2], ocontour [3], ocontour [4], ocontour [5], tv2 [1], tv2 [2]
xyouts2 [1], xyouts2 [2]
CALLED BY:
lcur_image
OPTIONAL KEYWORD INPUT:
qas_image- If set, display the data as an image, not a contour plot
HISTORY:
Written 18-Oct-93 by M.Morrison
29-Nov-93 (MDM) - Modified the header information
16-Feb-95 (MDM) - Added /QAS_IMAGE option
28-Feb-95 (MDM) - Modified how /QAS_IMAGE worked - use TV2 so
that hardcopy is possible
[Previous]
[Next]
Name: lcurve
Purpose: lightcurve widget
slf, 5/91
CALLS:
[Previous]
[Next]
Project : SOHO - LASCO
Name :
Purpose :
Category :
Explanation :
Syntax :
CALLED BY:
WLOADC
Examples :
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
CALLS: ***
RSTRPOS
Common :
Restrictions:
Side effects: Not known
History : Version 1, 02-Sep-1995, B Podlipnik. Written
Contact : BP, borut@lasco1.mpae.gwdg.de
[Previous]
[Next]
NAME:
LEG_DISP
PURPOSE:
This procedure computes the leg actuator motions required for the
pointing of LASCO.
CATEGORY:
UTIL
CALLING SEQUENCE:
LEG_DISP,Theta,Phi
INPUTS:
Theta: Desired motion in pitch (in arc sec)
Phi: Desired motion in yaw (in arc sec)
OUTPUTS:
The number of steps is printed on the display.
RESTRICTIONS:
Assumes starting at center positions
EXAMPLE:
To obtain the number of steps to move the two legs 4 arc min in pitch
and 2 arc min in yaw:
LEG_DISP,240.,120.
MODIFICATION HISTORY:
Written by: S.Plunkett, DSR, 1994
@(#)leg_disp.pro 1.1 10/05/96 LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
LIMB_DARK
PURPOSE:
This function returns the limb darkening coefficient given the wavelength
CATEGORY:
DATA ANALYSIS
CALLING SEQUENCE:
Result = LIMB_DARK (Lambda)
INPUTS:
Lambda: Wavelength in nanometers
KEYWORDS
MEANFLUX If present, the limb darkening is the ratio of the mean flux
to the intensity at the center of the disk. The default is
the ratio of the intensity at the limb to the intensity at
the center.
ALLEN If present the values from Allen "Astrophysical Quantities"
are returned rather than from Pierce and Allen.
OUTPUTS:
This function returns the limb darkening for the input wavelength(s).
CALLS: ***
INTERPOL
RESTRICTIONS:
The range of wavelengths can be between 305 nm and 995 nm. If any
input values are outside of this range, the program will exit without
computing anything and will return a value of -1.
PROCEDURE:
The limb darkening values derived from Table 2 of Pierce and Allen,
"The Solar Spectrum Between 0.3 and 10 micron", pp169-192, in "The
Solar Output and its Variation" O.R. White, ed, Colorado University
Press, Boulder, 1977.
Column 6 of Table 2 gives a limb darkening function as the ratio of the
average solar flux to the intensity at disk center. We want the ratio
of the intensity at the limb to the intensity at the center of the disk
Allen, "Astrophysical Quantities" p170 relates the limb darkening
coefficient, u, to the ratio of the total flux to the intensity at
disk center as approximately:
u = 3*[F/I((0)]-2
where, F/I(0) is the mean to center ratio given in Pierce and Allen.
Calls the IDL routine INTERPOL to perform the interpolations.
EXAMPLE:
To obtain the limb darkening at 730 nm (7300 Angstrom):
u = LIMB_DARK(730.)
MODIFICATION HISTORY:
Written by: R.A. Howard, NRL, September, 1999
@(#)limb_dark.pro 1.3 08/10/05 :LASCO IDL LIBRARY
[Previous]
[Next]
NAME : LINE_PAR_CONV
PURPOSE : Convert normal Gaussian parameters into physical
line parameters or vice versa.
CALIING SEQUENCE :
Value = LINE_PAR_CONV(data, wl, dispersion $
[, rest_pixel], reverse=reverse)
INPUTS:
DATA line fitting parameters
(1-d, 2-d, or 3-d floating array)
which define a Guassian profile in the way :
continuum = DATA(0,*,*) in counts
peak = DATA(1,*,*) in counts
center = DATA(2,*,*) in pixels
width = DATA(2,*,*) in pixels
I(j) = continuum+peak*exp(-0.5*((j-center)/width)^2)
WL rest wavelength of the line given in angstroms
DISPERSION dispersion given in angstrom/pixel
OPTIONAL INPUTS:
REST_PIXEL the pixel value corresponding to WL
if not specified, it is set to zero.
OUTPUTS:
VALUE physical line parameters
(1-d, 2d-, or 3-d floating array)
VALUE(0,*,*) : continuum in counts
VALUE(1,*,*) : integrated intensity in counts
VALUE(2,*,*) : Doppler Shift in km/s defined by
shift = (center-median(center)
-rest_pixelmedian(rest_pixel))*dispersion/wl*c
so that the median value of Doppler shift should be
very close to zero.
VALUE(3,*,*) : Doppler Width in km/s defined by
Doppler Width = 1.414*width*dispersion/wl*c
KEYWORDS :
REVERSE If set, given input are interpreted to be
physical line parameters and line fitting
parameters are returned.
MODIFICATION HISTORY
April 1997 Jongchul Chae
CALLED BY
SUMER_DISPLAY_IMA, SUMER_GIF_IMA, SUMER_HARDCOPY_IMA, SUMER_RASTER_SAVE
SUMER_TOOL_MAIN_EVENT, SUMER_TOOL_PD_EVENT
[Previous]
[Next]
file LINECOLORS.PRO
Create a color table with "n" distinct color indices at the low end of
the table and the index at !D.TABLE_SIZE-1 with the colors defined below.
Where: the first color index will be black
'n' is the number of distinct colors hard coded below
and, the last color index is white
INDEX NUMBER COLOR PRODUCED (if use default colors)
0 black
1 maroon
2 red
3 pink
4 orange
5 yellow
6 olive
7 green
8 dark green
9 cyan
10 blue
11 dark blue
12 magenta
13 purple
General color table stuff:
Each color available is made up of the values found in three arrays.
These array represent how much RED, GREEN, and BLUE color to use.
A value of zero means don't use any of that color.
A value of 255 means use the maximum amount of that color.
These arrays are considered your 'color guns'.
How large your 'color gun' arrays can be is determined by your system.
!D.N_COLORS system variable hold the max number of colors you can have.
!D.TABLE_SIZE is the maximum number of indices you may use.
You may not have all 255 colors.
So for each 'color index' you must decide how much RED, GREEN and
BLUE you want.
The combination of these three 'color gun' arrays will be the color
that appears in the individual 'color index'.
CALLING SEQUENCE:
LINECOLORS is the simplest form. It produces a color table with
the colors listed above and loads it. All you do is
call it and use the plot keyword COLOR=x.
Where x is the index number from above.
LINECOLORS [,MYCOL_R=mycol_g, MYCOL_G=mycol_g, MYCOL_B=mycol_b,
LINE_R=line_g, LINE_G=line_g, LINE_B=line_b,
table=table, /NOLOAD, /NOTOP, /NOSQUEEZE, USED=used,
error=error]
INPUT:
MYCOL_R : If present, an array (convert to byte) containing the
red gun values (0-255) to overwrite the common array COLORS
This array is expanded or compressed to fit. Will override
the TABLE keyword value.
MYCOL_G : Same as above for green.
MYCOL_B : Same as above for blue.
TABLE : The number of an IDL User Library Color Table, to be loaded.
It will be this table that is compressed into the indices
remaining after MYCOL_R,_G,_B or the defaults arrays.
NOLOAD : If set, don't do a TVLCT in this program.
This new color table will not be active until doing a TVLCT
NOTOP : If set, don't put white in the index at !D.TABLE_SIZE-1
Not all original color tables will have white at the top.
NOSQUEEZE: If set, don't squeeze the current color table into
the indices not taken by the distinct colors. The bottom
colors of the original table will be overwritten the
rest will remain as they were. Ignored if the keywords
MYCOL_R, MYCOL_G, MYCOL_B are set.
HELP: If set and device='x', display a colorbar with indices
(!d.window is reset to original window number)
OUTPUT:
LINE_R : If present, returns the red color gun values for this new
color table. This array is the same as found in the IDL
common array R_CURR, upon returning.
LINE_G : Same as above for green.
LINE_B : Same as above for blue.
USED : If present, returns the number of indices used by the
distinct colors at the low end of the color table.
Doesn't include the overwritting of the top index to white,
or any value of MYCOL_R, MYCOL_G, MYCOL_B.
also see the explaination of x_CURR below.
ERROR : 0/1 means no error / error
CALLS: ***
CONGRID [1], CONGRID [2], CONGRID [3], LOADCT, WDEF [1], WDEF [2]
CALLED BY:
ACRIM, ACRIM_EV, ACRIM_OUT, BATSE_FLARES_WEEK, EIT_SUBFIELD, EIT_SUB_UTIL_FILE
FS_ARCHIVE_DRAW, FS_OVERLAY, GE_WINDOW [1], GOES_MEWE_TEM, GOES_TEK [1]
GOES_TEK [2], GOES__DEFINE, HXARCHIVE, HXFITS, HXIS, HXRBS, PLOTMAP, PLOT_CRAB, PLOT_GD
PLOT_HESSI_FILTERS, PLOT_OCCS, PLOT_OCC_ONDAY, QL_DAY_PLOT, ROUTINE_NAME [1]
SETUP_DRM, SPEX_PLOT_SAVED [1], SPEX_PLOT_SAVED [2], SUBFIELD_EV, TERM_REVIEW
TERM_REVIEW_GIF, WBSC [1], WBSC [2], box_lc_plot, eit_proton_summary
event_movie [1], event_movie [2], evt_demo, fem_grid [1], fem_grid [2], get_slider
hessi_splash, line_table, out_spectra_4_designer, plot_ace, plot_goes_ospex
plot_goesp, plot_sxg, res_freq, set_field, setup_spex [1], setup_spex [2]
show_contacts, soon_cadence, soon_catstat, sooncat_cadence, spex_splash
term_score2, tim2tfss, trace_cosmic2hist_accum
COMMON:
COMMON COLORS, R_ORIG, G_ORIG, B_ORIG, R_CURR, G_CURR, B_CURR
This IDL common contains the current color table.
SIDE EFFECTS:
The color table side will be determined by the current device
If the device is not 'X', an informational message will be printed.
RESTRICTIONS:
The output graphic device must accept the LOADCT calls, if
/TABLE is set or if no previous table has been loaded.
The output graphic device must accept the TVLCT call, unless
the /NOLOAD keyword is set.
PROCEDURE:
Some time before you do your plot command, call this routine.
LINECOLOR
If you use the /NOLOAD keyword, then upon returning you will need
to load the new created color table with TVLCT, <red>,<green>,<blue>
LINECOLORS, LINE_R=LINE_R, LINE_G=LINE_G, LINE_B=LINE_B, /NOLOAD
TVLCT, LINE_R, LINE_G, LINE_B
To postscript printer :
SET_PLOT,'PS',/copy ; prints plot the postscript file
DEVICE, [FILENAME=filename] ; black and white print
or
DEVICE, [FILENAME=filename], /color ; color print
To plot, use the desired color index, by using the plotting
keyword COLOR=index.
You may want to first plot the axises in white then over plot the
data in a distinct color.
plot, x, y, /nodata ... ; titles and axes
; color defaults to the
; largest index. In our
; color table this is white
; Black for prints.
oplot, x, y, color=n ... ; Plot the data. 'n' is
; the color index of choice
If you were printing then you'll need to close the output file,
and print.
DEVICE,/CLOSE
PSPLOT, FILENAME=filename ; for black and white
PSPLOT, FILENAME=filename, /color ; for color print
An example:
pro brian, color=color ; color is 0 for b/w
; 1 for color
linecolors
set_plot,'ps',/copy
if not(color) then device,file='brain.ps' $
else device,file='brain.ps', color=color
plot, indgen(100), /nodata
oplot, (indgen(100)-10)>0, color=1
oplot, (indgen(100)-20)>0, color=3
oplot, (indgen(100)-30)>0, color=5
oplot, (indgen(100)-40)>0, color=7
oplot, (indgen(100)-50)>0, color=9
device,/close
if not(color) then psplot,filename='brain.ps' $
else psplot,filename='brain.ps',/color
return & end
MODIFICATION HISTORY:
Elaine Einfalt (HSTX)
MAY 93 - If mycol_r,g,b arrays are passes they are added
after the distinct colors, not instead.
23-sep-94 (SLF) - added HELP keyword (display color bar with indices)
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_ALT
Purpose : List the CDS alternate science plan for a date range.
Explanation : Extracts all the CDS alternate science plan entries which
intersect an input time range.
Use : LIST_ALT, START, END, PERIODS, N_FOUND
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : PERIODS = A structure variable containing the following tags
for each alternate science plan entry:
STRUCT_TYPE= The character string 'CDS-ALT-LIST'
PROG_ID = Program ID, linking one or more studies
together
STUDY_ID = Number defining the study
STUDYVAR = Number giving the study variation ID
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
START_TIME = Date/time of beginning of alternate plan,
in TAI format
END_TIME = Date/time of end of alternate plan, in
TAI format
ORIG_DUR = Original duration of the observation, in
seconds, before being truncated by
following time-tagged observations.
N_RASTERS1 = Variable number of rasters parameter
TRACKING = True (1) if feature tracking to be used,
or false (0) otherwise
N_POINTINGS= Number of pointings to use with study.
N_REPEAT_S = Number of times to repeat study
GSET_ID = GSET ID number
GET_RAW = True if raw data should be collected.
N_FOUND = Number of periods found.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_ALT, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1], DBSORT [2], DBSORT [3], TRIM, UNIQ [1]
UNIQ [2], UNIQ [3], UTC2TAI
Common : None.
Restrictions: None.
Side effects: If the number of periods found is zero, then the output
parameter PERIODS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 9 May 1995
Modified : Version 1, William Thompson, GSFC, 9 May 1995
Version 2, William Thompson, GSFC, 28 September 1995
Added tags ORIG_DUR, GSET_ID, GET_RAW
Version : Version 2, 28 September 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_ANOMALY
Purpose : List the SoHO anomalies for a given time range.
Explanation : Extracts all the SoHO anomaly entries which intersect an
input time range.
Category : operations, database
Syntax : LIST_ANOMALY, TSTART, TEND,ANOMALIES, N_FOUND
Inputs : TSTART, TEND = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : ANOMALIES = Array of anomaly structures
N_FOUND = Number of anomalies found.
Opt. Outputs: None.
Keywords :
SYSTEM = If passed, then the name for the system for which
to retrieve the anomaly. Otherwise,
anomalies for all systems are retrieved.
OPEN = return only active (i.e., open) anomalies
CLOSED = return only retired (i.e., closed) anomalies
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_ANOMALY, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
CALLED BY:
QUERY_ANOMALY, XREPORT
Side effects: None.
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], ARR2STR [1], Arr2Str [2], DATATYPE [1]
DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBFIND [1]
DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1], DBSORT [2]
DBSORT [3], DEF_ANOMALY, DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], TIME
TRIM, UNIQ [1], UNIQ [2], UNIQ [3], UTC2TAI, WHERE_VECTOR, delvarx [5]
Common : None.
Restrictions: None.
Side effects: None.
History : Version 1, 21-Dec-1995, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_CAMPAIGN
Purpose : List all the SoHO campaigns for a date range.
Explanation : Extracts all the SoHO campaign entries which intersect an
input time range.
Use : LIST_CAMPAIGN, START, END, CAMPAIGNS, N_FOUND
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : CAMPAIGNS = A structure variable containing the following tags
for each flag campaign period:
CMP_NO = Unique identifier number.
CMP_NAME = Name of the campaign.
CMP_TYPE = Campaign type, e.g. JOP, Intercal, etc.
DATE_OBS = Starting date for the observing campaign
DATE_END = Ending data for the campaign
OBSERVER = Observer in overall charge of the campaign
N_FOUND = Number of campaigns found.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_CAMPAIGN, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1], DBSORT [2], DBSORT [3], TRIM, UNIQ [1]
UNIQ [2], UNIQ [3], UTC2TAI
CALLED BY:
FIND_CAMPAIGN, MK_SOHO, SOHO_CAMPAIGN
Common : None.
Restrictions: None.
Side effects: If the number of campaigns found is zero, then the output
parameter CAMPAIGNS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 26 July 1994
Modified : Version 1.0, William Thompson, GSFC, 27 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 21 November 1994
Modified so that items which only touch requested range
are excluded.
Version 4, 23-Sep-1996, William Thompson, GSFC
Added campaign type.
Version 5, 11-Dec-1996, William Thompson, GSFC
Include campaigns which only touch the requested time
boundaries.
Version : Version 5, 11-Dec-1996
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_CDROM
Purpose : List the contents of CDS level-0 CDROMs
Category : Class4, Operations, Database, Catalog
Explanation : Searches the CDROM database for information about what dates
are on which level-0 CDROM. Two kinds of requests can be made.
You can ask which dates are on a given CDROM by giving the
sequence and volume number. Alternatively, you can give a
range of dates, and the software will return the CDROMS that
contain those dates.
Syntax : LIST_CDROM, SEQUENCE, VOLUME, LIST, N_FOUND
LIST_CDROM, START, END, LIST, N_FOUND
Examples : LIST_CDROM, 2, 4, LIST, N_FOUND
LIST_CDROM, '1996-01-10', '1996-01-15', LIST, N_FOUND
Inputs : One of the two following pairs of input parameters must be
passed.
SEQUENCE = The sequence number of the CDROM. For example, if
the CDROM is identified as SO_CDS_LZ_0002, then its
sequence number is 2.
VOLUME = The volume number of the CDROM. For example, if the
CDROM is identified as "4 of 9", then the volume
number is 4.
or
START = A starting date to search for.
END = An end date to search for. The start and end dates
can be in any standard CDS time format.
Opt. Inputs : None.
Outputs : LIST = A list of entries. This is a structure with the
following tags:
SEQUENCE = The sequence number
VOLUME = The volume number
DATE = The date, e.g. "1995-12-14"
N_FOUND = The number of entries found.
Opt. Outputs: None.
Keywords : PRINT = If set, then the entries found are printed to the
terminal.
OUTPUT = When used with /PRINT, specifies a filename to write
the output to instead of writing to the terminal.
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors
are encountered, then a null string is returned. In
order to use this feature, ERRMSG must be defined
first, e.g.
ERRMSG = ''
LIST_CDROM, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2], DATATYPE [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1]
DBSORT [2], DBSORT [3], TRIM, UNIQ [1], UNIQ [2], UNIQ [3], UTC2STR
Common : None.
Restrictions: None.
Side effects: If the number of CDROM entries found is zero, then the output
parameter LIST is not modified.
Prev. Hist. : None.
History : Version 1, 23-Apr-1996, William Thompson, GSFC
Version 2, 24-Apr-1996, William Thompson, GSFC
Added keywords PRINT and OUTPUT
Version 3, 25-Apr-1997, William Thompson, GSFC
Changed way printing is done to terminal, to correct
problem with IDL 4.0
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_COM_TIMES
Purpose : List the SoHO command contact times for a given period
Explanation : Extracts all the SoHO Deep Space Network (COM) contact periods
in the input time range.
Use : LIST_COM_TIMES, START, END, COM, N_FOUND
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : COM = A structure variable containing the following tags
for each planned contact period:
START_TIME = Date/time of beginning of the command
contact period, in TAI format
END_TIME = Date/time of end of command contact
period, in TAI format
N_FOUND = Number of planned contact periods found.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_COM_TIMES, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1], DBSORT [2], DBSORT [3], LIST_NRT_RES
TRIM, UTC2TAI
CALLED BY:
LIST_RESOURCE
Common : None.
Restrictions: None.
Side effects: If the number of planned contact periods found is zero, then
the output parameter COM is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 31 March 1995
Modified : Version 1, William Thompson, GSFC, 3 April 1995
Version : Version 1, 3 April 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_DATAWIN
Purpose : List the available data window lists for a given line list.
Explanation : Extracts the descriptions of all the data window lists from
the database, for a given line list ID number.
Use : LIST_DATAWIN, LL_ID, LISTS, N_FOUND
Inputs : LL_ID = The line list ID number to search on. Setting this to
zero will search for lists that are not connected to
line lists.
Opt. Inputs : None.
Outputs : LISTS = A structure variable containing the following tags
for each data window list:
DW_ID = Data window list ID number.
DETECTOR = Either "G" for GIS or "N" for NIS.
DW_DESC = A short description of the data window list
beyond what is given in the associated line
list description, e.g. "Full slit, 10
pixels wide".
W_WIDTH = Width in pixels used to generate the
windows.
W_HEIGHT = The height in pixels used to generate the
windows. VDS only, for GIS this is set to
unity.
VDS_BACK = Either 0 for off, or 1 for on,
representing whether or not VDS background
windows are being used. For GIS window
lists this is 0.
N_WINDOWS = The number of windows.
N_FLAGS = The number of flag windows.
LL_ID = The line list ID number for the line list
that this window list was derived from, or
zero for no line list.
LL_DESC = A description of the line list, e.g.
"Temperature sensitive line pairs".
N_LINES = The number of lines in the line list
N_FOUND = Number of lists found.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_DATAWIN, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3]
CALLED BY:
TP_DISP_LLIST
Common : None.
Restrictions: None.
Side effects: If the number of window lists found is zero, then the output
parameter LISTS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 31 March 1994
Modified : Version 1, William Thompson, GSFC, 1 August 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 4, William Thompson, GSFC, 15 March 1995
Removed LL_TITLE
Version 5, William Thompson, GSFC, 20 June 1995
Modified to include N_FLAGS tag.
Version : Version 5, 20 June 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_DETAIL
Purpose : List the CDS detailed science plan for a given date range.
Explanation : Extracts all the CDS detailed science plan entries which
intersect an input time range.
Use : LIST_DETAIL, START, END, OBS, N_FOUND
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : OBS = A structure variable containing the following tags
for each planned observation:
STRUCT_TYPE= The character string 'CDS-DETAIL-LIST'
PROG_ID = Program ID, linking one or more studies
together
STUDY_ID = Number defining the study
STUDYVAR = Number giving the study variation ID
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
DATE_OBS = Date/time of beginning of observation,
in TAI format
DATE_END = Date/time of end of observation, in TAI
format
ORIG_DUR = Original duration of the observation, in
seconds, before being truncated by
following time-tagged observations.
N_RASTERS1 = Variable number of rasters parameter
TIME_TAGGED= True (1) if the start of the study is to
be a time-tagged event. Otherwise, the
study will begin immediately after the
previous study.
TRACKING = True (1) if feature tracking to be used,
or false (0) otherwise
N_POINTINGS= Number of pointings to use with study.
N_REPEAT_S = Number of times to repeat study.
FLAG_MASTER= Nonzero if flag master.
GSET_ID = GSET ID number
GET_RAW = True if raw data should be collected.
PROG_NUM = Study counter number (negative is
predicted)
N_FOUND = Number of planned observations found.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_DETAIL, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2], DATATYPE [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1]
DBSORT [2], DBSORT [3], FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3]
TRIM, UNIQ [1], UNIQ [2], UNIQ [3], UTC2TAI
CALLED BY:
CDS_PLAN_BRIEF, EXPORT_PLAN, GET_CDS_PLAN, GET_CDS_STATE, IMPORT_PLAN, MK_CDS_PLAN
PRED_PROG_NUM, SHOW_PLAN, WRITE_IAP, XCPT
Common : None.
Restrictions: None.
Side effects: If the number of planned observations found is zero, then the
output parameter OBS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 26 July 1994
Modified : Version 1, William Thompson, GSFC, 3 August 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 21 November 1994
Modified so that items which only touch requested range
are excluded.
Added item N_REPEAT_S.
Version 4, William Thompson, GSFC, 26 January 1995
Added tag STRUCT_TYPE
Version 5, William Thompson, GSFC, 13 February 1995
Changed the way that pointing is treated.
Version 6, William Thompson, GSFC, 8 May 1995
Modified to pay attention to DELETED field in database
Version 7, William Thompson, GSFC, 20 June 1995
Added tag FLAG_MASTER
Version 8, William Thompson, GSFC, 28 September 1995
Added tags ORIG_DUR, GSET_ID, GET_RAW
Version 9, William Thompson, GSFC, 4 June 1997
Added tag PROG_NUM
Version 10, William Thompson, GSFC, 26 May 1998
Look for entries in "_year" files
Version : Version 10, 26 May 1998
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_DLYD_TIMES
Purpose : List the SoHO delayed command times for a given period
Explanation : Extracts all the SoHO Deep Space Network (COM) contact periods
in the input time range for which delayed commanding can take
place. Currently, this is all the payload reserved times.
Use : LIST_DLYD_TIMES, START, END, COM, N_FOUND
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : COM = A structure variable containing the following tags
for each planned contact period:
START_TIME = Date/time of beginning of the command
contact period, in TAI format
END_TIME = Date/time of end of command contact
period, in TAI format
N_FOUND = Number of planned contact periods found.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_DLYD_TIMES, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1], DBSORT [2], DBSORT [3], TRIM, UTC2TAI
Common : None.
Restrictions: None.
Side effects: If the number of planned contact periods found is zero, then
the output parameter COM is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 14 April 1995
Modified : Version 1, William Thompson, GSFC, 14 April 1995
Version : Version 1, 14 April 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_DSN
Purpose : List the SoHO DSN contacts for a given period
Explanation : Extracts all the SoHO Deep Space Network (DSN) contact periods
in the input time range.
Use : LIST_DSN, START, END, DSN, N_FOUND
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : DSN = A structure variable containing the following tags
for each planned contact period:
START_TIME = Date/time of beginning of the DSN contact
period, in TAI format
END_TIME = Date/time of end of DSN contact period, in
TAI format
MODE = Telemetry mode. This is a number with the
following possible values:
Value Mnemonic
1 LR
2 MR
3 HR
4 IDLE
For most SOHO instruments except MDI, the
primary distinction is between low rate
(MODE EQ 1) and medium rate and above
(MODE GE 2).
SUBMODE = Telemetry submode. This is a number with
the following possible values:
Value Meaning
1 Standard
2 EIT prime
3 SUMER prime
4 CDS prime
N_FOUND = Number of planned contact periods found.
Opt. Outputs: None.
Keywords :
NOMODES = If set, then the DSN contact periods are not broken out by
modes and submodes. The MODE and SUBMODE tags in the
returned structure will be zero.
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_DSN, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1], DBSORT [2], DBSORT [3], TRIM, UNIQ [1]
UNIQ [2], UNIQ [3], UTC2TAI
CALLED BY:
LIST_RESOURCE, MK_SOHO_TARGET
Common : None.
Restrictions: None.
Side effects: If the number of planned contact periods found is zero, then
the output parameter DSN is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 31 March 1995
Modified : Version 1, William Thompson, GSFC, 3 April 1995
Version 2, William Thompson, GSFC, 7 April 1995
Fixed bug with changing modes.
Version 3, William Thompson, GSFC, 11 April 1995
Added keyword NOMODES.
Version 4, William Thompson, GSFC, 24 January 1996
Modified so that default telemetry mode is 2 and
default telemetry submode is 1, in case those databases
are empty.
Version : Version 4, 24 January 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_DURATION
Purpose : Find the actual durations of rasters from the catalog
Category : Class3, Operations
Explanation : The CDS catalog is searched for the stop and start
times, and the duration is calculated in seconds. This is
compared against the durations as listed in the database.
Syntax : LIST_DURATION [, START_TIME, END_TIME ]
Examples : LIST_DURATION, /PRINT
Inputs : None required.
Opt. Inputs : START_TIME = Start time to look in the catalog. If not passed,
then the last 36 hours are searched.
END_TIME = End time to go along with the start time.
Outputs : Information about the raster duration is printed to the screen.
Opt. Outputs: None.
Keywords : WEEKLY = If set, then the studies run over the last week
(actually 8 days) are searched.
OUTPUT = Name of a file to write the output to, instead of
the screen.
PRINT = If set, then the information is sent to the printer.
If OUTPUT is not specified, then a temporary file is
used.
QUEUE = The name of the print queue to use, when /PRINT is
selected. If not passed, then a menu is presented
to the user.
Calls : ***
CHECK_INT_TIME, DELETE_FILE [1], DELETE_FILE [2], FILEPATH, FIND_FILE_DUR
GET_RASTER, GET_UTC, LIST_EXPER, LIST_MAIN, SEND_PRINT, SIGMA, TRIM, XPRINT [1]
XPRINT [2], XPRINT [3], XPRINT [4], XPRINT [5]
Common : None.
Restrictions: Unix only.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 09-Jul-1996, William Thompson, GSFC
Version 2, 11-Jul-1996, William Thompson, GSFC
Added keyword WEEKLY
Modified format of output.
Version 3, 17-Oct-1997, William Thompson, GSFC
Call FIND_FILE_DUR
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_EXP_COMM
Purpose : List the comments on a CDS raster as-run entry
Explanation : Extracts all the comments for a CDS raster-level (experiment)
as-run entry.
Use : LIST_EXP_COMM, SEQ_NUM, COMM, N_FOUND
LIST_EXP_COMM, DATE_MOD, COMM, N_FOUND, /DATE_MOD
Inputs : SEQ_NUM = The sequence number to use in searching the
database.
Opt. Inputs : DATE_MOD = The modification date to use in searching the
database. This parameter is used in place of
SEQ_NUM if the DATE_MOD keyword is set.
Outputs : COMM = A structure variable containing the following tags
for each planned observation:
STRUCT_TYPE= The character string 'CDS-EXP-COMM-LIST'
SEQ_NUM = Experiment sequence number. This serves
as a link to the experiment database.
COMM_NO = Comment ID number.
COMMENT = The comment.
DATE_MOD = Date and time when catalog record was last
modified.
END_DATE = The end date to search over. This is used
to support the END_DATE keyword in
WRITE_CIF.
N_FOUND = Number of observations found.
Opt. Outputs: None.
Keywords : DATE_MOD = If set, then the search is done on the modification
date rather than the start and stop dates.
ERRMSG = If defined and passed, then any error messages will
be returned to the user in this parameter rather
than depending on the MESSAGE routine in IDL. If no
errors are encountered, then a null string is
returned. In order to use this feature, ERRMSG must
be defined first, e.g.
ERRMSG = ''
LIST_EXP_COMM, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1]
DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1]
DBOPEN [2], DBOPEN [3], TRIM, UNIQ [1], UNIQ [2], UNIQ [3], UTC2TAI
CALLED BY:
WRITE_CIF, XCAT
Common : None.
Restrictions: None.
Side effects: If the number of comments found is zero, then the output
parameter COMM is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 7 March 1996
Modified : Version 1, William Thompson, GSFC, 7 March 1996
Version 2, William Thompson, GSFC, 2 April 1996
Added keyword DATE_MOD
Version 3, William Thompson, GSFC, 12-Mar-1997
Added keyword END_DATE
Version 4, William Thompson, GSFC, 17-Mar-1997
Add ERRMSG in call to DBFIND
Version : Version 4, 17-Mar-1997
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_EXPER
Purpose : List the CDS raster as-run entries for a given date range
Explanation : Extracts all the CDS raster-level (experiment) as-run entries
which intersect an input time range.
Use : LIST_EXPER, START, END, OBS, N_FOUND [, /DATE_MOD ]
LIST_EXPER, PROG_NUM, OBS, N_FOUND
Inputs : One of the two following sets of input values must be passed.
START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
PROG_NUM = The program number to use in searching the
database.
Opt. Inputs : None.
Outputs : OBS = A structure variable containing the following tags
for each planned observation:
STRUCT_TYPE= The character string 'CDS-EXPERIMENT-LIST'
PROG_NUM = Study counter number. This forms the
primary key for this database.
PROG_ID = Program ID, linking one or more studies
together
PROG_IND = An index, reflecting one's position within
a repeated sequence of studies via the
N_REPEAT_S mechanism.
STUDY_ID = Number defining the study
STUDYVAR = Number giving the study variation ID
OBS_PROG = Name of the study
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
SEQ_NUM = Unique sequence number. This serves as
the primary key to the database.
OBS_SEQ = A character string derived from the raster
number and the variation number,
e.g. "R4V3".
COUNT = The number of repeated observations making
up this experiment. Normally 1.
SEQ_IND = The raster counter
RAS_ID = The raster ID number
RAS_VAR = The raster variation index
EXPTIME = The exposure time, in seconds
OBS_MODE = The observing mode.
DW_ID = The data window ID number
DATE_OBS = Date/time of beginning of observation,
in TAI format
DATE_END = Date/time of end of observation, in TAI
format
OBT_TIME = Onboard date/time of beginning of
observation, in TAI format
OBT_END = Onboard date/time of end of observation,
in TAI format
XCEN = Center of instrument field-of-view in
solar X
YCEN = Center of instrument field-of-view in
solar Y
ANGLE = Angle of instrument relative to solar
north
IXWIDTH = Width of field-of-view in instrument X
IYWIDTH = Width of field-of-view in instrument Y
INS_X0 = The instrument origin pointing in X
INS_Y0 = The instrument origin pointing in Y
INS_ROLL = The instrument roll angle
SC_X0 = The spacecraft pointing in X
SC_Y0 = The spacecraft pointing in Y
SC_ROLL = The spacecraft roll
WAVEMIN = The minimum wavelength of observation, in
Angstroms.
WAVEMAX = The maximum wavelength, in Angstroms
TRACKING = True if tracking is on
SER_ID = The series ID number
OPSLBITS = The OPS-L status bits at the start of the
observation.
OPSRBITS = The OPS-R status bits at the start of the
observation.
SLIT_POS = The slit position at the start of the
observation.
MIR_POS = The mirror position at the start of the
observation.
EV_ENAB = True if event recognition enabled
COMP_ERR = True if a compression error was
encountered.
VDS_PMCP = The VDS MCP programmable voltage setting
VDS_MODE = The VDS readout mode.
VDS_ORI = True if the VDS telemetry data is oriented
by columns
VDS_ACC = True if VDS is operated in accumulate mode
GSET_ID = GIS Setup ID
DETECTOR = Either N or G for NIS/GIS.
ZONE_ID = Pointing zone ID
SLIT_NUM = Slit number
FILENAME = FITS file name
SEQVALID = True for valid science data
DATASRC = Data source, either Q(uicklook) or F(inal
distribution).
COMMENTS = Either Y or N
DATE_MOD = Date and time when catalog record was last
modified.
N_FOUND = Number of observations found.
Opt. Outputs: None.
Keywords : DATE_MOD = If set, then the search is done on the modification
date rather than the start and stop dates.
SEARCH = Allows one to pass in an optional search string, as
used by DBFIND. For example, if one wants to search
for all instances where the object was a coronal
hole, then set
SEARCH='OBJECT=CH'
Multiple search criteria can be passed as a single
(case-insensitive) string separated by commas, e.g.
SEARCH='OBJECT=CH,STUDY_ID=11'
ERRMSG = If defined and passed, then any error messages will
be returned to the user in this parameter rather
than depending on the MESSAGE routine in IDL. If no
errors are encountered, then a null string is
returned. In order to use this feature, ERRMSG must
be defined first, e.g.
ERRMSG = ''
LIST_EXPER, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1], DBSORT [2], DBSORT [3]
FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3], TRIM, UNIQ [1], UNIQ [2]
UNIQ [3], UTC2TAI
CALLED BY:
CDS_ASRUN_POINT, CDS_COMPRESS, CDS_MOSAIC, EIS_LIST_EXPER [1]
EIS_LIST_EXPER [2], FIX_MAIN_TIMES, GET_CDS_ASRUN, GIS_UTPLOT, GT_CDS_QL
LIST_DURATION, MK_CDS_FITS, MK_CDS_GIF, SNAP_MOVIE, WRITE_CIF, XCAT
Common : None.
Restrictions: None.
Side effects: If the number of planned observations found is zero, then the
output parameter OBS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 3 July 1995
Modified : Version 1, William Thompson, GSFC, 3 July 1995
Version 2, William Thompson, GSFC, 31 January 1996
Added capability of calling with PROG_NUM
Version 3, William Thompson, GSFC, 23 February 1996
Modified for version 2 of the experiment databases.
Version 4, William Thompson, GSFC, 2 April 1996
Added keyword DATE_MOD
Version 5, William Thompson, GSFC, 2 April 1996
Added parameters DATASRC and OBS_PROG
Version 6, William Thompson, GSFC, 12 April 1996
Look in both experiment* and fexperiment*
Version 7, William Thompson, GSFC, 25 April 1996
Fixed bug in version 6 related to environment name
Version 8, William Thompson, GSFC, 03-Mar-1997
Added keyword SEARCH
Version 9, William Thompson, GSFC, 12-Mar-1997
Modified to pay attention to the end date when the
/DATE_MOD keyword is passed. This is so that the
END_DATE keyword in WRITE_CIF will work.
Version 10, William Thompson, GSFC, 17-Mar-1997
Add ERRMSG in call to DBFIND
Version 11, William Thompson, GSFC, 30-Apr-1997
Fixed bug where DATASRC was not being returned right.
Version 12, William Thompson, GSFC, 1 June 1998
Look for entries in "_year" files
Version : Version 12, 1 June 1998
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_F_RASTER
Purpose : List the fundamental parameters of all available rasters.
Explanation : Extracts the fundamental parameters of all the rasters from
the database.
Use : LIST_F_RASTER, RASTERS, N_FOUND
Inputs : None.
Opt. Inputs : None.
Outputs : RASTERS = A structure variable of type "cds_f_raster"
containing the following tags for each raster:
RAS_ID = Raster ID number.
DETECTOR = Either "G" for GIS or "N" for NIS.
RAS_DESC = A short description of the raster, giving
its purpose.
SLIT_NUM = The ID number for the slit to be used.
XSTEP = The step size in the X direction, in arcsec.
YSTEP = The step size in the Y direction, in arcsec.
NX = The number of exposure positions in X.
NY = The number of exposure positions in Y.
N_FOUND = Number of rasters found.
Opt. Outputs: None.
Keywords :
DETECTOR = Can be set to either "G" or "N" to extract only
entries for the GIS or NIS detectors. If not
passed, then all rasters are returned.
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_F_RASTER, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DB_INFO [1], DB_INFO [2], DB_INFO [3]
CALLED BY:
MK_STUDY, SHOW_RASTER, TP_DISP_RAST, UPDATE_RAS_DUR, XSHOW_RASTER
Common : None.
Restrictions: None.
Side effects: If the number of rasters found is zero, then the output
parameter RASTERS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 4 April 1994
Modified : Version 1.0, William Thompson, GSFC, 22 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version : Version 2, September 22, 1994
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_F_STUDY
Purpose : List the fundamental parameters of all available studies.
Explanation : Extracts the fundamental parameters of all the studies from
the database.
Use : LIST_F_STUDY, STUDIES, N_FOUND
Inputs : None.
Opt. Inputs : None.
Outputs : STUDIES = Structure variable of type "cds_f_study" containing
the following tags for each study:
STUDY_ID = Study ID number.
TITLE_ID = Study title ID number.
OBS_PROG = Name of the study
TITLE = A descriptive title for the study
CATEGORY = The study category, either "T"est,
"S"cience or "C"alibration.
VAR_POINT = Either "Y" or "N" representing whether or
not the pointing can be controlled by the
user. If "Y" then the pointing is
defined in the plan. If "N" then the
pointing is embedded within the study.
N_RASTER_DEF= Number of rasters in the definition.
N_FOUND = Number of studies found.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_F_STUDY, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
CATEGORY = If passed, then one of "T", "S", or "C" to select only
those studies with that category. If not passed, or passed
as the null string, then all studies are returned.
Calls : ***
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], DB_INFO [1]
DB_INFO [2], DB_INFO [3]
CALLED BY:
FIND_CDS_STUDY, SHOW_STUDY, UPDATE_STUDY_DUR
Common : None.
Restrictions: None.
Side effects: If the number of studies found is zero, then the output
parameter STUDIES is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 28 April 1994
Modified : Version 1, William Thompson, GSFC, 4 May 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 21 November 1994
Removed item N_RASTERS0
Added item N_RASTER_DEF
Version 4, William Thompson, GSFC, 10 February 1995
Changed N_POINTINGS to VAR_POINT.
Removed VAR_RASTERS.
Version 5, William Thompson, GSFC, 12 May 1995
Modified to split off separate study_title database
Version 6, William Thompson, GSFC, 30 November 1995
Added keyword CATEGORY
Version : Version 6, 30 November 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_FITS()
Purpose : Produce a list of available FITS files and optional info.
Explanation : Returns and optionally lists the available FITS files in
the official directory or user's own directory.
Use : IDL> ff = list_fits([filter, /own, /ql, /quiet, /hard, $
info=info])
Inputs : None
Opt. Inputs : filter - string which returned file names must contain.
Outputs : Function returns a string array
Opt. Outputs: None
Keywords : OWN - if present the current directory is searched rather
than the official $CDS_FITS_DATA
QL - if present a list of FITS files in the official QLI
directory ($CDS_FITS_QLI) is returned.
QUIET - if present the results are not listed to the screen
HARDCOPY - if present a hardcopyo fthe output is sent to
the default printer
INFO - if given as a output keytword variable the header
information is returned in it.
NOINFO - suppresses the header information
TIMERANGE - allows selection of files by date. If only one
value is given, it is taken as a 'start" date/time
Calls : ***
ANYTIM2CAL, ANYTIM2UTC [1], ANYTIM2UTC [2], Bell, DATATYPE [1], DATATYPE [2]
DATATYPE [3], FIND_FILES, HEADFITS [1], HEADFITS [2], HEADFITS [3], LOC_FILE [1]
LOC_FILE [2], LOC_FILE [3], PRINT_STR, REPCHAR, REPSTR [1], REPSTR [2], REPSTR [3]
STR2UTC [1], STR2UTC [2], STR2UTC [3], STRPAD, STR_PICK, TAI2UTC, UTC2TAI
CALLED BY:
GT_FPOINT
Common : None
Restrictions: None
Side effects: None
Category : Help, FITS
Prev. Hist. : None
Written : C D Pike, RAL, 1-Nov-95
Modified : Include filter string. CDP, 16-Nov-95
Collect and present FITS header info. CDP, 27-Jan-96
Add NOINFO and TIMERANGE keywords 2-Feb-96
Sort files for presentation of header. 4-Mar-96
Added GSET_ID for GIS files. 13-Mar-96
Added OBJECT and OBJ_ID. 14-Mar-96
Replace FINDFILE with LOC_FILE. CDP, 25-Mar-96
Fixed bug associated with last change. CDP, 28-Mar-96
Refix file finding. CDP, 1-Apr-96
Use find_files instead of previous fix. CDP, 8-May-96
Sort file list. CDP, 14-May-96
Version : Version 12, 14-May-96
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_FLAG
Purpose : List the CDS flag receiver status for a date range.
Explanation : Extracts all the CDS flag receiver science plan entries which
intersect an input time range.
Use : LIST_FLAG, START, END, PERIODS, N_FOUND
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : PERIODS = A structure variable containing the following tags
for each flag receiver period:
STRUCT_TYPE= The character string 'CDS-FLAG-LIST'
PROG_ID = Program ID, linking one or more studies
together
STUDY_ID = Number defining the study
STUDYVAR = Number giving the study variation ID
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
RCVR_START = Date/time of beginning of receiver status,
in TAI format
RCVR_STOP = Date/time of end of receiver status, in
TAI format
ORIG_DUR = Original duration of the observation, in
seconds, before being truncated by
following time-tagged observations.
N_RASTERS1 = Variable number of rasters parameter
TRACKING = True (1) if feature tracking to be used,
or false (0) otherwise
N_POINTINGS= Number of pointings to use with study.
Can be either 0 or 1.
REPOINT = Either 1 to allow repoints or 0 to
disallow.
GSET_ID = GSET ID number
N_FOUND = Number of periods found.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_FLAG, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1], DBSORT [2], DBSORT [3], TRIM, UNIQ [1]
UNIQ [2], UNIQ [3], UTC2TAI
CALLED BY:
WRITE_IAP
Common : None.
Restrictions: None.
Side effects: If the number of periods found is zero, then the output
parameter PERIODS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 25 July 1994
Modified : Version 1, William Thompson, GSFC, 3 August 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 21 November 1994
Modified so that items which only touch requested range
are excluded.
Added item N_REPEAT_S
Version 4, William Thompson, GSFC, 26 January 1995
Added tag STRUCT_TYPE
Version 5, William Thompson, GSFC, 13 February 1995
Changed the way that pointing is treated.
Version 6, William Thompson, GSFC, 8 May 1995
Modified to pay attention to DELETED field in database
Version 7, William Thompson, GSFC, 5 July 1995
Added tag REPOINT
Version 8, William Thompson, GSFC, 6 October 1995
Added tags ORIG_DUR, GSET_ID
Removed tag N_REPEAT_S
Version : Version 8, 6 October 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_GSET
Purpose : List GIS setup
Explanation : Extracts the descriptions of all the GIS setup descriptions
from the database.
Use : LIST_GSET, FIL_ID, GSETS, N_FOUND
Inputs : FIL_ID = Filament ID, either 0 (science), 1, or 2.
Opt. Inputs : None.
Outputs : GSETS = A structure variable containing the following tags
for each GIS setup entry:
GSET_ID = GIS setup ID number.
HVOLT = High voltages (4)
LLD = Low level discriminators (4)
LUT_CHKSUM = LUT checksum in hexidecimal notation (4)
LUT_PAR = LUT parameters (4,11)
RAW_ID = RAW GIS science data file ID (4)
SLIT_NUM = Slit number
ZONE_ID = Zone ID number
FIL_ID = Filament ID number, or 0 for science data
FFB = Front face bias, either -1 or +1
DET_USED = Whether or not detector is used, either 0
or 1 (4)
GSET_DESC = Free format descriptions (4)
N_FOUND = Number of GIS setups found.
Opt. Outputs: None.
Keywords : FFB = Select items with a particular front face bias,
either -1 or +1.
ERRMSG = If defined and passed, then any error messages will
be returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no
errors are encountered, then a null string is
returned. In order to use this feature, ERRMSG must
be defined first, e.g.
ERRMSG = ''
LIST_GSET, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3]
CALLED BY:
MK_CDS_PLAN, mk_gset
Common : None.
Restrictions: None.
Side effects: If the number of raw data files found is zero, then the output
parameter GSETS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 7 September 1995
Modified : Version 1, William Thompson, GSFC, 7 September 1995
Version 2, William Thompson, GSFC, 14 September 1995
Replace FIL_CUR with FFB
Add FIL_ID as input parameter
Add FFB as keyword parameter
Version 3, William Thompson, GSFC, 28 September 1995
Make LUT_CHKSUM an array.
Version 4, William Thompson, GSFC, 4 October 1995
Modified to reflect change in way LUT_PAR, LUT_CHKSUM,
and GSET_DESC are stored.
Version 5, William Thompson, GSFC, 25 January 1996
Modified definition of LUT_PAR and added DET_USED.
Version : Version 5, 25 January 1996
[Previous]
[Next]
NAME:
LIST_HDR_SUM
PURPOSE:
Output information from headers for easy comparison
CATEGORY:
Analysis
CALLING SEQUENCE:
list_hdr_sum, filelist [,keywords]
INPUTS:
filelist List of FITS files
OPTIONAL INPUTS:
keywords STRARR of keywords to list in addition to default
(default is filename, date/time-obs, naxis1,2)
KEYWORD PARAMETERS:
None
OUTPUTS:
Img_hdr.txt-style text file in current directory
OPTIONAL OUTPUTS:
None
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], FXPAR [1], FXPAR [2], HEADFITS [1]
HEADFITS [2], HEADFITS [3], TRIM
MODIFICATION HISTORY:
Written, N Rich, 04.04.05
SCCS variables for IDL use
@(#)list_hdr_sum.pro 1.1 05/03/04 :LASCO IDL LIBRARY
[Previous]
[Next]
NAME: list_ima_param.pro
PURPOSE: list the catalog in memory
CATEGORY: Preprocessing
CALLING SEQUENCE: CHOOSE_DARK, drk_new_name, drk, hdrk
INPUTS: template Template of files names to list
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: catalog lis in the screen
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: None
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)list_ima_param.pro 1.0 25/6/93 :LAS
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_INST_DLYD
Purpose : List the instrument delayed command times for a given period
Explanation : Extracts all the instrument delayed command upload times in the
input time range.
Use : LIST_INST_DLYD, START, END, RES, N_FOUND
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : RES = A structure variable containing the following tags
for each instrument delayed command period:
INSTRUME = Single letter code specifying the
instrument.
EARLIEST = The start time of the reserved time, in
TAI format.
LATEST = The end time of the reserved time, in TAI
format.
NUM_CMDS = The expected average number of OBDH block
commands per minute between the start time
and end time.
N_FOUND = Number of instrument delayed command periods found.
Opt. Outputs: None.
Keywords :
INSTRUMENT= If passed, then only the instrument delayed command periods
for the specified instrument will be returned. Can be
either a code letter or the full name. (See
GET_INSTRUMENT.)
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_INST_DLYD, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1], DBSORT [2], DBSORT [3]
GET_INSTRUMENT, TRIM, UNIQ [1], UNIQ [2], UNIQ [3], UTC2TAI
CALLED BY:
LIST_RESOURCE
Common : None.
Restrictions: None.
Side effects: If the number of planned instrument delayed command periods
found is zero, then the output parameter RES is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 6 March 1996
Modified : Version 1, William Thompson, GSFC, 6 March 1996
Version 2, William Thompson, GSFC, 13 March 1996
Changed order of parameters in output structure.
Version : Version 2, 13 March 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_LINELIST
Purpose : List all the available line lists.
Explanation : Extracts the names and descriptions of all the line lists from
the database.
Use : LIST_LINELIST, LISTS, N_FOUND
Inputs : None.
Opt. Inputs : None.
Outputs : LISTS = A structure variable containing the following tags
for each line list:
LL_ID = Line list ID number.
DETECTOR = Either "G" for GIS or "N" for NIS.
LL_DESC = A description of the line list, e.g.
"Temperature sensitive line pairs".
N_LINES = The number of lines in the line list.
N_FOUND = Number of lists found.
Opt. Outputs: None.
Keywords :
DETECTOR = Can be set to either "G" or "N" to extract only
entries for the GIS or NIS detectors. If not
passed, then all line lists are returned.
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_LINELIST, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DB_INFO [1], DB_INFO [2], DB_INFO [3]
CALLED BY:
FIX_LINELIST, SHOW_LINELIST, TP_DISP_LLIST, WHAT_USES
Common : None.
Restrictions: None.
Side effects: If the number of line lists found is zero, then the output
parameter LISTS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 31 March 1994
Modified : Version 1.0, William Thompson, GSFC, 22 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 15 March 1995
Removed LL_TITLE
Version : Version 3, 15 March 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_MAIN
Purpose : List the CDS main as-run entries for a given date range
Explanation : Extracts all the CDS study-level (main) as-run entries which
intersect an input time range.
Use : LIST_MAIN, START, END, OBS, N_FOUND [, /DATE_MOD ]
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : OBS = A structure variable containing the following tags
for each planned observation:
STRUCT_TYPE= The character string 'CDS-MAIN-LIST'
PROG_NUM = Study counter number. This forms the
primary key for this database.
PROG_ID = Program ID, linking one or more studies
together
PROG_IND = An index, reflecting one's position within
a repeated sequence of studies via the
N_REPEAT_S mechanism.
STUDY_ID = Number defining the study
STUDYVAR = Number giving the study variation ID
OBS_PROG = Name of the study
DETECTOR = Detector, "N", "G", or "B"(oth).
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
DATE_OBS = Date/time of beginning of observation,
in TAI format
DATE_END = Date/time of end of observation, in TAI
format
OBT_TIME = Onboard date/time of beginning of
observation, in TAI format
OBT_END = Onboard date/time of end of observation,
in TAI format
XCEN = Center of instrument field-of-view in
solar X
YCEN = Center of instrument field-of-view in
solar Y
ANGLE = Angle of instrument relative to solar
north
IXWIDTH = Width of field-of-view in instrument X
IYWIDTH = Width of field-of-view in instrument Y
SEQ_FROM = Start of range of observing sequence
numbers.
SEQ_TO = End of range of observing sequence
numbers.
COMMENTS = Either Y or N
DATE_MOD = Date and time when catalog record was last
modified.
However, if the keyword /SHORT_LIST is set, then only
a subset of the parameters are returned. This speeds
up access when called from XCAT.
N_FOUND = Number of observations found.
Opt. Outputs: None.
Keywords : DATE_MOD = If set, then the search is done on the modification
date rather than the start and stop dates.
SHORT_LIST = If set, then a shortened list of parameters is
returned.
SEARCH = Allows one to pass in an optional search string, as
used by DBFIND. For example, if one wants to search
for all instances where the object was a coronal
hole, then set
SEARCH='OBJECT=CH'
Multiple search criteria can be passed as a single
(case-insensitive) string separated by commas, e.g.
SEARCH='OBJECT=CH,STUDY_ID=11'
ERRMSG = If defined and passed, then any error messages will
be returned to the user in this parameter rather
than depending on the MESSAGE routine in IDL. If no
errors are encountered, then a null string is
returned. In order to use this feature, ERRMSG must
be defined first, e.g.
ERRMSG = ''
LIST_MAIN, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1], DBSORT [2], DBSORT [3], TRIM, UNIQ [1]
UNIQ [2], UNIQ [3], UTC2TAI
CALLED BY:
EIS_LIST_MAIN [1], EIS_LIST_MAIN [2], LIST_DURATION, MK_SUMMARY, REGEN_SYNOP
WRITE_CIF, XCAT
Common : None.
Restrictions: None.
Side effects: If the number of planned observations found is zero, then the
output parameter OBS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 3 July 1995
Modified : Version 1, William Thompson, GSFC, 3 July 1995
Version 2, William Thompson, GSFC, 2 April 1996
Added keyword DATE_MOD
Version 3, William Thompson, GSFC, 2 April 1996
Modified for version 3 of the catalog.
Version 4, William Thompson, GSFC, 2 May 1996
Added keyword /SHORT_LIST
Version 5, William Thompson, GSFC, 03-Mar-1997
Added keyword SEARCH
Version 6, William Thompson, GSFC, 12-Mar-1997
Modified to pay attention to the end date when the
/DATE_MOD keyword is passed. This is so that the
END_DATE keyword in WRITE_CIF will work.
Version 7, William Thompson, GSFC, 17-Mar-1997
Add ERRMSG in call to DBFIND
Version 8, William Thompson, GSFC, 24-Jul-1997
Filter out negative PROG_NUM values.
Version : Version 8, 24-Jul-1997
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_MDI_M
Purpose : List the MDI-M times for a given period
Explanation : Extracts all the MDI Magnetogram (MDI-M) observation times in
the input time range.
Use : LIST_MDI_M, START, END, MDI_M, N_FOUND
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : MDI_M = A structure variable containing the following tags
for each planned contact period:
START_TIME = Date/time of beginning of the MDI_M
observaton, in TAI format
END_TIME = Date/time of end of MDI_M observation,
in TAI format
N_FOUND = Number of planned contact periods found.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_MDI_M, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1], DBSORT [2], DBSORT [3], TRIM, UNIQ [1]
UNIQ [2], UNIQ [3], UTC2TAI
Common : None.
Restrictions: None.
Side effects: If the number of planned MDI-M observations found is zero, then
the output parameter MDI_M is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 3 April 1995
Modified : Version 1, William Thompson, GSFC, 3 April 1995
Version : Version 1, 3 April 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_NRT_RES
Purpose : List the NRT reserved times for a given period
Explanation : Extracts all the instrument NRT reserved times in the input
time range.
Use : LIST_NRT_RES, START, END, RES, N_FOUND
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : RES = A structure variable containing the following tags
for each NRT reserved period:
INSTRUME = Single letter code specifying the
instrument.
START_TIME = The start time of the reserved time, in
TAI format.
END_TIME = The end time of the reserved time, in TAI
format.
CMD_RATE = The expected average number of OBDH block
commands per minute between the start time
and end time.
STATUS = The acceptance status for this activity.
Possible values are R=requested,
C=confirmed, or D=denied. Only the first
character is stored in the database.
N_FOUND = Number of NRT reserved periods found.
Opt. Outputs: None.
Keywords :
INSTRUMENT= If passed, then only the NRT reserved periods for the
specified instrument will be returned. Can be either a
code letter or the full name. (See GET_INSTRUMENT.)
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_NRT_RES, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1], DBSORT [2], DBSORT [3]
GET_INSTRUMENT, TRIM, UNIQ [1], UNIQ [2], UNIQ [3], UTC2TAI
CALLED BY:
LIST_COM_TIMES, LIST_RESOURCE
Common : None.
Restrictions: None.
Side effects: If the number of planned NRT reserved periods found is zero,
then the output parameter RES is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 3 April 1995
Modified : Version 1, William Thompson, GSFC, 3 April 1995
Version 2, William Thompson, GSFC, 7 April 1995
Fixed bug with multiple entries.
Version 3, William Thompson, GSFC, 11 April 1995
Added keyword INSTRUMENT
Version 4, William Thompson, GSFC, 17 August 1995
Fixed bug when only one entry is found.
Version 5, William Thompson, GSFC, 13 March 1996
Changed order of parameters in output structure.
Version : Version 5, 13 March 1996
[Previous]
[Next]
NAME:
list_nrt_times
PURPOSE:
To read the ECS/EAP file and to determine when the DSN
contacts times will be and make a summary file for the use
of the EGSE (for reporting purposes)
SAMPLE CALLING SEQUENCE:
list_nrt_times,ut_time()
CALLS: ***
SSW_FILE_DELETE, anytim2ints [1], anytim2ints [2], data_type [1], data_type [2]
fmt_tim [1], fmt_tim [2], gt_day [1], gt_day [2], int2secarr [1], int2secarr [2]
rd_tfile [1], rd_tfile [2]
RESTRICTIONS:
The routine MK_MDI_IAP must be compiled before running this
since there are functions within that file which are used by
this routine.
HISTORY:
Written 7-Aug-95 by M.Morrison
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_OBJECT
Purpose : List the available SoHO object abbreviations.
Explanation : Extracts the names and abbreviations of all the SoHO object
classes.
Use : LIST_OBJECT, OBJECTS, N_FOUND
Inputs : None.
Opt. Inputs : None.
Outputs : OBJECTS = A structure variable containing the following tags
for each object:
OBJECT = Three letter object code
OBJECT_DESC = Expanded-out name of the object
N_FOUND = Number of objects found.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_OBJECT, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DB_INFO [1], DB_INFO [2], DB_INFO [3]
CALLED BY:
GET_OBJECT, MK_CDS_PLAN, MK_SOHO
Common : Common block LIST_OBJECT contains the result of the first
time this routine is called. Subsequent calls go to this
common block rather than directly to the file.
Restrictions: None.
Side effects: If the number of objects found is zero, then the output
parameter OBJECTS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 27 July 1994
Modified : Version 1, William Thompson, GSFC, 27 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 22 May 1995
Made output variable a named structure.
Version 4, William Thompson, GSFC, 14 August 1995
Added common block LIST_OBJECT.
Changed so that leading and trailing blanks are
trimmed.
Version : Version 4, 14 August 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_OTHER_OBS
Purpose : List plan for other observatories for given date range
Explanation : Extracts all the "Other_Obs" plan entries which intersect an
input time range.
Use : LIST_OTHER_OBS, START, END, OBS, N_FOUND
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : OBS = A structure variable containing the following tags
for each planned observation:
STRUCT_TYPE = The character string 'OTHER-OBS-LIST'.
TELESCOP = The name of the telescope.
MNEMONIC = The mnemonic for the telescope.
SCI_OBJ = Science objective
SCI_SPEC = Specific science objective
NOTES = Further notes about the observation
START_TIME = Date/time of beginning of observation,
in TAI format
END_TIME = Date/time of end of observation, in TAI
format
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
CMP_NO = Campaign number
N_FOUND = Number of planned observations found.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_OTHER_OBS, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1], DBSORT [2], DBSORT [3], TRIM, UNIQ [1]
UNIQ [2], UNIQ [3], UTC2TAI
Common : None.
Restrictions: None.
Side effects: If the number of planned observations found is zero, then the
output parameter OBS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 12 April 1995
Modified : Version 1, William Thompson, GSFC, 12 April 1995
Version : Version 1, 12 April 1995
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
LIST_OTHER_RES
PURPOSE:
List simple resource items that contains only start & stop times
CATEGORY:
Planning, Database.
EXPLANATION:
Extracts all the times for any resource items, which contain
only START_TIME and END_TIME, in the input time
range. Currently the following resource items can be listed
through this routine:
TLM_MDI_M, TLM_MDI_H, TLM_TAPE_DUMP, THROUGHPUT_RCR,
THROUGHPUT_NORCR, SVM_RESERVED, PAYLOAD_RESERVED
SYNTAX:
list_other_res, start, end, resource, n_found, /extra
INPUTS:
START, END - The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
OPTIONAL INPUTS:
None.
OUTPUTS:
RESOURCE - A structure variable containing the following tags
for each planned contact period:
START_TIME = Date/time of beginning of the resource,
in TAI format
END_TIME = Date/time of end of the resource,
in TAI format
N_FOUND - Number of planned contact periods found
OPTIONAL OUTPUTS:
None.
KEYWORDS:
EXTRA - Unambiguous resource keyword (e.g. TAPE_DUMP, MDI_M, COM ...)
ERRMSG - If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_MDI_M, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1], DBSORT [2], DBSORT [3], GET_RES_NAME
GREP, TRIM, UNIQ [1], UNIQ [2], UNIQ [3], UTC2TAI
CALLED BY:
LIST_RESOURCE
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, August 17, 1995, Liyun Wang, GSFC/ARC. Written
CONTACT:
Liyun Wang, GSFC/ARC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_PLAN
Purpose : List the SoHO science plan for a given date range.
Explanation : Extracts all the SoHO science plan entries which intersect an
input time range.
Use : LIST_PLAN, START, END, OBS, N_FOUND
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : OBS = A structure variable containing the following tags
for each planned observation:
STRUCT_TYPE = The character string 'SOHO-PLAN-LIST'.
INSTRUME = Single letter code specifying the
instrument.
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
NOTES = Further notes about the observation
START_TIME = Date/time of beginning of observation,
in TAI format
END_TIME = Date/time of end of observation, in TAI
format
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
PROG_ID = Program ID, linking one or more studies
together
CMP_NO = Campaign number
XCEN = Center(s) of instrument FOV along X
axis, given as a character string.
YCEN = Center(s) of instrument FOV along Y
axis, given as a character string.
DISTURBANCES = Description of any disturbances
N_FOUND = Number of planned observations found.
Opt. Outputs: None.
Keywords :
INSTRUMENT = If passed, then the name or code value for the
instrument to retrieve the plan for. Otherwise,
the plans for all the instruments are retrieved.
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_PLAN, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2], DATATYPE [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1]
DBSORT [2], DBSORT [3], FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3]
GET_INSTRUMENT, TRIM, UNIQ [1], UNIQ [2], UNIQ [3], UTC2TAI
CALLED BY:
CDS_PLAN_BRIEF, EXPORT_PLAN, IMPORT_PLAN, MK_PLAN_READ, MK_SOHO_TARGET, RD_PLAN
READ_KAP, SHOW_PLAN, WRITE_CAP, WRITE_IAP
Common : None.
Restrictions: None.
Side effects: If the number of planned observations found is zero, then the
output parameter OBS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 26 July 1994
Modified : Version 1, William Thompson, GSFC, 3 August 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 21 November 1994
Modified so that items which only touch requested range
are excluded.
Version 4, William Thompson, GSFC, 26 January 1995
Added tag STRUCT_TYPE
Version 5, William Thompson, GSFC, 8 May 1995
Modified to pay attention to DELETED field in database
Version 6, William Thompson, GSFC, 18 August 1995
Added tags XCEN, YCEN
Version 7, William Thompson, GSFC, 26 May 1998
Look for entries in "_year" files
Version : Version 7, 26 May 1998
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_PROGRAM
Purpose : List the available CDS program definitions.
Explanation : Extracts the names and IDs of all the CDS multi-observation
program definitions.
Use : LIST_PROGRAM, PROGRAMS, N_FOUND
Inputs : None.
Opt. Inputs : None.
Outputs : PROGRAMS = A structure variable containing the following tags
for each program:
PROGNAME = Name of the program.
PROG_ID = Unique identifier number.
N_FOUND = Number of programs found.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_PROGRAM, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DB_INFO [1], DB_INFO [2], DB_INFO [3]
CALLED BY:
MK_SOHO, XPROGRAM
Common : None.
Restrictions: None.
Side effects: If the number of programs found is zero, then the output
parameter PROGRAMS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 21 July 1994
Modified : Version 1.0, William Thompson, GSFC, 26 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version : Version 2, September 22, 1994
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_RAW
Purpose : List raw data files for given GIS detector
Explanation : Extracts the descriptions of all the GIS raw data files from
the database, for a given detector number and filament ID. Set
the filament ID to 0 to select raw science data.
Use : LIST_RAW, DET_NUM, FIL_ID, RAW_FILES, N_FOUND
Inputs : DET_NUM = The GIS detector number to search on, 1-4
FIL_ID = The filament ID, 0 (science), 1, 2.
Opt. Inputs : None.
Outputs : RAW_FILES = A structure variable containing the following tags
for each raw data file entry:
RAW_ID = Raw data file ID number.
RAW_DESC = Free format description
START_TIME = Start time of data taking, in TAI format.
DET_NUM = GIS detector number: 1-4
SLIT_NUM = Slit number
HVOLT = High voltage value
LLD = Low level discriminator value
CNT_RATE = Count rate range (min, max)
RAW_FILE = Raw data file name
FFB = Front face bias
FIL_ID = Filament ID number, or 0 for science data
FIL_CUR = Filament current
ZONE_ID = Zone ID number
N_FOUND = Number of raw file entries found.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_RAW, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3]
Common : None.
Restrictions: None.
Side effects: If the number of raw data files found is zero, then the output
parameter RAW_FILES is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 7 September 1995
Modified : Version 1, William Thompson, GSFC, 7 September 1995
Version 2, William Thompson, GSFC, 14 September 1995
Added RAW_DESC, rename FF_BIAS to FFB to match GSET
database.
Version : Version 2, 14 September 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_RES_TYPE
Purpose : List all resource types
Explanation : Extracts a list of all resource type names from the
resource_type database.
Use : LIST_RES_TYPE, TYPES [, IDS ]
Inputs : None.
Opt. Inputs : None.
Outputs : TYPES = A string array of all resource type names.
Opt. Outputs: IDS = ID numbers associated with the TYPES.
Keywords : None.
Calls : ***
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBOPEN [1], DBOPEN [2], DBOPEN [3]
CALLED BY:
ADD_RESOURCE, GET_RES_NAME, READ_KAP
Common : Common block LIST_RES_TYPE contains the result of the first
time this routine is called. Subsequent calls go to this
common block rather than directly to the file.
Restrictions: None.
Side effects: None.
Category : Planning, database
Prev. Hist. : None.
Written : William Thompson, GSFC, 3 April 1995
Modified : Version 1, William Thompson, GSFC, 3 April 1995
Version 2, William Thompson, GSFC, 14 August 1995
Added common block LIST_RES_TYPE and optional output
parameter.
Version : Version 2, 14 August 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_RESOURCE
Purpose : List the resource times for a given period
Explanation :
Use : LIST_RESOURCE, START, END, RESOURCE, N_FOUND
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : RESOURCE = A structure variable containing the following tags
for each planned contact period:
START_TIME = Date/time of beginning of the RESOURCE
observaton, in TAI format
END_TIME = Date/time of end of RESOURCE observation,
in TAI format
N_FOUND = Number of planned contact periods found.
Opt. Outputs: None.
Keywords :
ERRMSG = error message
EXTRA = resource keyword (e.g. TAPE_DUMP, MDI_M, COM ...)
RES_NAME = actual resource read
CALLED BY:
RD_RESOURCE
Restrictions: None.
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2], DATATYPE [3]
DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], GET_RES_NAME, GREP
LIST_COM_TIMES, LIST_DSN, LIST_INST_DLYD, LIST_NRT_RES, LIST_OTHER_RES
LIST_SUPPORT, UTC2TAI, WHICH_INST, delvarx [5]
Side effects: None.
Category : Planning, Database.
Prev. Hist. : None.
Written : Dominic Zarro, GSFC, 3 August 1995
Version 2, March 15, 1996, Liyun Wang, GSFC/ARC
list_inst_dlyd not called for SUMER
Version : Version 2, March 15, 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_SOHO_DET
Purpose : List the SoHO detailed plan for a given date range.
Explanation : Extracts all the SoHO detailed science plan entries which
intersect an input time range.
Use : LIST_SOHO_DET, START, END, OBS, N_FOUND
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : OBS = A structure variable containing the following tags
for each planned observation:
STRUCT_TYPE = The character string 'SOHO-DET-LIST'.
INSTRUME = Single letter code specifying the
instrument.
DATE_OBS = Date/time of beginning of observation,
in TAI format
DATE_END = Date/time of end of observation, in TAI
format
SCI_OBJ = Science objective
SCI_SPEC = Specific science objective
OBS_PROG = Observing program that will be run
PROG_ID = Program ID, linking one or more studies
together
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
XCEN = Center(s) of instrument field-of-view
along X axis
YCEN = Center(s) of instrument field-of-view
along Y axis
ANGLE = Rotation angle(s) of field-of-view
relative to solar north
IXWIDTH = Width(s) of field-of-view in instrument
X direction
IYWIDTH = Width(s) of field-of-view in instrument
Y direction
DISTURBANCES = Description of any disturbances
JITTER_LIMIT = Jitter limit in 1/10 arcsec units
N_FOUND = Number of planned observations found.
Opt. Outputs: None.
Keywords :
INSTRUMENT = If passed, then the name or code value for the
instrument to retrieve the plan for. Otherwise,
the plans for all the instruments are retrieved.
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_SOHO_DET, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DBSORT [1], DBSORT [2], DBSORT [3]
GET_INSTRUMENT, TRIM, UNIQ [1], UNIQ [2], UNIQ [3], UTC2TAI
CALLED BY:
MK_PLAN_HTML, MK_PLAN_READ, MK_SOHO_TARGET, RD_PLAN, READ_KAP
Common : None.
Restrictions: None.
Side effects: If the number of planned observations found is zero, then the
output parameter OBS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 12 April 1995
Modified : Version 1, William Thompson, GSFC, 12 April 1995
Version 2, William Thompson, GSFC, 22 May 1995
Modified to take into account DELETED field.
Version : Version 2, 22 May 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_SUPPORT
Purpose : List Ground Support a given period
Explanation : Temparary replacement of LIST_OTHER_OBS
Use : LIST_SUPPORT, START, END, SUPPORT, N_FOUND
Inputs : START, END = The range of date/time values to use in searching
the database. Can be in any standard CDS time
format.
Opt. Inputs : None.
Outputs : Support = A structure variable containing the following tags
for each planned observation:
STRUCT_TYPE = The character string 'OTHER-OBS-LIST'.
TELESCOP = The name of the telescope.
MNEMONIC = The mnemonic for the telescope.
SCI_OBJ = Science objective
SCI_SPEC = Specific science objective
NOTES = Further notes about the observation
START_TIME = Date/time of beginning of observation,
in TAI format
END_TIME = Date/time of end of observation, in TAI
format
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
CMP_NO = Campaign number
N_FOUND = Number of support periods found.
Opt. Outputs: None.
Keywords : None.
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CONCAT_STRUCT, DELVARX [1], DELVARX [2]
DELVARX [3], DELVARX [4], TAI2UTC, UTC2TAI, delvarx [5]
CALLED BY:
LIST_RESOURCE
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Database.
Prev. Hist. : None.
Written : Version 1, Dominic Zarro, 29 June 1995.
Version 2, William Thompson, GSFC, 16 September 1996
Updated times to put into UT timezone.
[Previous]
[Next]
pro list_tfi, fnam, info, str_info, quiet=quiet, outfil=outfil, blks=blks,$
human=human
Procedure to list an index file
CALLS: ***
anytim2ints [1], anytim2ints [2], dec2sun [1], dec2sun [2], dpcstr [1], dpcstr [2]
fmt_tim [1], fmt_tim [2], get_host [1], get_host [2], gt_time [1], gt_time [2]
mk_tfi
CALLED BY:
check_dumps [1], check_ff_load, disp_sci160k [1], disp_sci160k [2]
jitter_gif_xyimg, monitor_center [1], read_mdi16, tfr_summary, tfr_summary2
wrt_sci160k_img, xcheckip, xdisp_tfr, xset_chain [1], xset_chain [2]
HISTORY:
20-Sep-94 (MDM) - Added INFO output
- Changed format statement
6-Feb-95 (MDM) - Changed to print out start time of data
product based on packet time
6-Feb-95 (MDM) - Added common block to save host name so
don't have to spawn with call to GET_HOST
- Added FREE_LUN call
- Added check for non zero number of datasets
31-Mar-95 (MDM) - Changed format statement to display SeqID
- Print out a title line
3-Apr-95 (MDM) - Added /QUIET keyword
- Added end file and frame to the output structure
3-Apr-95 (MDM) - Close the unit if no data
15-Sep-95 (MDM) - Added OUTFIL option
22-Sep-95 (MDM) - Added STR_INFO output option
13-Nov-95 (MDM) - Modified to display the RefTime and Frame #
16-Nov-95 (MDM) - Modifed to run faster - Read all at once
11-Dec-95 (MDM) - Added the name of the file to the header of the
output file
18-Dec-95 (MDM) - Added protection for .tfr files with no images
15-Jan-97 (CED) - Added human-readable DPC labels ("/human" switch)
24-Feb-97 (MDM) - Added file delete before open
19-Nov-99 (RIB) - When no data products are in a file, a warning message
is placed in the file instead of deleting it
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_TM()
Purpose : Produce a list of available TM files.
Explanation : Returns and optionally lists the available TM files in
the official directory or user's own directory.
Use : IDL> ff = list_tm([filter, /own])
Inputs : None
Opt. Inputs : filter - string which returned file names must contain.
Outputs : Function returns a string array
Opt. Outputs: None
Keywords : OWN - if present the current directory is searched rather
than the official $CDS_TM_DATA
QUIET - if present the results are not listed to the screen
Calls : ***
Bell, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], PRINT_STR, concat_dir [4]
Common : None
Restrictions: None
Side effects: None
Category : Help, telemetry
Prev. Hist. : None
Written : C D Pike, RAL, 24-Nov-95
Modified :
Version : Version 1, 24-Nov-95
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_TO_DETAIL
Purpose : convert LIST structure to DETAILS structure
Explanation :
Use : DETAIL=LIST_TO_DETAIL(LIST)
Inputs : PLAN = list structure (scalar or array)
Opt. Inputs : None.
Outputs : DETAIL = details structure
Opt. Outputs: NOBS = number of observations
Keywords : SORT = set to sort in time
Calls : ***
CONCAT_STRUCT, COPY_STRUCT [1], COPY_STRUCT [2], COPY_STRUCT [3], DEF_INST_PLAN
EXIST, GET_PLAN_FUNCT, GET_PLAN_ITIME, GET_PLAN_TYPE, MK_PLAN_SORT, WHICH_INST
Common : None.
Restrictions: None.
Side effects: None
Category : Planning, Database.
Prev. Hist. : None.
Written : Dominic Zarro (ARC), 18 March 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_V_RASTER
Purpose : List the defined variations for a given raster ID.
Explanation : Extracts the variable parameters of all the rasters in the
database with a specific raster ID.
Use : LIST_V_RASTER, RAS_ID, RASTERS, N_FOUND
Inputs : RAS_ID = Raster ID number.
Opt. Inputs : None.
Outputs : RASTERS = A structure variable of type "cds_v_raster"
containing the following tags for each raster:
RAS_ID = Raster ID number.
RAS_VAR = Raster variation index.
RV_DESC = A short description of the raster
variation beyond what is given in the
associated fundamental raster description.
EXPTIME = Exposure time in seconds, to millisecond
accuracy.
LL_ID = Line list ID. Alternatively, this can be
zero to signal that the raster is not
connected to a line list.
COMP_ID = Compression method ID.
COMP_OPT = Compression option parameter.
DW_ID = Data extraction window list ID.
IEF_ID = Inter-instrument event flag ID.
VDS_ORIENT = VDS orientation, either 0 (row) or 1
(column).
VDS_MAP = VDS mapping mode: 2=Normal, 3=Accumulate
TEL_RATE = Estimated required telemetry rate, as a
character representing Low/Medium/High
DURATION = Estimated duration of the raster, in
seconds.
USABLE = Either "Y" or "N" to signal whether or not
the raster is usable.
N_FOUND = Number of rasters found.
Opt. Outputs: None.
Keywords :
USABLE = If set, then only those entries with USABLE=Y will be
returned. This is the default behavior.
ALL = If set, then all entries matching the search criteria will
be returned, regardless of the value of USABLE.
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_V_RASTER, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3]
CALLED BY:
MK_STUDY, SHOW_RASTER, TP_DISP_RAST, UPDATE_RAS_DUR, XSHOW_RASTER
Common : None.
Restrictions: None.
Side effects: If the number of rasters found is zero, then the output
parameter RASTERS is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 5 April 1994
Modified : Version 1, William Thompson, GSFC, 29 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 4, William Thompson, GSFC, 15 March 1995
Changed TEL_RATE to character
Version 5, William Thompson, GSFC, 27 October 1995
Added item IEF_ID.
Version 6, William Thompson, GSFC, 26 April 1996
Added keyword /ALL. Default behavior is to now only
list usable rasters.
Version : Version 6, 26 April 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : LIST_V_STUDY
Purpose : List the defined variations for a given study.
Explanation : Extracts the variable parameters of all the studies in the
database with a specific study ID.
Use : LIST_V_STUDY, STUDY_ID, STUDIES, N_FOUND
LIST_V_STUDY, TITLE_ID, STUDIES, N_FOUND, /USE_TITLE
LIST_V_STUDY, OBS_PROG, STUDIES, N_FOUND
Inputs : STUDY_ID = Study ID number, or
TITLE_ID = Title ID number, or
OBS_PROG = Study name.
Opt. Inputs : None.
Outputs : STUDIES = A structure variable of type "cds_v_study"
containing the following tags for each study:
STUDY_ID = Study ID number.
TITLE_ID = Study title ID number.
OBS_PROG = Name of the study
TITLE = A descriptive title for the study
CATEGORY = The study category, either "T"est,
"S"cience or "C"alibration.
N_RASTERS0 = Fixed part of the number of rasters in
the study.
VAR_POINT = Either "Y" or "N" representing whether or
not the pointing can be controlled by the
user. If "Y" then the pointing is
defined in the plan. If "N" then the
pointing is embedded within the study.
N_RASTER_DEF= Number of rasters in the definition.
STUDYVAR = Study variation index.
SV_DESC = A short description of the study
variation beyond what is given in the
associated fundamental study description.
DURATION0 = Fixed part of the study duration, in
seconds.
DURATION1 = Number of seconds/raster for the variable
part of the study duration.
ZONE_ID = Pointing zone ID.
USABLE = Either "Y" or "N" to signal whether or
not the study is usable. Normally "Y".
N_FOUND = Number of studies found.
Opt. Outputs: None.
Keywords :
USE_TITLE = If set, then the input parameter is the title ID rather
than the study ID. Not required if OBS_PROG is passed.
USABLE = If set, then only those entries with USABLE=Y will be
returned. This is the default behavior.
ALL = If set, then all entries matching the search criteria will
be returned, regardless of the value of USABLE.
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
LIST_V_STUDY, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3]
CALLED BY:
FIND_CDS_STUDY, UPDATE_STUDY_DUR
Common : None.
Restrictions: None.
Side effects: If the number of studies found is zero, then the output
parameter STUDIES is not modified.
Category : Planning, Database.
Prev. Hist. : None.
Written : William Thompson, GSFC, 29 April 1994
Modified : Version 1, William Thompson, GSFC, 29 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 21 November 1994
Added item N_RASTER_DEF
Version 4, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 5, William Thompson, GSFC, 10 February 1995
Changed N_POINTINGS to VAR_POINT.
Removed VAR_RASTERS.
Version 6, William Thompson, GSFC, 29 March 1995
Added tag ZONE_ID
Version 7, William Thompson, GSFC, 12 May 1995
Modified to split off separate study_title database
Version 8, William Thompson, GSFC, 20 June 1995
Added tag FLAGABLE.
Version 9, William Thompson, GSFC, 27 October 1995.
Removed tag flagable. Any study can produce a flag if
given an IEF_ID.
Version 10, William Thompson, GSFC, 26 April 1996
Added keyword /ALL. Default behavior is to now only
list usable studies.
Version : Version 10, 26 April 1996
[Previous]
[Next]
Project : SOHO - CDS
Name :
LIST_WITH_PATH()
Purpose :
Searches for files with a default path and extension.
Explanation :
Lists files in a set of default paths, similar to using FINDFILE,
except that a list of paths to be searched can be given.
Use :
Result = LIST_WITH_PATH( FILENAME, PATHS )
FILENAME = ''
READ, 'File to open: ', FILENAME
FILE = LIST_WITH_PATH( FILENAME, 'SERTS_DATA', '.fix' )
IF FILE NE '' THEN ...
Inputs :
FILENAME = Name of file to be searched for. It may contain wildcard
characters, e.g. "*.dat".
PATHS = One or more default paths to use in the search in case
FILENAME does not contain a path itself. The individual
paths are separated by commas, although in UNIX, colons
can also be used. In other words, PATHS has the same
format as !PATH, except that commas can be used as a
separator regardless of operating system. The current
directory is always searched first, unless the keyword
NOCURRENT is set.
A leading $ can be used in any path to signal that what
follows is an environmental variable, but the $ is not
necessary. (In VMS the $ can either be part of the path,
or can signal logical names for compatibility with Unix.)
Environmental variables can themselves contain multiple
paths.
Opt. Inputs :
None.
Outputs :
The result of the function is a list of filenames.
Opt. Outputs:
None.
Keywords :
None.
Calls : ***
BREAK_PATH [1], BREAK_PATH [2], BREAK_PATH [3], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], concat_dir [4]
CALLED BY:
DBHELP [1], DBHELP [2], DBHELP [3], DBOPEN [1], DBOPEN [2], DBOPEN [3]
Common :
None.
Restrictions:
None.
Side effects:
None.
Category :
Utilities, Operating_system
Prev. Hist. :
None.
Written :
William Thompson, GSFC, 3 November 1994
Modified :
Version 1, William Thompson, GSFC, 3 November 1994
Version :
Version 1, 3 November 1994
[Previous]
[Next]
NAME: LOAD_CAL.PRO
PURPOSE: Visualizes a array image of calibration
(in memory yet)
CATEGORY: Preprocessing high level routine
CALLING SEQUENCE: iout = LOAD_CAL ( ima, lcut, hcut, itest,
nx_out, ny_out )
INPUTS: ima image array
lcut,hcut low an hight cuts
itest operating mode for big images
itest eq 1 not rebin
itest ne 1 rebin by 2 if 1124 pix
images ; OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: Image on screen
iout
nx_out
ny_out
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: None
RESTRICTIONS: None
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)load_cal.pro 1.0 25/6/93 :LAS
[Previous]
[Next]
NAME: LOAD_IMA.PRO
PURPOSE: Visualize a image array yet in memory
CATEGORY: General tools high level routine
CALLING SEQUENCE: ima, lcut, hcut, kx, ky
INPUTS: ima image array
lcut,hcut low and hight cut
kx, ky zoom parameters
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: image on screen
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)load_ima.pro 1.0 25/6/93 :LAS
[Previous]
[Next]
.Name: LOAD_LUT
.Type: IDL procedure
.Filename: CAM_PRO_DIR:CQ_LOAD_LUT.PRO
.Purpose:
This procedure loads the CAM specific color tables.
containing the 4 reserved color indices.
.History:
0.0 20-DEC-1993 P. Gallais - First writting
0.1 10-SEP-1997 C. Maurel - get lut files from QLROOT
.Calling sequence:
LOAD_LUT, lut_id
.Arguments:
lut_id input ??? the IDL id of the lut
to load
.Include files:
.Inputs:
none
.Outputs:
r_orig colors bytarr Red color indices
g_orig colors bytarr Green color indices
b_orig colors bytarr Blue color indices
.Calling:
none
.Called by:
[Previous]
[Next]
Project : SOHO - LASCO
Name :
Purpose :
Category :
Explanation :
Syntax :
CALLED BY:
WCALCL, WCALCNEW, WIMG_INFO1, WIMG_INFO2, WIMG_INFO3, WIMG_INFO4, WINFO_ACTIV, WLISTER
WLOAD, WLOADC, WLOADINFO, WLOADINFO1
Examples :
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Common :
Restrictions:
Side effects: Not known
History : Version 1, 02-Sep-1995, B Podlipnik. Written
Contact : BP, borut@lasco1.mpae.gwdg.de
[Previous]
[Next]
Project : SOHO - CDS
Name : LOAD_RED
Purpose : Load "Red Temperature" with a gamma effect.
Explanation : Purpose says it all.
Use : LOAD_RED,GAMMA
Inputs :
Opt. Inputs : GAMMA
Outputs : None
Opt. Outputs: None.
Keywords : None.
Calls : ***
GAMMA_CT, LOADCT
CALLED BY:
CDS_THUMBNAIL, DSPEXP, DSPWAV, NDSPSPEC
Common : None
Restrictions:
Side effects: Changes current color table.
Category : CDS, QL, DISPLAY, UTILITY
Prev. Hist. : None.
Written : SVHH, March 14, 1994
Modified : SVHH, March 15, 1994
Added gamma.
Version 2, William Thompson, GSFC, 8 April 1998
Changed !D.N_COLORS to !D.TABLE_SIZE for 24-bit displays
Version 3, 18-Aug-1998, William Thompson, GSFC
Use GAMMA_CT instead of STRETCH
Version : Version 2, 8 April 1998
[Previous]
[Next]
Project : SOHO - CDS
Name : LOAD_TP_STRUCT
Purpose : Load the raster planning structure onto the screen widgets.
Explanation : The input parameter is a structure of the type defined in
tp_def_struct to specify a raster. The values within this
structure are loaded into their appropriate widgets on the
technical planning screen page1.
Use : IDL> load_tp_struct, tp_str
Inputs : tp_str - the raster definition structure. See tp_def_struct
for its definition.
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
Bell, COPY_STRUCT [1], COPY_STRUCT [2], COPY_STRUCT [3], DATATYPE [1]
DATATYPE [2], DATATYPE [3], DISPLAY_GIS_WIN, DISPLAY_NIS_WIN, GET_DATAWIN
GET_LINELIST, GET_RASTER, GET_UTC, GET_VDS_SLITPOS, GET_VDS_STATE, LOADCT, MODE_VAL
ROUND_OFF, SORT_WINDOWS, STR_PICK, TP_BSCALE, TP_COLTABLE, TP_DB2INT, TP_GET_DUMDATA
TP_LOAD_VDSBACK, TP_PLOT_GIS, TP_UPDATE_PIX, TP_VDS_AXES
CALLED BY:
MK_RASTER, TP_DISP_LLIST, TP_DISP_RAST
Restrictions: Uses technical planning common blocks for passing information.
Side effects: None
Category : Technical planning
Prev. Hist. : None
Written : C D Pike, RAL, 30-Jun-1993
Modified : Fix possible arithmetic bug. CDP, 5-Jul-94.
Updated for new tplan structure. CDP, 8-Jul-94
Trim procedure call names to 15 chars. CDP, 12-Sep-94
Pick up any default extractions. CDP, 3-Jan-95
Handle default NIS extraction height in case
of no spectral lines. CDP, 22-Feb-95
Replace calls to NINT by ROUND. CDP, 17-Jun-95
Update zone names. CDP, 07-Sep-95
Handle flag windows mode (flag_state). CDP, 18-Oct-95
Fix window heights for full CCD extraction case. CDP, 2-Nov-95
Update compression scheme IDs. CDP, 2-Nov-95
Fix zone description interpretation. CDP, 27-Nov-95
Handle interface with mk_study better. CDP, 08-Aug-96
Fix bug in NIS default extraction logic. CDP, 15-Aug-96
Turn on GIS default extraction as default. CDP, 10-Mar-97
Adjust user scheme handling. CDP, 06-Oct-97
Add new LOW++ telemetry rate. CDP, 12-Dec-97
Fix edge effect bug? CDP, 14-Apr-99
Insist on real data as default. CDP, 04-May-99
Version : Version 20, 4-May-99
[Previous]
[Next]
Project : SOHO - CDS
Name : LOAD_WAVECAL()
Purpose : Loads wavecal into common block for use by pix2wave etc
Explanation : In order to save PIX2WAVE and WAVE2PIX having to access the
wavecal database on every call, they assume the coefficients
are loaded in common block CDS_WAVECAL. The coefficients are
loaded into the common block by this routine.
Use : IDL> status = load_wavecal(detector, utc, $
[gset_id=gset_id, cal_struct=cal_struct])
Inputs : detector - either 'NIS' or 'GIS' (can be abbreviated)
utc - relevant time for calibration
Opt. Inputs : cal_struct - calibration structure as kept in the QLDS and
as returned by the get_wavecal and save_wavecal
routines. If this is present, no other parameters
are needed.
Outputs : None
Opt. Outputs: None
Keywords : GSET_ID - for GIS calibration wavecals are referenced by
GSET_ID (and then by date)
ERRMSG - if defined on entry will be used to return error
messages.
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], GET_UTC, GET_WAVECAL, TAG_EXIST [1]
TAG_EXIST [2]
CALLED BY:
CF_GIS1A, CF_GIS1B, CF_GIS1C, CF_GIS2A [1], CF_GIS4A, CF_GIS4B, CF_GIS4C, GDSPSPEC
GT_BIMAGE, GT_DIMENSION, GT_LAMBDA, GT_MIMAGE, GT_VALID, GT_WLIMITS, MK_RASTER
MONO_SPEC, NDSPSPEC, PIX2WAVE, POLY_SPEC, READCDSFITS, RESTORE_WAVECAL, SHOW_SLIT6
UPDATE_DEX, WAVE2PIX, WRITE_CIF
Common : CDS_WAVECAL
Restrictions: None
Side effects: None
Category : Data analysis, wavelength calibration
Prev. Hist. : None
Written : C D Pike, RAL, 11-Mar-96
Modified :
Version : Version 1, 11-Mar-96
[Previous]
[Next]
NAME:
LOADDATA
PURPOSE:
The purpose of this function is to read a selection of standard
data sets that are found in the normal IDL distribution in the
subdirectory $IDL_DIR/examples/data. At least 17 data sets are
available in all categories of data. The user selects one of the
possible data sets with the mouse.
CATEGORY:
File I/O.
CALLING SEQUENCE:
If calling from the IDL command line:
data = LoadData()
If calling from within a widget program:
data = LoadData(Cancel=cancelled, Group_Leader=event.top)
If you know which data set you want, you can load it directly:
data = LoadData(7)
OPTIONAL INPUTS:
selection : The number of the data selection. Values start at 1,
and go up to the number of data sets available (currently 17).
KEYWORD PARAMETERS:
CANCEL : An output keyword that is 1 of the use clicked the CANCEL
button and 0 otherwise.
data = Loaddata(Cancel=cancelled)
IF cancelled THEN RETURN
GROUP_LEADER: The group leader of the widget. This keyword
is required if you wish LOADDATA to be a modal widget program.
(Which you *always* do when calling it from a widget program.)
IMAGES: Set this keyword if you only want to select 2D image
data sets. Note that the selection number does *not* change
just because fewer data sets are available in the selection
widget.
CALLS: ***
DIST, FILEPATH, HIST_EQUAL, LOADDATA_CANCEL, LOADDATA_CENTERTLB, LOADDATA_EVENT
LOADDATA_READDATA, MAKEY, MAKEZ, SMOOTH2, XMANAGER
CALLED BY:
FSC_SURFACE
COMMON BLOCKS:
None.
SIDE EFFECTS:
None.
RESTRICTIONS:
None.
EXAMPLE:
To load the world elevation data set:
image = LoadData(7)
MODIFICATION HISTORY:
Written by: David Fanning, 5 March 1999.
Added some additonal random data capability. 29 April 99. DWF
Added IMAGES keyword. 31 March 2000. DWF.
[Previous]
[Next]
NAME:
LOBT2TAI
PURPOSE:
This function converts an LOBT array into TAI
CATEGORY:
PACKETS
CALLING SEQUENCE:
Result = LOBT2TAI(Lobt)
INPUTS:
Lobt: A 2 word array containing the local on-board time
OUTPUTS:
This function returns the TAI (Temps Atomic Internationale) time
associated with the LOBT input.
CALLS: ***
OBT2TAI
PROCEDURE:
Calls OBT2TAI
MODIFICATION HISTORY:
Written by: S.E. Paswaters, 1995
@(#)lobt2tai.pro 1.1 09/22/96 LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS
Name :
LOC_FILE()
Purpose :
Get files from a set of directories.
Explanation :
Similar to the standard utility FINDFILE, but allows for a series of
directories to be searched. Also, in Unix, it takes care of pathnames
that contain the special "~" character, which FINDFILE currently does
not do.
Use :
Result = LOC_FILE(FILE,PATH=PATH,LOC=LOC,COUNT=COUNT,ALL=ALL)
Inputs :
FILE = Name of file(s) to search for. It may contain wildcard
characters.
Opt. Inputs :
None.
Outputs :
The result of the function is an array containing the names of all the
files found.
Opt. Outputs:
None.
Keywords :
PATH = Array or scalar string with names of directories to search.
LOC = Returned directory locations of found files.
COUNT = Number of found files.
ALL = If set, then search all directories. Otherwise, the
procedure stops as soon as a match is found.
Calls : ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CHKLOG [1], CHKLOG [2]
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], TEST_OPEN, break_file [4], concat_dir [4]
CALLED BY:
BATSE_CRAB_RESP, BATSE_ONTIMES, BAT_MERGE, BCS, BURST_FLARE, CHECK_FTP, CHECK_KAP
CHECK_LOCK, CHKARG, COEFDATA, COMPARE_SHUTTERS, CONT_EDGES, DISCSP_BANDS, DN_FILE
DOC_MENU, DO_QLARCHIVE, Data reader with caching, EDGES_HVSPEC, EIS_CAT [1]
EIS_CAT [2], EIS_LIST_EXPER [1], EIS_LIST_EXPER [2], EIT_COPY, EIT_GBO
EIT_QUALITY [1], EIT_QUALITY [2], FCS, FILE2FID, FILE_OR_STRING, FILE_SEARCHER [1]
FILE_SEARCHER [2], FILE_SINCE, FIND_COMPRESSED, FIND_DBFILE, FIND_FID
FIND_KAP_FILE, FITS2MAP [1], FITS2MAP [2], FITS2TIFF, FIX_IAP, FLARE_F_NAME
FLDISPLAY, FLIST, FSPLOT, FS_ARCHIVE_RW, FS_OPEN [1], FTP_SYNOP, FTP__DEFINE
F_COMPOSITE, GAP_FILE, GET_BATSE_POINTING, GET_GDFILE, GET_GZIP
GET_HXT_CAL_WIDTHS, GET_LATEST_IAP, GET_LATEST_KAP, GET_MOD, GET_NOAA, GET_PROC
GET_RECENT_EIT, GET_SLLD, GET_SOHO_ROLL, GET_SSWDB, GET_SUMER_FILES, GET_UVSP
GE_WINDOW [1], GFITS_R, GFITS_W, GIF2PICT, GOES_MEWE_TEM, GRS_EXTRACT, GRS_RESP
HAVE_FILES, HESSI_ATTENUATOR_SPECTRA, HESSI_FIGURE4_INPUTS [2]
HESSI_FLARE_SPECTRUM, HESSI_MODEL_COUNTS, HESSI_SHUTTERS, HKG_DBASE
HSI_DIAGNOSTICS, HSI_GET_LAST_FLARE_ID, HSI_LOC_FILE, HSI_MODUL_PATTERN_OPEN
HSI_QLOOK_SUMMARY_PAGE__DEFINE, HSI_RD_WEIGHT_MAP, HSI_VCFILE_TIMES, HV_FILE
HXRBS_ESC, HXT_CAL_FIX [1], HXT_CAL_FIX [2], Help_spex [1], Help_spex [2]
Hsi_contact2fits [1], Hsi_contact2fits [2], IAP2STC, IDLEDIT, IHY_READ
ITOOL_GETFILE, JSMOVIE, JSMOVIE2, LAD_DRM, LAD_PHA_EDGES, LISTBCS, LIST_FITS
LIST_PRINTER_UNIX, MAKE_GOES_RESP, MDI_COPY, MDI_GBO, MDI__DEFINE, MKLOG_LIST
MK_AGIF, MK_CDS_PLAN, MK_EIT_MAP, MK_FILE, MK_IVM_MAP, MK_LINK, MK_MER_CONT
MK_PLAN_RECOVER, MK_SOHO_TARGET, N511_VS_HVSPEC, NEW_EFFECTIVE_AREAS_CODE
NEW_FIG4_INPUTS, NUCLEAR_TABLE_LOAD, OBS__DEFINE, OCC_DBASE
PARSE_GROSSC_ATTITUDE, PLOT_ANGC [1], PLOT_ANGC [2], PLOT_HESSI_FILTERS
PLOT_RESULTS [2], QLDISPLAY, QL_PLOTTER, RAWDUMP, RD_ASCII_C, RD_GOES_SDAC, RD_UVCAT
READQUAL, READSUM, READ_GDFILE_GD, READ_HESI_DAT, READ_HESSI_DAT, REBIN_FID
REBIN_GIF, RESTORE_FLARE, RESTORE_QLOOK, RM_FILE, RM_LOCK, ROUTINE_NAME [4]
ROUTINE_NAME [7], RUN_BATSE, Radio Spectrogram FITS File reader
Radiospectrogram FITS File reader [1]
Radiospectrogram FITS File reader [2], Read_mat_xcom, SET_CDS_FITS
SHOW_SYNOP__DEFINE, SITE__DEFINE, SMART_FTP, SOHO_CAMPAIGN, SPEX_COMMONS [2]
SPEX_COMMONS [4], SPEX_DATA_GENX [1], SPEX_DATA_GENX [2], SPEX_DRM_GENX [1]
SPEX_DRM_GENX [2], SPEX_PROC [1], SPEX_PROC [2], SPEX_SUMMARY [1]
SPEX_SUMMARY [2], SPEX__DEFINE, SSW_LAST_UPDATE, SSW_PICKFILE, ST_SUMER
SUMER_FILE, SXT__DEFINE, TFTD, TIFF2GIF, TIME_F_NAME, TRACE_COPY, UPDATE_CAMPAIGN
UPDATE_KAP, UPDATE_LINE_TEMPLATES, URL_GET, VALID_GIF, VALID_JPEG, VALID_PNG, Vlth
WBDA [1], WBDA [2], WRITE_CAP, WRITE_DD, WRITE_IAP, XACK, XCDS_BOOK, XCPT
XR_RD_ABUNDANCE, XSM_PREP, XSM_VALID, ZONE_DEF_ID, ZONE_DEF_LABEL, avsig_1 [4]
batse_menu, calc_rad_loss, db_gbo, destr_bilin [1], destr_bilin [2], destretch [1]
destretch [3], destretcht, drm_correct_albedo, file__define, gextal, gzip
hesi_grid_trans, hessi_grid_trans, hessi_setup_info, hsi_as_ptlist
hsi_as_ptrddb, hsi_as_ptwrdb, hsi_as_wascii, hsi_cld_sav_init
hsi_clk_delta_read, hsi_do_catalog, hsi_filedb_read [1], hsi_filedb_read [2]
hsi_find_in_archive, hsi_gbo, hsi_imagefile2png, hsi_monthly_filename
hsi_mult_filedb_inp filedb_dir filedb_dir, hsi_obs_summ_allrates [1]
hsi_obs_summ_soc__define, hsi_one_qlook_image, hsi_plot_qlook_image
hsi_qlook__define, hsi_ras_rdeph [1], hsi_ras_rdeph [2], hsi_ras_rdhipp
hsi_rd_durevt, hsi_rd_orbevt [1], hsi_rd_orbevt [2], hsi_rd_trackfile
hsi_rdstatevectorfile, hsi_read_all_flare_list, hsi_sas, hsi_sas_rdcal [1]
hsi_spectrum__filewrite, ihy_db, linflx [1], linflx [2], plotman, pmtras_analysis
pro ratesdump, rd_sxs_pha [1], rd_sxs_pha [2], rd_week_file [2], rdbda_smm
read_hessi_4_ospex, read_xsm_4_ospex, setup_spex [1], setup_spex [2]
spex_preview [1], spex_preview [2], spex_xsm_fits2drm, strip_crt
sumer_destretch, sumer_ffdb, sxt_get_grill [1], sxt_get_grill [2], uncompress
wbs_grs_response [1], wbs_grs_response [2], weekid [2], xgif, xlinflx, xps [1]
xps [2], xr_mk_abun_file, xsm_fits2spectrum, ydb_exist [2]
Common :
None.
Restrictions:
None.
Side effects:
None.
Category :
Utilities, Operating_system.
Prev. Hist. :
Written Dec'92 (DMZ,ARC)
Written :
D. Zarro, GSFC/SDAC, December 1992.
Modified :
Version 1, William Thompson, GSFC, 23 April 1993.
Incorporated into CDS library.
Version 2, Dominic Zarro, GSFC, 1 August 1994.
Added for error checking
Version :
Version 2, 1 August 1994.
[Previous]
[Next]
Project : SOHO - CDS
Name : LOCATE_FFCAL
Purpose : Help locate the scan for FFCAL
Explanation : Widget interface to select the pointing for the FFCAL program.
A recent EIT image is displayed with the OPS scan pattern
overplotted. This should help position the FFCAL scans to
avoid active regions.
Use : IDL> LOCATE_FFCAL [, XCEN, YCEN [, OPS_L, OPS_R ]]
Inputs : None.
Opt. Inputs : None.
Outputs : None required. If no parameters are passed, then the values
are printed to the screen.
Opt. Outputs: XCEN, YCEN = Center of scan pattern in arcseconds
OPS_L, OPS_R = Center of scan pattern in OPS coordinates
Keywords : FILE = Recent EIT fits file. If not passed, then the most
recent 304 image will be used.
DATE_OBS = If passed, then will contain the start date/time of
the FFCAL observation. The coordinates from the EIT
image will be rotated to this time, and the plot of
the FFCAL scan pattern will be rotated to the
appropriate positions on the EIT image.
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors
are encountered, then a null string is returned. In
order to use this feature, ERRMSG must be defined
first, e.g.
ERRMSG = ''
LOCATE_FFCAL, XCEN, YCEN, ERRMSG=ERRMSG
IF ERRMSG NE '' THEN ...
Calls : ***
CDSLR2XY, DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], FXREAD [1], FXREAD [2]
GET_OPS_POS, GET_RECENT_EIT, GET_UTC, LOCATE_FFCAL_EVENT, LOCATE_FFCAL_PLOT
MK_EIT_MAP, PLOT_MAP, ROT_XY, SETWINDOW [1], SETWINDOW [2], SIGRANGE [1]
SIGRANGE [2], TRIM, WIDGET_MBASE, XACK, XLOADCT [1], XLOADCT [2], XLOADCT [3]
XMANAGER, XREGISTERED, delvarx [5]
CALLED BY:
MK_CDS_PLAN
Common : The common block LOCATE_FFCAL is used internally to the
program.
Restrictions: None
Side effects: None
Category : Operations
Prev. Hist. : None
Written : C D Pike, RAL,
Modified : Version 2, 09-Sep-1999, William Thompson, GSFC
Get most recent EIT 304 file.
Take slight curvature of paths into account.
Version 3, 04-Oct-1999, William Thompson, GSFC
Convert to widget program
Version 4, 29-Oct-1999, William Thompson, GSFC
Added keyword DATE_OBS
Version 5, 15-Sept-1999, Zarro (EIT/GSFC)
Added MODAL/GROUP to protect calling code
Added /KEEP to ROT_XY for speed and
WIDGET_CONTROL,/HOUR
Added checks for OPS limits
Version : Version 5.
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
LOCATION()
PURPOSE:
Return Location/Scientist
CATEGORY:
EXPLANATION:
SYNTAX:
Result = location()
EXAMPLES:
INPUTS:
header - BYTARR(92) Image Header
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 7, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
NAME:
log_health
PURPOSE:
Create the HTML page for health monitoring and logging
CALLS: ***
HTML_TEMP2OUT
CALLED BY:
mon_health [1], mon_health [2]
HISTORY:
Written Dec-96 by Sabrina Qwan
18-Dec-96 (MDM) - Various mods to have it work on mdisas
2-Jan-97 (MDM) - Changed where screen 12 is coming from
8-Jan-97 (SQ) - Reorganized taking in Rock's suggestions
8-Jan-97 (MDM) - Corrected small error in SQ mods
- Added link to screen one snap ago
- Changed to point to last4img page
23-Jan-97 (MDM) - Changed all "mdiems" to "mdiwww"
21-May-97 (MDM) - Gutted and replaced with a call to
HTML_TEMP2OUT
3-Feb-99 (CED) - Changed /mde0 to /md86.
[Previous]
[Next]
pro lxfr, img, e_min, e_max, title, comment_str_1, comment_str_2, comment_str_3, dev=plotdev
This procedure calculates the following quantities from a light transfer data set.
1. Mean Signal Level
2. Read noise
3. Shot Noise
4. % Linearity
The procedure expects the data in a (256 x 256 x N_exp), integer array.
CALLS:
CALLED BY
exp_scale min_exp max_exp [1], get_linearity sig e_min e_max, read_ltc file
[Previous]
[Next]
FUNCTION: lunule,R1,R2,d
CALLS:
[Previous]
[Next]
NAME: lux_diff.pro
PURPOSE: make an image of the scattering function
CATEGORY: Processing high level
CALLING SEQUENCE: lux_diff,ima_name,Xc,Yc,OPTION,A,B
INPUTS: ima_name Name of result
OPTIONAL INPUT PARAMETERS: Xc,Yc center's coords
OPTION function's chars
KEYWORD PARAMETERS: None
OUTPUTS: ima_name scattering funct
OPTIONAL OUTPUT PARAMETERS: None
CALLS: ***
LOADCT, stat_ima
COMMON BLOCKS: None
SIDE EFFECTS: None
RESTRICTIONS: Applications limited to 512*512 frames
PROCEDURE:
MODIFICATION HISTORY: defined by M.B 10/11/93
SCCS variables for IDL use
@(#)lux_diff.pro 1.0 10/11/93 :LAS
[Previous]
[Next]
pro lxfr, img
This procedure calculates the following quantities from a light transfer data set.
1. Mean Signal Level
2. Read noise
3. Shot Noise
4. % Linearity
The procedure expects the data in a (256 x 256 x N_exp), integer array.
CALLS:
CALLED BY
exp_scale min_exp max_exp [1], exp_scale min_exp max_exp [2]
get_linearity sig, get_linearity sig e_min e_max, ltc, read_ltc file
[Previous]
[Next]
NAME:
LZ_DISK_INIT
PURPOSE:
This procedure does some level-0 disk initial tasks:
copy definitive attitude files from cd to $NRL_LIB/lasco/data/attitude
copy definitive orbit files from cd to $NRL_LIB/lasco/data/orbit
read data files and get start dates
CATEGORY:
UTIL
CALLING SEQUENCE:
LZ_DISK_INIT
INPUTS:
None
OUTPUTS:
None
CALLS: ***
GETENV_SLASH, LZ_START_DATE [1], LZ_START_DATE [2], MISS_PCKTS
SIDE EFFECTS:
Creates various disk files
RESTRICTIONS:
None
MODIFICATION HISTORY:
Written by: RAHoward, NRL, May 1996
@(#)lz_disk_init.pro 1.2 05/14/97 LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
LZ_DISK_INIT
PURPOSE:
This procedure does some level-0 disk initial tasks:
copy definitive attitude files from cd to $NRL_LIB/lasco/data/attitude
copy definitive orbit files from cd to $NRL_LIB/lasco/data/orbit
read data files and get start dates
CATEGORY:
UTIL
CALLING SEQUENCE:
LZ_DISK_INIT
INPUTS:
None
OUTPUTS:
None
CALLS: ***
GETENV_SLASH, LZ_DISK_INIT2, LZ_START_DATE2, STR_SEP
SIDE EFFECTS:
Creates various disk files
RESTRICTIONS:
None
MODIFICATION HISTORY:
Written by: RAHoward, NRL, May 1996
961216 by N. Rich commented out miss_pckts, start_dates lines
970423 by N. Rich prompt for multiple disks for each release
970618 by N. Rich avoid long list of chmod: WARNING messages by
changing cp and chmod commands for or and at
970627 by N. Rich Include print statements for copied files
990416 by N. Rich Print multiple volume numbers
991216 by N. Rich Change hkdir to solardata
@(#)lz_disk_init.pro 1.2 11/27/96 LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
LZ_DISK_INIT3
PURPOSE:
This procedure does some level-0 disk initial tasks:
copy definitive attitude files from cd to $NRL_LIB/lasco/data/attitude
copy definitive orbit files from cd to $NRL_LIB/lasco/data/orbit
read data files and get start dates
CATEGORY:
UTIL
CALLING SEQUENCE:
LZ_DISK_INIT3
INPUTS:
None
OUTPUTS:
None
CALLS: ***
GETENV_SLASH, LZ_START_DATE3
SIDE EFFECTS:
Creates various disk files
RESTRICTIONS:
None
MODIFICATION HISTORY:
Written by: RAHoward, NRL, May 1996
961216 by N. Rich commented out miss_pckts, start_dates lines
970423 by N. Rich prompt for multiple disks for each release
970618 by N. Rich avoid long list of chmod: WARNING messages by
changing cp and chmod commands for or and at
970627 by N. Rich Include print statements for copied files
990416 by N. Rich Print multiple volume numbers
991216 by N. Rich Change hkdir to solardata
000803 by Jake Added /SH to spawn commands
000808 the Jake Changed lzcds to .lzcds
001011 the Jake Copying d01 files to $TMFILES Directory now.
011030 the Jake Changed name to lz_disk_init3 for clarification
020314 Jake attitude and orbit files not available in download
ISTP is no longer supplying CDs
lines copying this data have been REM'd
021009 Jake trying to fix carriage return kept at the end of volno
030729 Jake added NOCOPY keyword to not copy data files
03.10.08, nbr screwed up sccs, so started archive over
03.10.09, nbr Use CD numbers instead of "volume" numbers
051115 K.Battams Change /cdrom/cdrom0 to /media/cdrecorder
%H% %W% : LASCO IDL LIBRARY
[Previous]
[Next]
NAME: LZ_GETLASCODIR
PURPOSE:
Tells user which directory contains a given days worth of level zero
LASCO data for a particular camera.
CALLING SEQUENCE:
dir=lz_getlascodir(1,6,1996,'C1')
or
dir=lz_getlascodir(1,6,96,'c1')
INPUTS:
month: an integer betwen 1 (January) and 12 (December)
day: day of the month
year: either the last two digits of the year (e.g. 96) or all 4 digits
camera: a two-character string describing which camera is desired.
Acceptable choices for camera are: "c1","c2","c3", or "c4"
camera is case-insensitive
KEYWORDS:
SILENT: Supress output of all error messages except lower-level IDL
and system messages.
OUTPUTS:
A string specifiying the directory in which desired images can be found.
AUTHOR: Scott Hawley, NRL, June 27, 1996
MODIFIED: SHH 7/12/96 Generates directory names for cplex2
9/23/96 by N. Rich modified printed output
961007 by N. Rich fixed findfile call
970827 by N. Rich use LZ_IMG for directory
990126 Ed Esfandiari Fixed code for Y2K problem.
SCCS variables for IDL use
@(#)lz_getlascodir.pro 1.7 08/27/97 :NRL Solar Physics
CALLED BY
EDITFRAME, GET_SUN_CENTER [1]
[Previous]
[Next]
NAME:
LZ_START_DATE
PURPOSE:
Lists the level-0 cdrom start dates
CATEGORY:
UTIL
CALLING SEQUENCE:
LZ_START_DATE,Volno
INPUTS:
Volno: The CD_ROM volume number
OPTIONAL INPUTS:
None
KEYWORD PARAMETERS:
None
OUTPUTS:
None
OPTIONAL OUTPUTS:
None
CALLED BY:
LZ_DISK_INIT [1]
COMMON BLOCKS:
None
SIDE EFFECTS:
Writes a file of the start dates
RESTRICTIONS:
None
PROCEDURE:
EXAMPLE:
MODIFICATION HISTORY:
Written by: RA Howard, 15 Mar 1996
@(#)lz_start_date.pro 1.3 05/14/97 LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
LZ_START_DATE
PURPOSE:
Lists the level-0 cdrom start dates
CATEGORY:
UTIL
CALLING SEQUENCE:
LZ_START_DATE,Volno
INPUTS:
Volno: The CD_ROM volume number
OPTIONAL INPUTS:
None
KEYWORD PARAMETERS:
None
OUTPUTS:
None
OPTIONAL OUTPUTS:
None
CALLS: ***
LZ_START_DATE2, REVERSE, STR_SEP
CALLED BY:
LZ_DISK_INIT [1]
COMMON BLOCKS:
None
SIDE EFFECTS:
Writes a file of the start dates
RESTRICTIONS:
None
PROCEDURE:
EXAMPLE:
MODIFICATION HISTORY:
Written by: RA Howard, 15 Mar 1996
N. Rich, 10/21/96, prompts for multiple disks for each release;
prints info for each volume of 1 release on the
same page
@(#)lz_start_date.pro 1.1 10/05/96 LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
LZ_START_DATE3
PURPOSE:
Lists the level-0 cdrom start dates
CATEGORY:
UTIL
CALLING SEQUENCE:
LZ_START_DATE3,Volno
INPUTS:
Volno: The CD_ROM volume number
OPTIONAL INPUTS:
None
KEYWORD PARAMETERS:
None
OUTPUTS:
None
OPTIONAL OUTPUTS:
None
CALLS: ***
REVERSE, STR_SEP
CALLED BY:
LZ_DISK_INIT3
COMMON BLOCKS:
None
SIDE EFFECTS:
Writes a file of the start dates
RESTRICTIONS:
None
PROCEDURE:
EXAMPLE:
MODIFICATION HISTORY:
Written by: RA Howard, 15 Mar 1996
N. Rich, 10/21/96, prompts for multiple disks for each release;
prints info for each volume of 1 release on the
same page
000803 Jake Added /SH to spawn commands
000808 the Jake Changed lzcds to .lzcds
020318 Jake Changed to grep for CD-NUMBER now that making disks here
modified strtrim line
03.10.09, nbr - Use volno input; create new file each time
051115 K.Battams Change /cdrom/cdrom0 to /media/cdrecorder
@(#)lz_start_date3.pro 1.2 11/15/05 : LASCO IDL LIBRARY