[Previous]
[Next]
NAME:
ycopy
PURPOSE:
Copy archive tapes and log the results.
OPTIONAL INPUT:
CALLS: ***
ADDTIME [1], ADDTIME [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], GET_TAPD
Rd_TapDir, STR2ARR [1], STR2ARR [2], anytim2ex [1], anytim2ex [2], concat_dir [4]
file_append [1], file_append [2], get_host [1], get_host [2], get_logenv [1]
get_logenv [2], mail [1], mail [2], mtcmd [1], mtcmd [2], wrttcplog
OPTIONAL KEYWORD INPUT:
METHOD:
Creates and executes script to copy Yohkoh weekly archive tape.
RESTRICTIONS:
Master tape must be in drive 0
Copy tape must be in drive 1
MODIFICATION HISTORY:
[Previous]
[Next]
NAME:
ydb_exist
PURPOSE:
Check if the needed YDB files are on-line (like PNT, ATR, ATT, ...)
CALLING SEQUENCE:
ans = ydb_exist(index, 'PNT')
ans = ydb_exist(times, 'ATR')
ans = ydb_exist([sttim, entim], 'PNT', /range)
INPUT:
times - list of times in any of the 3 formats
prefix - The prefix of the database files to be checked
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FILE_EXIST [2], UNIQ [1], UNIQ [2]
UNIQ [3], concat_dir [4], data_type [1], data_type [2], file_exist [1]
file_exist [3], tim2orbit [1], tim2orbit [2], week_loop [1], week_loop [2]
week_loop [3]
CALLED BY:
goes_plot [1], goes_plot [2], goes_plot [3], goes_plot [4], goes_plot [5], rd_pnt
rd_week_file [2], sxt_cen [1], sxt_cen [2], weekid [2]
OPTIONAL KEYWORD INPUT:
range - If set, then "times" is a two element array which
is the start and stop time of the range needed.
OUTPUT:
ans - Boolean value. If any of the needed files exist,
then returns a 1, otherwise it returns a 0
HISTORY:
Written 18-Aug-93 by M.Morrison (taking PNT_EXIST as start)
12-Oct-93 (MDM) - Added /RANGE option
13-Oct-93 (MDM) - Added capability of checking the range based on
week/year number input
- Added /QDEBUG option
2-Mar-94 (MDM) - Added strlowcase statement
16-Mar-94 (MDM) - Modified to check to see if the DIR_SXT_xxx
environment variable exists before doing a FILE_EXIST
16-Feb-95 (RDB) - Changed file search to *.* - cause of VMS problem
[Previous]
[Next]
Name: ydb_install
Purpose: format and execute a ydb installation job
Calling Sequence:
ydb_install, starttime, stoptime ; menu select sets
ydb_install, starttime, stoptime, /default ; default sets
Inputs:
starttime Start time of interval
stoptime Stop time of interval
Keyword Inputs:
default Copy all with yes against them in configuration file
Over-ridden by list supplied in yssw_db_sets
noexecute Write FTP file, but do not execute it
ping Conduct "is alive" test on remote host using ping
History:
Circa: 1-Feb-1994 (SLF)
12-Dec-94 (RDB) Added "pubydb_config" to allow other site to
act as sources. used with "yssw_sw_host"
login_info determined by "yssw_sw_host"
2-apr-95 (SLF) - allow index times for start/stop times
5-may-1995 (SLF) - force all SFC (wide time window)
16-Nov-1999 (RDB) - Updated to use SSWDB anonymous ftp site
22-Jun-2000 (RDB) - made default sohoftp
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FILE_EXIST [2], STR2ARR [1]
STR2ARR [2], UNIQ [1], UNIQ [2], UNIQ [3], anytim2weeks [1], anytim2weeks [2]
concat_dir [4], file_append [1], file_append [2], file_exist [1], file_exist [3]
fmt_tim [1], fmt_tim [2], get_host [1], get_host [2], get_logenv [1]
get_logenv [2], get_user [1], get_user [2], is_alive [1], is_alive [2], prstr [1]
prstr [2], rd_tfile [1], rd_tfile [2], tbeep [1], tbeep [2], tbeep [3], timegrid
where_arr [1], where_arr [2], wmenu_sel [1], wmenu_sel [2]
Restrictions:
no preseravation of dates/ownership (need tar)
no disk space checking - can fill up disk quickly
no compare to existing files - (re-copies)
is alive test (ping) will not work through a firewall
[Previous]
[Next]
Name: ydb_install
Purpose: format and execute a ydb installation job
Calling Sequence:
ydb_install, starttime, stoptime ; menu select sets
ydb_install, starttime, stoptime, /default ; default sets
History:
Circa: 1-Feb-1994 (SLF)
RDB 12-Dec-94 Added "pubydb_config" to allow other site to
act as sources. used with "yssw_sw_host"
login_info determined by "yssw_sw_host"
2-apr-95 (SLF) - allow index times for start/stop times
5-may-1995 (SLF) - force all SFC (wide time window)
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FILE_EXIST [2], STR2ARR [1]
STR2ARR [2], UNIQ [1], UNIQ [2], UNIQ [3], anytim2weeks [1], anytim2weeks [2]
concat_dir [4], file_append [1], file_append [2], file_exist [1], file_exist [3]
fmt_tim [1], fmt_tim [2], get_host [1], get_host [2], get_logenv [1]
get_logenv [2], get_user [1], get_user [2], is_alive [1], is_alive [2], prstr [1]
prstr [2], rd_tfile [1], rd_tfile [2], tbeep [1], tbeep [2], tbeep [3], timegrid
where_arr [1], where_arr [2], wmenu_sel [1], wmenu_sel [2]
Restrictions: proto - no preseravation of dates/ownership (need tar)
no disk space checking - can fill up disk quickly
no compare to existing files - (re-copies)
[Previous]
[Next]
Name: ydb_pre2dir
Purpose: return local directory for input file prefixes or subdir name
Calling Sequence:
local=ydb_pre2dir(PREFIX [,/toplev] )
Calling Examples:
t=findfile(ydb_pre2dir('nar'))
cd,ydb_pre2dir('gev',/top) ; local parent directory of gev...
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], break_file [4], get_logenv [1]
get_logenv [2], strsplit, uniqo [1], uniqo [2]
CALLED BY:
rd_ydbtap
History:
15-Jun-1994 (SLF) - originally, utility for rd_ydbtap.pro
[Previous]
[Next]
Name: ydb_use
Purpose: run <disk_hog> on all uniq top level YDB (site setup dirs)
CALLS:
[Previous]
[Next]
Name:ydbtap2tap
Purpose: ydb tape to tape copy routine
Input Parameters:
d1no - drive name for source (input) - string or #
d2no - drive name for destination (output) - string or #
(note - type of d1no must=type of d2no)
Calling Examples:
ydbtap2tap, '/dev/nrmt0h','/dev/nrmt1h' ;drive0->drive1
ydbtap2tap,0,1 ;same (on ultrix)
ydbtap2tap,0,1,/nofault ;same as above except user gets no prompts
;to recheck source and destination drives
Optional Keyword Parameters:
nofault - if set, will not prompt the user with drive config for copy
log - if set, log file written to current directory
block - blocking factor
CALLS: ***
RD_YDBTAPDIR, def_tapd [1], def_tapd [2], def_tapd [3], mt
CALLED BY:
ACOPY [1]
Restrictions: unix only
HISTORY:
25-Jan-1993 (SLF) - use arctap2tap as template
31-Jan-1994 (SLF) - change for rd_ydbtapdir update
[Previous]
[Next]
Name: ydbtapsets
Purpose: find ydb tape sets (left out of the directory file)
CALLS: ***
def_tapd [1], def_tapd [2], def_tapd [3], mtcmd [1], mtcmd [2], strsplit
CALLED BY:
rd_ydbtap
Restrictions: UNIX only
History:
29-Jun-94 (SLF)
30-Jun-94 (SLF) use mtcmd.pro
[Previous]
[Next]
NAME:
ydump
PURPOSE:
Copy archive tapes and log the results.
OPTIONAL INPUT:
CALLS: ***
ADDTIME [1], ADDTIME [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], GET_TAPD
Rd_TapDir, STR2ARR [1], STR2ARR [2], anytim2ex [1], anytim2ex [2], concat_dir [4]
file_append [1], file_append [2], get_host [1], get_host [2], get_logenv [1]
get_logenv [2], mail [1], mail [2], mtcmd [1], mtcmd [2]
OPTIONAL KEYWORD INPUT:
METHOD:
Creates and executes script to copy Yohkoh weekly archive tape.
RESTRICTIONS:
Master tape must be in drive 0
Copy tape must be in drive 1
MODIFICATION HISTORY:
[Previous]
[Next]
NAME: yesno_f
PURPOSE:
To determine what the answer to a yes or no question was
will take the following:
----- YES ------- ----- NO -------
YES NO
yes no
Y N
y n
1 0
<CR>
INPUT/OUTPUT:
in - The value to be checked
Yes will return an integer 1
No will return an integer 0
HISTORY:
Written by Michael VanSteenberg Update 5/27/81
converted to a function A.McAllister 11/16/94
[Previous]
[Next]
NAME:
yline
PURPOSE
To draw a vertical line segment to the screen.
CALLING SEQUENCE
xline,x,y1,y2,color=color,narrow=narrow
INPUT
y1 - pixel to begin line
y2 - pixel to end line
x - Horizontal position of line
OPTIONAL KEYWORD INPUT
color - color of line (default color = 255)
narrow - draw line of single pixel width (default = 3 pixels wide)
HISTORY
LWA, wrote a long time ago.
LWA, 3-Dec-94, upgraded header.
LWA, 21-May_91, added linestyle keyword
[Previous]
[Next]
Name: yo_arch_size
Purpose: given a week find the sizes of the files within the
archive. Default totals and lists don't include CBAs.
Formal Parameters:
wid input weekID
filenames names of files within archive
filesizes list of file sizes within archive in bytes.
cba switch to included cda files in lists & totals
Returns:
total total size of archinve in Mb.
CALLS: ***
PREFIXCK, Rd_TapDir, ck, get_afile_size [1], get_afile_size [2], weekid [1]
weekid [2], weekid [3]
CALLED BY:
go_comp_sfr_arch, prep_week [1], prep_week [2]
History:
written by GAL, 13-Oct-95
13-Feb-96, GAL, corrected MB conversion
[Previous]
[Next]
Name: yo_file_check
Purpose: verify integrity of Yohkoh data files
Calling Sequence:
yo_file_check, filearray [,badfiles, status=status, allgood=algood, /quiet]
Input Paramters:
infiles - string or string array of filesnames to check
Output Parameters:
badfiles - names of infiles which failed one or more tests
Keyword Parameters:
status - (output) - status flags to indicate test failures ; logical OR
(0=ok,1=missing,2=too small,4=size,8=integer,16=real)
allgood - (output) - scaler boolean (1=allok, 0= 1 or more files bad)
(so caller can use: if allgood then ... else ....)
quiet - (input) - switch, if set, suppress most error messages
delete - (input) - switch, if set, delete bad files
Method:
check - file_exist? file_size=internal size?
internal integer and real value verifications
CALLS: ***
FILE_STAT [1], FILE_STAT [2], Rd_Pointer [1], Rd_Pointer [2], data_chk [1]
data_chk [2], file_list [1], file_list [2], file_stat [3], prstr [1], prstr [2]
CALLED BY:
dbase2disk, mo_patch
History:
3-Jun-1994 (SLF) - rewrite yo_file_check (by MDM) - external size checks
perform internal data integrity checks
7-Jun-1994 (SLF) - add ALLGOOD, INDIR, and DELETE keywords
[Previous]
[Next]
NAME:
yo_height
PURPOSE:
Extract the and plot the mean height of the Yohkoh spacecraft
from the orbit_ZZZZ files.
CALLING SEQUENCE:
yo_height
yo_height,output_summary_file
INPUTS:
output_summary_file = Name of an optional output summary file.
CALLS: ***
UTPLOT [1], UTPLOT [2], UTPLOT [3], UTPLOT [4], UTPLOT [5], UTPLOT [6], fmt_tim [1]
fmt_tim [2], input [1], input [2], rd_sol
MODIFICATION HISTORY:
7-jul-93, JRL, Written
23-nov-93, JRL, Added a /year to the utplot call.
[Previous]
[Next]
Name: yo_index2path
Purpose: derive pathnames from input index vector or filename vector
Input Parameters:
index - index vector (including any SSW time)
Keyword Parameters:
infiles - optional filelist (in lieu of INDEX)
make_dir - if set, create subdirectories which don't exist
parent_dir - treetop (required if /MAKE_DIR set)
concat_dirx - if set, return concated:
[parent_dir]/[subdir]/[infiles]
| | |
| | | if supplied
| |
| | YYYY[/MM][/DD] depth depends on /YEAR,/MONTH,/DAY
| if supplied
Output:
funtion returns paths or or partial paths depending on
input and keyword settings
CALLS: ***
BOX_MESSAGE, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FILE2TIME, UNIQ [1]
UNIQ [2], UNIQ [3], anytim [1], anytim [2], anytim [3], anytim [4], anytim [5]
concat_dir [4], data_chk [1], data_chk [2], get_logenv [1], get_logenv [2]
required_tags, str_replace [1], str_replace [2]
CALLED BY:
yo_xda2legacy
Side Effects:
if PARENT_DIR supplied and /MAKE_DIR set, non-existant directories
are generated (UNIX/LINUX only)
History:
2-Jun-2003 - S.L.Freeland
5-oct-2004 - S.L.Freeland - translate $SSWDB and $ydb as required
[Previous]
[Next]
Name: yo_mkos1_dbase
Purpose: make the SXT/OS1 dbase (a 'geny catalog')
Input Parameters:
NONE
Optional Keyword Parameters:
weeks - optional list of desired weeks to process (default=mission)
start_week - optional start week (default = launch week)
may be useful for restarts of mission long dbase
os1catdir - where to stick dbase - def=$SSWDB/os1_01
Output Parameters:
NONE
Output:
generates a 'read_genxcat' compatible dbase, one file per yohkoh week
CALLS: ***
BOX_MESSAGE, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DELVARX [1]
DELVARX [2], DELVARX [3], DELVARX [4], FILE_EXIST [2], RD_XDA [1], RD_XDA [2]
concat_dir [4], delvarx [5], file_exist [1], file_exist [3], file_list [1]
file_list [2], get_logenv [1], get_logenv [2], get_yo_dates [1]
get_yo_dates [2], get_yo_dates [3], last_nelem, sxt_cba2os1 [1], sxt_cba2os1 [2]
week_loop [1], week_loop [2], week_loop [3], write_genxcat
History:
29-Apr-2003 - S.L.Freeland - wrapper around rd_xda/cba2os1/write_genxcat
[Previous]
[Next]
Name: yo_sethisflags
Purpose: set flags in xda .HIS
CALLS: ***
BOX_MESSAGE, RD_XDA [1], RD_XDA [2], required_tags
History:
13-oct-2004 - S.L.Freeland - for 2nd order -> ssc6 but may be
updated/reused as required
21-may-2006 - 2^15. -> 2^15
[Previous]
[Next]
File YO_TAPE_WIDG.PRO
CALLS:
CALLED BY
MAKE_WIDG_EV [1], MAKE_WIDG_EV [2]
[Previous]
[Next]
NAME:
YO_TAPE_WIDG
PURPOSE:
Create a widget and populate it with the values passed in ARRAY
CATEGORY:
YOHKOH tape
CALLING SEQUENCE:
var = yo_tape_widg(array, [types=types, typ_index=typ_index, one=one])
CALLED BY:
GO_RDTAP
CALLS TO:
MAKE_WIDG_EV throught the XMANAGER
INPUTS:
ARRAY A string or string array of values to be used as buttons.
When the keyword TYPES is present, then these will be
the names of the buttons in the first column only.
OPTIONAL INPUTS:
TYPES A string or string array containing the values to be used
as button names in the second column of buttons.
ONE If set then only one button may be turned on at a time.
OUTPUTS:
The result returns the select indices of the array ARRAY.
OPTIONAL OUTPUTS:
TYP_INDEX Returns the selected indices of the array TYPES,
but only when the keyword TYPES is present.
CALLS: ***
MAKE_WIDG_EV [1], MAKE_WIDG_EV [2], XMANAGER
CALLED BY:
MAKE_WIDG_EV [1], MAKE_WIDG_EV [2]
COMMON BLOCKS:
COMMON EVENT, $ ; needed for the event handler
INDEX, $ ; record the status of the buttons
IST, $ ; remember the last selected button
IEN, $ ; remember the second to last
EXCLUS ; if set, simulate exclusive buttons
SIDE EFFECTS:
Widgets are created.
RESTRICTIONS:
Must have widgets available.
PROCEDURE:
Based on the key words present, construct a widget populated with
the values passed in as array. Upon return from the event handler
determine which button(s) were selected by the user and return the
indices
MODIFICATION HISTORY:
OCT 93 - Elaine Einfalt (HSTX)
[Previous]
[Next]
Name: yo_xda2legacy
Purpose: convert Yohkoh xda files or index,data pairs -> Yohkoh Legacy (FITS)
Input Parameters:
'index,data' - output from rd_xda or read_sxt (in lieu of XDAFILES input)
Keyword Parameters:
xdafiles - optionally, xda file(s) full path to xda files for conversion
outdir - output parent directory
year,month,day - optionally specify output tree style - default is DAY
which implies /<OUTDIR>/YYYY/MM/DD/ - passed to
yohkoh_index2path.pro
or_his (switch) - if set -and- spr files, try to add OR_HISTORY info
Calling Sequence:
IDL> yo_xda2legacy, xdafiles=xdafiles, outdir='/LEGACY_PARENT'
IDL> yo_xda2legacy, index, data , outdir='/LEGACY_PARENT
CALLS: ***
BOX_MESSAGE, BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1]
CONCAT_DIR [2], CONCAT_DIR [3], DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4]
FILE_EXIST [2], SXT_INDEX2FILENAME, YO_XDA2FITSHEAD, break_file [4]
concat_dir [4], curdir [1], curdir [2], data_chk [1], data_chk [2], delvarx [5]
file_exist [1], file_exist [3], get_logenv [1], get_logenv [2], mwritefits
restgenx, str_replace [1], str_replace [2], strarrcompress, update_history
yo_index2path
Restrictions:
xdafiles input slightly prefered over 'index,data' since some
heritage info may be derivable from existing xda names (_unc for examp)
History:
Circa June 2003 - S.L.Freeland yo_xda2galileo_v2.pro written
5-Oct-2004 - S.L.Freeland -> from above, yo_xda2legacy.pro
added YEAR,MONTH,DAY keywords - force tim2orbit info
in call to the FITS header generator
13-dec-2004 - S.L.Freeland - fixed error in auto-uncert detection
30-Sep-2004 LWA/AKT Added keywords prefixx and safe_log10, also in
call to sxt_index2filename.
15-dec-2005 - Aki Takeda - omitted safe_log10 keyword, in response to
the new file names without _YYYYY part.
8-may-2006 - S.L.Freeland - add spr OR_HIS extensions
20-may-2006 - AkT - OR_HIS: allow longer spr filename like spr921020_lrg.
21-may-2006 - AkT - OR_HIS(dark): use short expression ('Interp'-->'Intrp', etc.)
to avoid info truncation in the FITS header.
[Previous]
[Next]
NAME:
yod_sz
PURPOSE:
Return a list of file sizes in bytes.
CALLING SEQUENCE:
size = yod_sz( files, hdr, drecs [, d_sz=d_sz])
size is vector of file sizes of requested files.
files is the input request list of file names.
hdr contains info for week files from 'xbd'.
drecs is the contents w/sizes from 'xbd' file.
d_sz optional input, long-word file size list with
the same length as infn.
CALLS: ***
PREFIXCK, yow_sz [1], yow_sz [2]
CALLED BY:
get_afile_size [1], get_afile_size [2]
HISTORY:
written 8-Nov-91, gal
2-Mar-92, update for new prefix list.
bug update, 17-Sep-92
[Previous]
[Next]
ROUTINE:
YODAT
PURPOSE:
Read an any of the reformatted data files
INPUT:
This is a program and there are several questions asked. Sample
responses are listed below.
The first question is the input file name. Examples:
menu
many spr* ;all spr files in whole path
menu bda920224*
many /yd3/reformat/sfr*
many sfr* last ;sfr files in last dir in path
many sfr* flares ;sfr files in flares directory
many /yd*/*/hda920325*
many ./wda* ;wda files in default dir
spr* ;spr files in default dir
time
same bda
The second question is for datasets to extract. The options are listed
there in detail. Further questions are optionally asked depending on
instrument file being read and the kind of data present in it.
It is possible to extract ground based data using YODAT. If the first
character of the input file name is "g", then it is assumbed to be GBO
data of FITS format. The MANY and MENU options will work for extracting
GBO data but only if the filename portion is entered on the same line as
MENU or MANY (ie: "many gbh*" will work, but entering "many" and then
entering "gbh*" at the second question will not work). Using the many
option will only work if all images selected are the same size. Do not
select very many images at once since it the concatenation is not very
efficient.
HISTORY:
MDM Early-1991
JRL Updated 18-sep-91 to create info_array
MDM Updated 25-Sep-91 to assemble observing regions
MDM Updated 1-Oct-91 to only read BCS DP_Sync if asked to
MDM Ver 3.3 4-Oct - Allowed SEQ_NUM selection for FFI (as well as PFI)
MDM Ver 3.4 10-Oct - Changed default answer for "Assemble OR" question
to yes
- Also, removed GET_INFO asking if the data should
be written to disk
- Also added RD_QS for BCS files
MDM Ver 3.5 11-Oct - Returned GET_INFO to printing out information
MDM Ver 3.6 11-Oct - Changed case statement that calls reading routines
to only look at first letter of the file name
(instead of the whole prefix)
MDM Ver 3.7 17-Oct - For SXT, when printing out the summary of what
Sequence lines are used, print out the parameters
for the FIRST (only first) image for that sequence
- Also added option -888 to get out without reading
any file.
MDM Ver 3.8 19-Oct - Put in "stop" when "ndset"=0
- Also, if file # entered is -1, stop
MDM Ver 3.9 20-Oct - Modified how option -888 works (first read roadmap,
and have option to read DP section).
MDM Ver 4.0 21-Oct - Added the menu option for the input file.
CDP/JRL Ver 4.1 29-Oct - Set stdset_out=0 even when not used by
not used by test_rd (used by other routines).
MDM Ver 4.2 7-Nov-91 - Expanded the SXT seq_num information being printed.
MDM Ver 4.3 10-Nov-91 - New method of determining what type of file it is
is to check the "fheader.st$instrument) field.
Old method was to look at the first letter of the
file name.
MDM Ver 4.4 13-Nov-91 - Used new calling sequence for "seq_summary"
Added option to select sequence by menu
MDM Ver 4.5 20-Nov-91 - Added capability to select multiple sequences
using the sequence menu option
MDM Ver 4.6 21-Nov-91 - Added "SAME" option to select a different instrument
with the same fileid
MDM Ver 4.7 22-Nov-91 - Fixed bug with using SXT -777 option (if asked for
invalid option, it never recovered)
MDM Ver 4.8 3-Dec-91 - Changed the "normal" option of entering # of data
sets and starting dataset to check that it does no
run past the last dataset in the file.
Also deleted the "significant update" message
and removed the compiliation of all "_struct" routines
MDM Ver 5.0 12-Dec-91 - Major changes
Allowed multiple files to be selected (added "MANY" option)
Allow user to specify the time (added "TIME" option)
MDM Ver 5.1 28-Feb-92 - * Removed code that turned "SS" dataset #'s into
a structure and replaced with MK_DSET_STR.
* Print out total # of datasets
* Put "break_file" call back in (after
upgrading it to handle arrays of filenames
* Fixed but with "TIME" option for cases where
time span is short (doesn't cross file boundry)
* Adjusted "SAME" option code to work for
multiple file input.
MDM Ver 6.0 8-Mar-92 - * Added options to plot the lightcurve for
- HXT sum_l, sum_m1, sum_m2, sum_h
- WBS sxs1, sxs2, hxs
- BCS total_cnts(1,2,3,4)
* Also added option to extract flare data only
MDM Ver 6.1 10-Mar-92 - * Added "show_obs3" and "plot_fov" options for
SXT
MDM Ver 6.2 10-Mar-92 - * As per Bob Bentley suggestion, the "dset_arr"
will always be the structure equivalent. This
meant that the new options added in Ver 6.0
dataset #s are held in the variable "ssss"
MDM Ver 6.3 12-Mar-92 - * Added "stdset_out" to be defined when using
the "ss" option and any of the options using
PLOT_LCUR
MDM Ver 6.4 19-Mar-92 - * Changed the variable name of the roadmap that
is returned from the "RD_xxx" routines to be
"roadmap2" since it is only the roadmap for
the files that are read for the particular
extraction. The full roadmap of all files is
still held in "roadmap".
MDM Ver 6.5 20-Mar-92 - * Try to trap on an unrecognized command option
* Added titles to the PLOT_LCUR options
MDM Ver 6.6 24-Mar-92 - * For the TIME option, make sure that the file
names are time ordered before doing search on
start/end times
MDM Ver 6.7 24-Mar-92 - * Return DSET_STR for all calls to RD_xxx
* Ask before reading HXA scan data for ADA files
MDM Ver 6.8 25-Mar-92 - * Fixed typo in TIME option (abcde vs abcd)
MDM Ver 6.9 25-Apr-92 - * Changed the way that SXT was calling sequence
summary listing. It will not do that by default
any more, only when asked to do it.
* Added the TEST_RD_NSAMP option
MDM Ver 7.0 2-May-92 - * Adjusted TEST_RD_NSAMP option to work for
SXT PFI observing regions
* Had to add a goto statement with -774 option.
* GT_DP_MODE was updates so that now option
-333 (all flare mode extraction) works for BCS
* Modified MANY and MENU options to work if a
directory is passed with the file specification.
* Modified MANY and MENU to accept a third
parameter. If the word "LAST" is added after
the file specification, then only files in the
last non-empty directory is listed.
MDM Ver 7.1 3-May-92 - * Fixed bug in MANY and MENU option when used
without any second or third parameter
* Adjusted code to always call MK_DSET_STR
DSET_ARR is always in indicy to roadmap
DSET_STR is always the structure
MDM 2-Jun-92 - * Modified to not stop when there are no datasets
only when input file is BCS (so that it can
read the DP_SYNC)
MDM Ver 7.2 24-Jun-92 - * Modification to SXT extraction selection by
sequence table number and sequence number
(avoid problems with extraction from same file
twice)
MDM Ver 8.0 26-Jun-92 - * Expanded to allow extraction of the standard
ground based FITS files.
MDM Ver 8.1 26-Jun-92 - * Added QTEST_RD_SCALE option for GBO access
MDM Ver 8.2 29-Jul-92 - * Added capability to read HXI datafiles
MDM Ver 8.3 3-Aug-92 - * Modified GBO file access instruction information
MDM Ver 9.0 26-Oct-92 - * Renamed from TEST_RD to YODAT
MDM Ver 9.1 22-Feb-93 - * Sort the files by date when using the MANY option
(as per Kevin Kluge's suggestion)
* Added option -772 for SSWHERE
SLF Ver 9.2 7-Jul-93 - * Use rfits2 for GBO (allow compreessed data)
9-Aug-93 - * Corrected typo in SXT sequence table extraction
option
MDM 12-Oct-93 - * Updated the INDEX.SXT.SHAPE_SAV field when an
OR is assembled
MDM Ver 9.3 16-Mar-94 - * For SGI machines, which use the /CD option on
the FILE_LIST call, there was a problem when the
user specified the directory in the file name.
The directory needed to be stripped out so that
it was passed to FILE_LIST properly
* Figures out when the file is ground based
(by a leading character "g")
RDB Ver 9.4 29-Nov-97 - * Introduced bcs_path in MANY and MENU keywords
PGS 07-jan-99 - * sorted file list by time (y2k)
[Previous]
[Next]
ROUTINE:
YODAT
PURPOSE:
Read an any of the reformatted data files
INPUT:
This is a program and there are several questions asked. Sample
responses are listed below.
The first question is the input file name. Examples:
menu
many spr* ;all spr files in whole path
menu bda920224*
many /yd3/reformat/sfr*
many sfr* last ;sfr files in last dir in path
many sfr* flares ;sfr files in flares directory
many /yd*/*/hda920325*
many ./wda* ;wda files in default dir
spr* ;spr files in default dir
time
same bda
The second question is for datasets to extract. The options are listed
there in detail. Further questions are optionally asked depending on
instrument file being read and the kind of data present in it.
It is possible to extract ground based data using YODAT. If the first
character of the input file name is "g", then it is assumbed to be GBO
data of FITS format. The MANY and MENU options will work for extracting
GBO data but only if the filename portion is entered on the same line as
MENU or MANY (ie: "many gbh*" will work, but entering "many" and then
entering "gbh*" at the second question will not work). Using the many
option will only work if all images selected are the same size. Do not
select very many images at once since it the concatenation is not very
efficient.
HISTORY:
MDM Early-1991
JRL Updated 18-sep-91 to create info_array
MDM Updated 25-Sep-91 to assemble observing regions
MDM Updated 1-Oct-91 to only read BCS DP_Sync if asked to
MDM Ver 3.3 4-Oct - Allowed SEQ_NUM selection for FFI (as well as PFI)
MDM Ver 3.4 10-Oct - Changed default answer for "Assemble OR" question
to yes
- Also, removed GET_INFO asking if the data should
be written to disk
- Also added RD_QS for BCS files
MDM Ver 3.5 11-Oct - Returned GET_INFO to printing out information
MDM Ver 3.6 11-Oct - Changed case statement that calls reading routines
to only look at first letter of the file name
(instead of the whole prefix)
MDM Ver 3.7 17-Oct - For SXT, when printing out the summary of what
Sequence lines are used, print out the parameters
for the FIRST (only first) image for that sequence
- Also added option -888 to get out without reading
any file.
MDM Ver 3.8 19-Oct - Put in "stop" when "ndset"=0
- Also, if file # entered is -1, stop
MDM Ver 3.9 20-Oct - Modified how option -888 works (first read roadmap,
and have option to read DP section).
MDM Ver 4.0 21-Oct - Added the menu option for the input file.
CDP/JRL Ver 4.1 29-Oct - Set stdset_out=0 even when not used by
not used by test_rd (used by other routines).
MDM Ver 4.2 7-Nov-91 - Expanded the SXT seq_num information being printed.
MDM Ver 4.3 10-Nov-91 - New method of determining what type of file it is
is to check the "fheader.st$instrument) field.
Old method was to look at the first letter of the
file name.
MDM Ver 4.4 13-Nov-91 - Used new calling sequence for "seq_summary"
Added option to select sequence by menu
MDM Ver 4.5 20-Nov-91 - Added capability to select multiple sequences
using the sequence menu option
MDM Ver 4.6 21-Nov-91 - Added "SAME" option to select a different instrument
with the same fileid
MDM Ver 4.7 22-Nov-91 - Fixed bug with using SXT -777 option (if asked for
invalid option, it never recovered)
MDM Ver 4.8 3-Dec-91 - Changed the "normal" option of entering # of data
sets and starting dataset to check that it does no
run past the last dataset in the file.
Also deleted the "significant update" message
and removed the compiliation of all "_struct" routines
MDM Ver 5.0 12-Dec-91 - Major changes
Allowed multiple files to be selected (added "MANY" option)
Allow user to specify the time (added "TIME" option)
MDM Ver 5.1 28-Feb-92 - * Removed code that turned "SS" dataset #'s into
a structure and replaced with MK_DSET_STR.
* Print out total # of datasets
* Put "break_file" call back in (after
upgrading it to handle arrays of filenames
* Fixed but with "TIME" option for cases where
time span is short (doesn't cross file boundry)
* Adjusted "SAME" option code to work for
multiple file input.
MDM Ver 6.0 8-Mar-92 - * Added options to plot the lightcurve for
- HXT sum_l, sum_m1, sum_m2, sum_h
- WBS sxs1, sxs2, hxs
- BCS total_cnts(1,2,3,4)
* Also added option to extract flare data only
MDM Ver 6.1 10-Mar-92 - * Added "show_obs3" and "plot_fov" options for
SXT
MDM Ver 6.2 10-Mar-92 - * As per Bob Bentley suggestion, the "dset_arr"
will always be the structure equivalent. This
meant that the new options added in Ver 6.0
dataset #s are held in the variable "ssss"
MDM Ver 6.3 12-Mar-92 - * Added "stdset_out" to be defined when using
the "ss" option and any of the options using
PLOT_LCUR
MDM Ver 6.4 19-Mar-92 - * Changed the variable name of the roadmap that
is returned from the "RD_xxx" routines to be
"roadmap2" since it is only the roadmap for
the files that are read for the particular
extraction. The full roadmap of all files is
still held in "roadmap".
MDM Ver 6.5 20-Mar-92 - * Try to trap on an unrecognized command option
* Added titles to the PLOT_LCUR options
MDM Ver 6.6 24-Mar-92 - * For the TIME option, make sure that the file
names are time ordered before doing search on
start/end times
MDM Ver 6.7 24-Mar-92 - * Return DSET_STR for all calls to RD_xxx
* Ask before reading HXA scan data for ADA files
MDM Ver 6.8 25-Mar-92 - * Fixed typo in TIME option (abcde vs abcd)
MDM Ver 6.9 25-Apr-92 - * Changed the way that SXT was calling sequence
summary listing. It will not do that by default
any more, only when asked to do it.
* Added the TEST_RD_NSAMP option
MDM Ver 7.0 2-May-92 - * Adjusted TEST_RD_NSAMP option to work for
SXT PFI observing regions
* Had to add a goto statement with -774 option.
* GT_DP_MODE was updates so that now option
-333 (all flare mode extraction) works for BCS
* Modified MANY and MENU options to work if a
directory is passed with the file specification.
* Modified MANY and MENU to accept a third
parameter. If the word "LAST" is added after
the file specification, then only files in the
last non-empty directory is listed.
MDM Ver 7.1 3-May-92 - * Fixed bug in MANY and MENU option when used
without any second or third parameter
* Adjusted code to always call MK_DSET_STR
DSET_ARR is always in indicy to roadmap
DSET_STR is always the structure
MDM 2-Jun-92 - * Modified to not stop when there are no datasets
only when input file is BCS (so that it can
read the DP_SYNC)
MDM Ver 7.2 24-Jun-92 - * Modification to SXT extraction selection by
sequence table number and sequence number
(avoid problems with extraction from same file
twice)
MDM Ver 8.0 26-Jun-92 - * Expanded to allow extraction of the standard
ground based FITS files.
MDM Ver 8.1 26-Jun-92 - * Added QTEST_RD_SCALE option for GBO access
MDM Ver 8.2 29-Jul-92 - * Added capability to read HXI datafiles
MDM Ver 8.3 3-Aug-92 - * Modified GBO file access instruction information
MDM Ver 9.0 26-Oct-92 - * Renamed from TEST_RD to YODAT
MDM Ver 9.1 22-Feb-93 - * Sort the files by date when using the MANY option
(as per Kevin Kluge's suggestion)
* Added option -772 for SSWHERE
SLF Ver 9.2 7-Jul-93 - * Use rfits2 for GBO (allow compreessed data)
9-Aug-93 - * Corrected typo in SXT sequence table extraction
option
MDM 12-Oct-93 - * Updated the INDEX.SXT.SHAPE_SAV field when an
OR is assembled
MDM Ver 9.3 16-Mar-94 - * For SGI machines, which use the /CD option on
the FILE_LIST call, there was a problem when the
user specified the directory in the file name.
The directory needed to be stripped out so that
it was passed to FILE_LIST properly
* Figures out when the file is ground based
(by a leading character "g")
[Previous]
[Next]
NAME:
yodat_delvar
PURPOSE:
To delete a large set of the variables created by YODAT.
SAMPLE CALLING SEQUENCE:
@yodat_delvar
RESTRICTIONS:
CAUTION: Be careful if this is executed -- it could delete
some variables that you wanted
HISTORY:
Written 31-Jan-95 by M.Morrison
[Previous]
[Next]
NAME: yodoc
purpose: display doc for yolist program.
CALLED BY
yolist
[Previous]
[Next]
NAME:
yoh_ieee2vax
PURPOSE:
To convert Unix IDL floating/double to VAX IDL data types.
CALLING SEQUENCE:
yoh_ieee2vax, a
PARAMETERS:
a - The data variable to be converted. This may be a scalar
or an array.
CALLS: ***
dec2sun [1], dec2sun [2], ieee2vax [1], ieee2vax [2]
CALLED BY:
RFITS [1], RFITS [2], RFITS [3], rdwrt [1], rdwrt [2], rdwrt [3]
RESTRICTIONS:
Only tested for data from IEEE standard Unix machines (e.g. SUN)
*** Double precision does not work ***
MODIFICATION HISTORY:
Written 13-Apr-93 by M.Morrison
6-May-93 (MDM) - Fixed a typo
[Previous]
[Next]
Name: yoh_orb_interp
Purpose: read and interpolate Yohkoh orb dbase for each input time
Input Parameters:
index - desired time(s) - any ssw including yohkoh index or roadmap)
Calling Sequence:
intorb=yoh_orb_interp(times)
intorb=yoh_orb_interp(index)
Output Parameters:
function returns Yohkoh orbit records interpolated to input times
IDL> help,yoh_orb_interp('1-mar-1998 12:35'),/str
** Structure OIDX, 10 tags, length=36, data length=32:
TIME LONG 45300000 < time of input (interp time)
DAY INT 7000 < time of input (interp time)
LAT FLOAT -7.34000 < interpolated
LONG FLOAT 255.170 < ""
HEIGHT FLOAT 590.200 < ""
RADIUS FLOAT 6968.10 < ""
RIG FLOAT 11.8000 < ""
SC_DAY BYTE 0
SAA BYTE 0
SPARE BYTE Array[4]
CALLS: ***
BOX_MESSAGE, INTERPOL, STR2ARR [1], STR2ARR [2], anytim [1], anytim [2], anytim [3]
anytim [4], anytim [5], data_chk [1], data_chk [2], gt_tagval [1], gt_tagval [2]
rd_orb, tag_index [1], tag_index [2], time_window
History:
Circa 18-July-2001 - S.L.Freeland
25-jul-2002 - S.L.Freeland - add documentation & rigidity
[Previous]
[Next]
Name: yoh_orb_interp
Purpose: read and interpolate Yohkoh orb dbase for each input time
Input Parameters:
index - desired time(s) - any ssw including yohkoh index or roadmap)
Calling Sequence:
intorb=yoh_orb_interp(times)
intorb=yoh_orb_interp(index)
Output Parameters:
function returns Yohkoh orbit records interpolated to input times
IDL> help,yoh_orb_interp('1-mar-1998 12:35'),/str
** Structure OIDX, 10 tags, length=36, data length=32:
TIME LONG 45300000 < time of input (interp time)
DAY INT 7000 < time of input (interp time)
LAT FLOAT -7.34000 < interpolated
LONG FLOAT 255.170 < ""
HEIGHT FLOAT 590.200 < ""
RADIUS FLOAT 6968.10 < ""
RIG FLOAT 11.8000 < ""
SC_DAY BYTE 0
SAA BYTE 0
SPARE BYTE Array[4]
CALLS: ***
BOX_MESSAGE, INTERPOL, STR2ARR [1], STR2ARR [2], anytim [1], anytim [2], anytim [3]
anytim [4], anytim [5], data_chk [1], data_chk [2], gt_tagval [1], gt_tagval [2]
rd_orb, tag_index [1], tag_index [2], time_window
History:
Circa 18-July-2001 - S.L.Freeland
25-jul-2002 - S.L.Freeland - add documentation & rigidity
[Previous]
[Next]
NAME:
YOH_SVDFIT
PURPOSE:
Perform a general least squares fit with optional error estimates.
NOTE!! - this is an old version for specific use by yohkoh/legacy
library - Suggest you use the current and released
version of 'svdfit.pro' (available via ASTRON+SSW)
This version uses the Numerical Recipies (2nd Edition) function
SVDFIT. A user-supplied function or a built-in polynomial or
legendre polynomial is fit to the data.
CATEGORY:
Curve fitting.
CALLING SEQUENCE:
Result = SVDFIT(X, Y, [M])
INPUTS:
X: A vector representing the independent variable.
Y: Dependent variable vector. This vector must be same length
as X.
OPTIONAL INPUTS:
M: The number of coefficients in the fitting function. For
polynomials, M is equal to the degree of the polynomial + 1.
If not specified and the keyword A is set, then
M = N_ELEMENTS(A).
INPUT KEYWORDS:
A: The inital estimates of the desired coefficients. If M
is specified, then A must be a vector of M elements.
If A is specified, then the input M can be omitted and
M=N_ELEMENTS(A). If not specified, the initial value
of each coefficient is taken to be 1.0. If both M and A are
specified, them must agree as to the number of paramaters.
DOUBLE: Set this keyword to force double precision computations. This
is helpful in reducing roundoff errors and improves the chances
of function convergence.
WEIGHTS: A vector of weights for Y[i]. This vector must be the same
length as X and Y. If this parameter is ommitted, 1's
(No weighting) are assumed.
The error for each term is weighted by Weight[i] when computing the
fit. Gaussian or instrumental uncertianties should be weighted as
Weight = 1/Sigma where Sigma is the measurement error or standard
deviations of Y. For Poisson or statistical weighting use
Weight=1/sqrt(Y), since Sigma=sqrt(Y).
FUNCTION_NAME:
A string that contains the name of an optional user-supplied
basis function with M coefficients. If omitted, polynomials
are used.
The function is called: R=SVDFUNCT(X,M)
where X and M are scalar values, and the function value is an
M element vector evaluated at X with the M basis functions.
M is the degree of the polynomial +1 if the basis functions are
polynomials. For example, see the function SVDFUNCT or SVDLEG,
in the IDL User Library:
For more examples, see Numerical Recipes in C, second Edition,
page 676-681.
The basis function for polynomials, is R[j] = x)^j.
The function must be able to return R as a FLOAT vector or
a DOUBLE vector depending on the input type of X.
LEGENDRE: Set this keyword to use the IDL function SVDLEG in the lib
directory to fit the data to an M element legendre polynomial.
This keyword overrides the FUNCTION_NAME keyword.
OUTPUTS:
SVDFIT returns a vector of the M coefficients fitted to the
supplied function.
OPTIONAL OUTPUT PARAMETERS:
CHISQ: Sum of squared errors multiplied by weights if weights
are specified.
COVAR: Covariance matrix of the coefficients.
VARIANCE: Sigma squared in estimate of each coeff(M).
That is sqrt(VARIANCE) equals the 1 sigma deviations
of the returned coefficients.
SIGMA: The 1-sigma error estimates of the returned parameters,
SIGMA=SQRT(VARIANCE).
SINGULAR: The number of singular values returned. This value should
be 0. If not, the basis functions do not accurately
characterize the data.
YFIT: Vector of calculated Y's.
CALLED BY:
GETCAL_ATT [1], GETCAL_ATT [2]
COMMON BLOCKS:
None.
SIDE EFFECTS:
None.
MODIFICATION HISTORY:
Adapted from SVDFIT, from the book Numerical Recipes, Press,
et. al., Page 518.
minor error corrected April, 1992 (J.Murthy)
Completely rewritten to use the actual Numerical Recipes routines
of the 2nd Edition (V.2.06). Added the DOUBLE, SIGMA, A, and
LEGENDRE keywords. Also changed Weight to Weights to match the
other fitting routines.
EXAMPLE:
[Previous]
[Next]
NAME:
yoh_vax2ieee
PURPOSE:
To convert Unix IDL floating/double to VAX IDL data types.
CALLING SEQUENCE:
yoh_vax2ieee, a
PARAMETERS:
a - The data variable to be converted. This may be a scalar
or an array.
CALLS: ***
dec2sun [1], dec2sun [2], vax2ieee [1], vax2ieee [2]
CALLED BY:
rd_gbe_raw, rdwrt [1], rdwrt [2], rdwrt [3]
RESTRICTIONS:
Only tested for data from IEEE standard Unix machines (e.g. SUN)
*** Double precision does not work ***
MODIFICATION HISTORY:
Written 13-Apr-93 by M.Morrison
8-Jun-93 (MDM) - Corrected an error. The calls to DEC2SUN and
IEEE2VAX were reversed
[Previous]
[Next]
NAME:
YOHKOH_EVENTS
PURPOSE:
Returns the orbital events NIGHT, DAY, Enter SAA, and Exit SAA for
the requested day interval.
CALLING SEQUENCE:
YOHKOH_EVENTS,DAYS,ONIT,ODAY,ESAA,XSAA [,/HOURS]
INPUT:
DAYS - Days span (in days since 1/1/79) for which event data
is required
OPTIONAL INPUT:
/HOURS - Requests that the output arrays be in hours since start
of the first requested day.
OUTPUT:
ONIT - Structure (.DAY,.TIME) containing entries into orbit night
ODAY - Structure (.DAY,.TIME) containing entries into orbit day
ESAA - Structure (.DAY,.TIME) containing entries into the SAA
XSAA - Structure (.DAY,.TIME) containing exits from the SAA
CALLED BY:
BCS_24HR_PLOT [1], BCS_24HR_PLOT [3]
Note:
If /HOURS switch is used, the above variables are one-dimensional float
arrays of the hours since the start of the first day in input DAYS
CALLS: ***
CHECK_TIME, Int2Ex [1], Int2Ex [2], fmt_tim [1], fmt_tim [2], rd_fem
COMMON:
DNS_COMMON Holds orbit events extracted from file for repeated
calls. New file is sought if required days are not already
held in these arrays.
HISTORY
Written: R.D.Bentley, October 1991.
12-Jun-92 RDB Changed to use FEM files
22-Jun-92 RDB Read end of previous day and start of next.
Tidying of array extraction.
[Previous]
[Next]
Name: yohkoh_files
Purpose: return yohkoh file names between time0 and time0
Input Parameters:
time0 - start time or vector of times to match
time1 - stop time of range
Keywords:
/bcs or /bda - BCS files
/hxt or /hda - HXT files
/sxt or /sfr or /spr - SXT files (/sxt is the same as /sfr)
/wbs or /wda - WBS files
CALLS: ***
BOX_MESSAGE, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], anytim [1]
anytim [2], anytim [3], anytim [4], anytim [5], anytim2weekinfo, concat_dir [4]
file_list [1], file_list [2], get_logenv [1], get_logenv [2], reltime [1]
reltime [2], sel_filetimes [1], sel_filetimes [2], timegrid
History:
2-Nov-1999 - R.D.Bentley - modelled on sxt_files...
[Previous]
[Next]
Name: yohkoh_legacy_files
Purpose: return Yohkoh Legacy filenames for user input times
Input Parameters:
time0 - time or start of time range
time1 - optional end time if range
Output:
function returns list of files (paths if local else URLs)
Keyword Parameters:
ssc - if set, default to SSC files
count - number of files/urls returned
force_url - if set, return URLs even if data is 'local'
(only required at Legacy host sites + URLS desired)
CALLS: ***
BOX_MESSAGE, FILE2TIME, FILE_EXIST [2], SOCK_LIST, STR_LASTPOS [1], anytim [1]
anytim [2], anytim [3], anytim [4], anytim [5], data_chk [1], data_chk [2]
file_exist [1], file_exist [3], get_logenv [1], get_logenv [2], sel_timrange [1]
sel_timrange [2], str_lastpos [2], strarrcompress, strextract, tim2dset [1]
tim2dset [2], timegrid
History:
14-Feb-2005 - S.L.Freeland - hook new SSC-FITS->CoSEC/SSW
16-nov-2006 - S.L.Freeland - html parse case independent
[Previous]
[Next]
NAME:
YOHKOH_TERM_PREDICT
PURPOSE:
find D/N transitions at some remote future time based on
current orbit parameters. Basically a RUN_DSNFIL driver
CATEGORY:
yohkoh
CALLING SEQUENCE:
yohkoh_term_predict, t_input, terms
yohkoh_term_predict, t_input, terms, orbit_file = orbit_file
INPUTS:
OPTIONAL (KEYWORD) INPUT PARAMETERS:
orbit file ID (from $DIR_GEN_ORBIT_SOL/orbit)
OUTPUTS:
list of terminator times (strarr(2,n_term))
CALLS: ***
AOS2EX, EX2AOS, anytim [1], anytim [2], anytim [3], anytim [4], anytim [5]
fmt_tim [1], fmt_tim [2], rd_tfile [1], rd_tfile [2], run_dsnfil
COMMON BLOCKS:
SIDE EFFECTS:
temporarily writes (then in principle deletes) an ASCII file
from your current directory
RESTRICTIONS:
MODIFICATION HISTORY:
16-Apr-99, wrtten based on orbit_dn (HSH)
[Previous]
[Next]
NAME:
yolist
Purpose:
Convert requested fields of a data-vector to String-type
for list directed output.
CALLING SEQUENCE:
ret = yolist(idx, strFilter, header, [/conv])
INPUT PARAMETERS:
idx Structured Data-vector
strFilter The Names of fields of the data-
vector the user wishes
to convert to String-type. Example:
strFilter = ['day','time','periph']
conv flag, when set code returns converted values
(e.g. effective exposure instead of mail-
box value).
RETURNED:
strIdx a list of formatted strings containning the
items in 'strFilter'.
OPTIONAL:
header a string header for the listing.
CALLS: ***
GETSTRSHPCMD, GetStrDPmode, GetStrDat, GetStrExpLev, GetStrFOVcen, GetStrImgPar
GetStrObsReg, GetStrPeriph, GetStrTim, Int2Ex [1], Int2Ex [2], fndfld, gt_dpe
gt_expmode, gt_filta, gt_filtb, gt_fov_center, gt_mbe [1], gt_mbe [2], gt_pfi_ffi
gt_res, gt_shape_cmd, yodoc
History:
written Mar '91 by GAL
updated 27-Mar-91
updated 1-Apr-91 for input list > 128 in length.
updated 12-June-91 for minor problem with IDX index
when "nrem" was 0.
updated 17-June - reform statement removed; SLF
updated 1-Aug-91 extended the number of list parameters and
added header parameters to all list parameters.
updated 6-Aug-91 - added ObsRegion parameter
updated 12-Aug-91 - PFI_FWI changed to PFI_FFI and many
low-level routines updated to use keywords.
updated 16-Sep-91 - change FWI to FFI in SXT Structure fields
updated 25-Sep-91 - added conversion parameter (conv) to
formal parameter list.
some changes 16-Jan-92
[Previous]
[Next]
Name: yopos
Purpose: overlay Yohkoh orbital information on map of the earth
Optional input parameter:
timein = Any Yohkoh time format, time in UT. Default = now.
Optional output parameters:
latitude, longitude = latitude, longitude of terminator, degrees.
Optional Input Keywords:
p0long = central longitude. Default = 139. (ISAS)
replot = repeat interval, minutes. If set, waits and
repeats the plot. Uses current time, ignores TIMEIN.
zbuffer - (switch) if set, write to Z-buffer, not X window
giffile - name of optional gif file output (implies z-buffer)
plotnight - if set, plot the nighttime side (*broken!*)
Routines called:
MAP_SET, YO_LOGO, RD_WEEK_FILE, GET_SUN
ANYTIM2INTS, FILEPATH, MAP_IMAGE
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DELVARX [1], DELVARX [2]
DELVARX [3], DELVARX [4], FILE_EXIST [2], GET_NBYTES, GET_SUN [1], GET_SUN [2]
LOADCT, MAP_CONTINENTS, MAP_GRID, MAP_IMAGE, MAP_SET, SINCE_VERSION [1]
SINCE_VERSION [2], TEK_COLOR, WDEF [1], WDEF [2], WRITE_GIF, YO_LOGO
anytim2ints [1], anytim2ints [2], concat_dir [4], data_chk [1], data_chk [2]
delvarx [5], file_exist [1], file_exist [3], fmt_tim [1], fmt_tim [2], map_patch
rd_week_file [1], rd_week_file [2], rd_week_file [3], rd_week_file [4], timegrid
ut_time [1], ut_time [2]
Restrictions:
IF THE REPEAT OPTION IS USED, THE ROUTINE NEVER RETURNS.
Written May 5, 1993 Barry LaBonte
Modified to plot Yohkoh orbit May 31, 1993 BJL
Modified to reuse window, replot, clean code June 2, 1993 BJL
More accurate SAA, spacecraft and Sun ephemeris June 15, 1994 BJL
Add KSC contact boundary June 24, 1994 BJL
Account for orbital inclination in SC longitude July 4, 1994 BJL
Better background map image July 5, 1994 BJL
Use FILEPATH July 24, 1994 BJL
Bug fix August 1, 1994 BJL
10-july-1995 (SLF/JM) www changes, allow gif & zbuffer
12-july-1995 (SLF) - time wrap around fix
24-jul-1995 (SLF) - incorporate BJ Labonte V4. modifications
22-Mar-2000 (BNH) - incorporate ZBUFF2FILE.PRO
- Make MAP_PATCH work again. Colors didn't
display right.
- Day/Night is broken. Try playing with
different values of p0long. (Which also
demonstrates a bug in the COMMON logic.)
Add a "plotnight" flag to skirt around this.
[Previous]
[Next]
Name: yopos
Purpose: overlay Yohkoh orbital information on map of the earth
Optional input parameter:
timein = Any Yohkoh time format, time in UT. Default = now.
Optional output parameters:
latitude, longitude = latitude, longitude of terminator, degrees.
Optional Input Keywords:
p0long = central longitude. Default = 139. (ISAS)
replot = repeat interval, minutes. If set, waits and
repeats the plot. Uses current time, ignores TIMEIN.
zbuffer - (switch) if set, write to Z-buffer, not X window
giffile - name of optional gif file output (implies z-buffer)
Routines called:
MAP_SET, YO_LOGO, RD_WEEK_FILE, GET_SUN
ANYTIM2INTS, FILEPATH, MAP_IMAGE
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DELVARX [1], DELVARX [2]
DELVARX [3], DELVARX [4], FILE_EXIST [2], GET_NBYTES, GET_SUN [1], GET_SUN [2]
LOADCT, MAP_CONTINENTS, MAP_GRID, MAP_IMAGE, MAP_SET, SINCE_VERSION [1]
SINCE_VERSION [2], TEK_COLOR, WDEF [1], WDEF [2], WRITE_GIF, YO_LOGO
anytim2ints [1], anytim2ints [2], concat_dir [4], data_chk [1], data_chk [2]
delvarx [5], file_exist [1], file_exist [3], fmt_tim [1], fmt_tim [2], map_patch
rd_week_file [1], rd_week_file [2], rd_week_file [3], rd_week_file [4], timegrid
ut_time [1], ut_time [2]
Restrictions:
IF THE REPEAT OPTION IS USED, THE ROUTINE NEVER RETURNS.
Written May 5, 1993 Barry LaBonte
Modified to plot Yohkoh orbit May 31, 1993 BJL
Modified to reuse window, replot, clean code June 2, 1993 BJL
More accurate SAA, spacecraft and Sun ephemeris June 15, 1994 BJL
Add KSC contact boundary June 24, 1994 BJL
Account for orbital inclination in SC longitude July 4, 1994 BJL
Better background map image July 5, 1994 BJL
Use FILEPATH July 24, 1994 BJL
Bug fix August 1, 1994 BJL
10-july-1995 - (SLF/JM) - www changes, allow gif & zbuffer
12-july-1995 - (SLF - time wrap around fix
24-jul-1995 - (SLF) incorporate BJ Labonte V4. modifications
[Previous]
[Next]
NAME:
yow_sz
PURPOSE:
Return the sizes of weekly files.
CALLING SEQUENCE:
week_sz = yow_sz(infn, drecs [, d_sz=d_sz])
week_sz vector of weekly file sizes
infn input vector of file names.
hdr header info from xbd file.
drecs structure of fileid and sizes from xbd.
[d_sz input, long word file size list for
infn from yod_sz.
CALLS: ***
STR2ARR [1], STR2ARR [2]
CALLED BY:
yod_sz [1], yod_sz [2]
HISTORY:
written 4-Sep-92, gal
[Previous]
[Next]
NAME:
yoyo_man2
PURPOSE:
To allow the SXT toban to (1) call SRSJCL, (2) call SRSGET,
(3) reformat the data, (4) append to the observing log,
(5) to make the event log, (5) to append to the PNT file, and
(6) make SFD files.
CALLING SEQUENCE:
go_toban
go_toban, /interactive
go_toban, /nosrsjcl
go_toban, /nosrsjcl, /nosrsget
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], Rd_fHeader [1], Rd_fHeader [2]
Rd_fHeader [3], anytim2ints [1], anytim2ints [2], break_file [4], fid2ex [1]
fid2ex [2], file_list [1], file_list [2], fmt_tim [1], fmt_tim [2], get_sirius [1]
get_sirius [2], int2secarr [1], int2secarr [2], mk_evn [1], mk_evn [2], mk_obs
mk_pnt, mk_sfd [1], mk_sfd [2], mk_sfd [3], mk_sfd [4], reformat [1], reformat [2]
reformat [3], str_replace [1], str_replace [2], tbeep [1], tbeep [2], tbeep [3]
tim2orbit [1], tim2orbit [2], yesnox [1], yesnox [2]
OPTIONAL KEYWORD INPUT:
interactive - If set, ask the user which of the "stages" to run
nosrsjcl - If set, do not run the SRSJCL stage
nosrsget - If set, do not run the SRSGET stage
noreformat - If set, do not run the REFORMAT stage
noobs - If set, do not run the OBS stage
noevn - If set, do not run the EVN stage
nopnt - If set, do not run the PNT stage
nosfd - If set, do not run the SFD stage
HISTORY:
Written 14-Oct-92 by M.Morrison using GO_GET_SIRIUS as a start.
15-Oct-92 (MDM) - Added MK_PNT "stage"
16-Oct-92 (MDM) - Made variable "wid" into a scalar since it
caused problems to MK_EVN
20-Oct-92 (MDM) - Added MK_SFD "stage"
21-Oct-92 (MDM) - Added jump capbility to only run MK_SFD (goto statement)
21-Oct-92 (SLF) - Added spawning of srsjcl on flare1
(shuto san program to create sirius Temp data)
added informational messages for each stage
23-Oct-93 (MDM) - Added jump capability to only build the INFIL array
- Added /USEFID to MK_OBS call
26-Oct-92 (MDM) - Changed from a program to a procedure
[Previous]
[Next]
Name: ys_contrib
Purpose:
Handle user contribution area
Keyword Parameters:
file - input file to handle
get - if set, mail requested software
CALLS: ***
ARR2STR [1], Arr2Str [2], FILE_EXIST [2], MESASGE, PATH_LIB [1], PATH_LIB [2]
STR2ARR [1], STR2ARR [2], file_exist [1], file_exist [3], mail [1], mail [2]
rd_tfile [1], rd_tfile [2], str_replace [1], str_replace [2]
History:
17-Feb-94 (SLF) Written
[Previous]
[Next]
Name: ys_file_check
Purpose: verify integrity of Yohkoh data files
Calling Sequence:
ys_file_check, filearray [,badfiles, status=status, allgood=algood, /quiet]
Input Paramters:
infiles - string or string array of filesnames to check
Output Parameters:
badfiles - names of infiles which failed one or more tests
Keyword Parameters:
status - (output) - status flags to indicate test failures ; logical OR
(0=ok,1=missing,2=too small,4=size,8=integer,16=real)
allgood - (output) - scaler boolean (1=allok, 0= 1 or more files bad)
(so caller can use: if allgood then ... else ....)
quiet - (input) - switch, if set, suppress most error messages
delete - (input) - switch, if set, delete bad files
Method:
check - file_exist? file_size=internal size?
internal integer and real value verifications
CALLS: ***
FILE_STAT [1], FILE_STAT [2], Rd_Pointer [1], Rd_Pointer [2], data_chk [1]
data_chk [2], file_list [1], file_list [2], file_stat [3], prstr [1], prstr [2]
CALLED BY:
cp_fns [1], cp_fns [2]
History:
3-Jun-1994 (SLF) - extend yo_file_check (by MDM) - unix/vms / data tests
7-Jun-1994 (SLF) - add ALLGOOD, INDIR, and DELETE keywords