[Previous]
[Next]
NAME:
udate2ex
PURPOSE:
Converts time string from UNIX command "date"
to the 7-element time representation
INPUT:
timestr - string with date in GMT (UT) format
"Wed Jun 2 09:48:24 GMT 1993"
CALLED BY:
ut_time [1], ut_time [2]
OPTIONAL KEYWORD INPUT:
cmd - The Unix date command to spawn (examples: date,
date -u, ...)
OUTPUT:
returns 7-element integer array (hh, mm, ss, msec, dd, mm, yy)
History:
Written June 2, 1993 Barry LaBonte
Renamed from GTM2EX to UDATE2EX
[Previous]
[Next]
Project : SOHO - CDS
Name : UITDBLIB
Purpose : Add the system variables used by the UIT database library
Explanation : This routine adds the non-standard system variables used by the
UIT database routines from the IDL Astronomy User's Library.
The non-standard system variables !PRIV, !DEBUG, !TEXTUNIT, and
!TEXTOUT are added using DEFSYSV.
Use : UITDBLIB
Inputs : None.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
ADD_PSYS, ssw_setup_windows
Common : None.
Restrictions: This routine should be called only once, preferably in the
startup procedure.
Side effects: System variables may be changed to their default values.
Category : Utilities, Database
Prev. Hist. : This routine was adapted from ASTROLIB, which had the following
history entries:
Written, Wayne Landsman, July 1986.
Use DEFSYSV instead of ADDSYSVAR December 1990
Written : William Thompson, GSFC, 30 March 1994
Modified : Version 1, William Thompson, GSFC, 30 March 1994
Version : Version 1, 30 March 1994
[Previous]
[Next]
Project : SOHO - LASCO/EIT
Name : UNDEFINE
Purpose :
Category : Utilities, Array
Explanation :
Syntax : undefine, a
CALLED BY:
CHANDLE, DMEMORY, DMOVIE [1], DMOVIE [2], MK_IMAGE, WLISTER, WLOAD, WLOADC, WSAVE_PS [2]
Examples :
Inputs :
Opt. Inputs :
Outputs :
Opt. Outputs :
Keywords :
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3]
Common :
Restrictions : None.
Side effects : None.
History : 12 jun 1993,Alo Eple, MPAe,Written
Contact :
[Previous]
[Next]
NAME:
UNIQ
PURPOSE:
The uniq command scans the input array comparing adjacent
elements. The second and succeeding copies of repeated values are
removed. The result is an array of indicies into the original
array which don't include the duplicates. Note that repeated
elements must be adjacent in order to be found. This routine is
intended to be used with the SORT command (See the discussion
of the IDX argument below).
This command is inspired by the Unix uniq(1) command.
CATEGORY:
Array manipulation.
CALLING SEQUENCE:
UNIQ(array [, IDX])
INPUTS:
ARRAY: The array to be sorted. The type and number of dimensions
in the array is not important.
IDX: This optional array is an array of indices into ARRAY.
The expression:
ARRAY(IDX)
yields an array in which the elements of ARRAY are
rearranged by IDX. To understand the reason for this
argument, consider the fact that SORT returns an array
of indices, and that the expression:
ARRAY(SORT(ARRAY))
yields a sorted version of the original array. This
argument is intended to allow combining SORT and UNIQ
efficiently:
ARRAY = ARRAY(UNIQ(ARRAY, SORT(ARRAY)))
OUTPUTS:
An array of indicies into ARRAY is returned. The expression:
ARRAY(UNIQ(ARRAY))
will be a copy of ARRAY with duplicate adjacent elements removed.
KEYWORD PARAMETERS:
first - if set, then the subscript of the first occurence of
duplicate elements are returned (default is last occurence)
CALLED BY:
ADD_ALT, ADD_DETAIL, ADD_FLAG, ADD_PLAN, ADJUST_REFCAL, ALL_VALS [1], ALL_VALS [2]
ANALYZE [1], ANALYZE_IMG, APPLY_CDS_ADEF, BATSE_LAD_DRM, BATSE_SPEC_DRM, BSC_VALID
CAT_OPEN [1], CHECK_DIST, CHK_DATAWIN, CHK_F_RASTER, CHK_F_STUDY, CHK_LINELIST
CHK_V_RASTER, CHK_V_STUDY, CONCAT2D, CONCAT3D, CTRCALCHEK, CleanGlitchBox
DATA_PATHS, DISPLAY_CDS_BURNIN, DISPLAY_NIMCP, DLASCAN, EIS_CPT_ASCII_TABLES [1]
EIS_CPT_ASCII_TABLES [2], EIS_CPT_CHECK_STUDY [1], EIS_CPT_CHECK_STUDY [2]
EIS_CPT_COMMAND_STORE_CHECK [1], EIS_CPT_COMMAND_STORE_CHECK [2]
EIS_CPT_TABLE_DIFFERENCE [1], EIS_CPT_TABLE_DIFFERENCE [2]
EIS_CPT_UNIQUE [1], EIS_CPT_UNIQUE [2], EIS_MULTIPLE_SEQUENCE_TABLES [1]
EIS_MULTIPLE_SEQUENCE_TABLES [2], FF_SUMMARY, FIND_CAMPAIGN, FIND_CDS_STUDIES
FIND_CLOSEST_ARR, FIND_DURATION, FIT_SPEC, FIX_IAP, FLAGOOL, FLARE_SORT
FRAMEWORK ABSTRACT CLASS DEFINITION, FUNCT_FIT, FXBWRITM, FindAllFiles, GAINCOR
GET_CDS_GIS, GET_NAR, GET_SLLD, GET_SUMER_FILES, GET_TIMING, GET_UNIQ_LIST
GHOST_BUSTER, GT_BSC_CHAN [1], GT_BSC_CHAN [2], GT_CDS_QL, GetColors, GetRng
HSI_DECIM_CORRECTION [1], HSI_DECIM_CORRECTION [2], HSI_HIST_GROUP
HSI_MAP_EVALUATOR [1], HSI_SPECTROGRAMCHAN_OVERLAP_FIX
HSI_SPECTROGRAM_DECIM_CORRECT, HSI_SPECTROGRAM_DECIM_TABLE
Hsi_contact2fits [1], Hsi_contact2fits [2], IMCONTOUR, INDEX2MAP, INTERP2INTEG
InsituTimeSeries, JOIN_STRUCT [2], LIST_ALT, LIST_ANOMALY, LIST_CAMPAIGN
LIST_CDROM, LIST_DETAIL, LIST_DSN, LIST_EXPER, LIST_EXP_COMM, LIST_FLAG
LIST_INST_DLYD, LIST_MAIN, LIST_MDI_M, LIST_NRT_RES, LIST_OP [1], LIST_OP [2]
LIST_OTHER_OBS, LIST_OTHER_RES, LIST_PLAN, LIST_SOHO_DET, MAP_DISCLA2CONT
MDI_SUMMARY_SUB1, MEAN_MAP, MELD_DISCSP [1], MK_CDS_PLAN, MK_LIBRARY_HELP
MK_PLAN_SORT, MK_SOHO_TARGET, NET_DIR_DIFF, NEWSCAN, NORH_F2EVF [1]
NORH_F2EVF [2], NORH_PR_EVX [1], NORH_PR_EVX [2], NORH_PR_INFO [1]
NORH_PR_INFO [2], NORH_RD_TCX [1], NORH_RD_TCX [2], NORH_RD_TSX [1]
NORH_RD_TSX [2], NORH_SYNTH_BYF [1], NORH_SYNTH_BYF [2], NORH_TRANS_BYF [1]
NORH_TRANS_BYF [2], NORP_RD_AVG [1], NORP_RD_AVG [2], NORP_RD_DAILY [1]
NORP_RD_DAILY [2], OCC_DBASE, OP_COM [1], OP_COM [2], OR_SHAPE
PICKFONT use to be XFONT, PLOT_GD_CALC, PLOT_MAP
PLOT_MAP2 WARNINGTEMPORARY FIX ONLY FOR 16 bit ZBuffer support
PLOT_SUPPORT, PRINT_STRUCT, RD_ADA, RD_BDA [1], READ_ANALIST, READ_HESI_DAT
READ_HESSI_DAT, READ_STTE, REGEN_SYNOP, REM_DUP_TAG, REM_FST, REM_SEQ
RESOLVE_NEW_OBS, ROWSORT, RdTap [1], RdTap [2], RdTap [3], SMK_FULLDET
SPECTROGRAM CLASS DEFINITION, SPEX_COMMONS [2], SPEX_COMMONS [4]
SPEX_PROC [1], SPEX_PROC [2], STEPPER [1], STEPPER [2], STEPPER [5], STEPPER_LP
SXT_WEIGHT, TEST_DIR2, TKI_UDPSLIT, TOK_RD_DAILY, TYKW_RD_DAILY, TimePosn
TimePosn_test, TimeXAxis, UNIQ_KEY, UPD_PLAN, UPD_SOHO_DET, UTPLOT_IMAGE, VSO_GET
VSO__DEFINE, WAMPHIT, WCS_HCLEAN, WDUMPREC, WHERE_VECTOR, WIDG_HELP, WRITE_HKBYDATE
W_HISTOGRAM, XCAMP, XDL [1], XDL [2], XSEL_LIST [1], XSEL_LIST [2], ads_into_att
ads_into_pnt, adsdirs [1], adsdirs [2], att_exst, bcs_chi_norm, big_eph
big_eph_short, cam_run_sum, chk_batse_env [1], chk_batse_env [2], chk_flares [1]
chk_flares [2], db_gbo, delete_week [1], delete_week [2], delind [1], delind [2]
doytim2ints, dpc_summary, eit_files, eit_fulldiskdb, ex2week [1], ex2week [2]
extract_val, fidrange [1], fidrange [2], find_pixel_intersects, fitshead2struct
flare_hist, flares2disk, fsp_11, fsp_mc, gen_file_id [1], gen_file_id [2]
get_afile_size [1], get_afile_size [2], get_att, get_dc_image [2]
get_dc_image [3], get_dc_warm, get_gevloc_data, get_hk_info [1], get_hk_info [2]
get_leak_image [1], get_leak_image [2], get_leak_image [3], get_most_comm [1]
get_most_comm [2], get_sfc_info, get_suncenter2, get_uniq, getwid, grid_data [1]
grid_data [2], hastogram, hesi_grid_trans, hessi_grid_trans, hessi_grm
hsi_as_appids, hsi_bad_pak, hsi_badpak_test, hsi_monthly_average
hsi_monthly_filename, hsi_qlook_concat, hsi_ras_rdevent
hsi_read_all_flare_list, hsi_sas_rdlimb, hsi_spectrogramACCBIN [2]
hsi_spectrogram__define [1], hsi_spectrogram__define [2]
hsi_spectrogram__define [3], hsi_spectrogram__get_obs [1]
hsi_spectrogram__livetime [1], hsi_write_txt_flare_list, hxsgrs_fsp, ihy_db
interp_img, ip_que_dmpver, iperr_sea, jitter_gif_xyimg, keyword_db
list_mo_log [1], list_mo_log [2], make_views, matchem [1], matchem [2], mdipdist
merge_batse_photons, merge_genxcat, mewe_spec mewe_spec_lwa, mewe_spec [1]
mewe_spec [2], mk_cd [1], mk_cd [2], mk_flick, mk_gsn_obs_s1, mk_mapfile [1]
mk_mapfile [2], mk_mo_disk, mk_mo_disk2, mk_query [1], mk_query [2], mk_sd2
mk_sdc [2], mk_sdc [3], mk_sdc [4], mk_sdm, mk_ssl, mo2wks, mo_check, mo_patch, mo_prep
mon_health [1], mon_health [2], mxf_read_data, nagoya_glevel, new_mon_health [1]
new_mon_health [2], norh_t2azel, path_data [1], path_data [2], path_sw [1]
path_sw [2], pfi_dominant, phoenix_filedb_get, plot_pcal, plot_ssw_fov
plot_trav [1], plot_trav [2], plot_trav [3], pmtras_analysis, pnt_exst
pr_mdihk_trans [1], pr_mdihk_trans [2], pr_sxt_term, pr_uniq_hk, pro_list [1]
pro_list [2], prt_afile_size [1], prt_afile_size [2], psk_correlate
qLine_Sequence, qNagoya_PointSources, qView_PickFiles, qView_Shortname
qsmei_sky_Pick, rd_fdss, rd_modb, rd_sumer [1], rd_sumer [2], rd_week_file [2]
rd_ydbtap, rdtbl, read_eit, save_data [2], sea, search_files, sel_dc_image [1]
sel_dc_image [2], sel_dc_image [3], seq_dset, seq_run_sum [1], seq_run_sum [2]
ser_dset, setssw_windows, sgt_det_y, sgt_wave, show_obs2, show_obs3, show_obs4
smei_buf_getframe, smei_buf_prep, smei_frm_get, smei_frm_name, smei_frm_property
smei_getfile, smei_sky, smei_star_list, soup_obs2, spex_energy_ranges [1]
spex_energy_ranges [2], ssc_files [1], ssc_files [2], ssc_files [3]
ssw_install [1], ssw_install [2], ssw_install_explinkages, ssw_start_rpcserver
ssw_strsplit, ssw_swmap_bestof, ssw_time2paths, ssw_upgrade [1], ssw_upgrade [2]
ssw_upgrade_backup, sswdb_upgrade, sswhere, str2html [1], str2html [2]
str2html [3], str_subset, str_top2sub, strjustify, strmids [1], strmids [2], strposn
strrempat [1], strrempat [2], strsplit, sxi_files, sxl2radiance, sxl_select
sxt_cen [1], sxt_cen [2], sxt_combine, sxt_decon [1], sxt_decon [2], sxt_eff_area
sxt_flux [1], sxt_flux [2], sxt_flux [3], sxt_his2dbase, sxt_low8_match [1]
sxt_low8_match [2], sxt_mwave, sxt_sumtime, sxt_suture [1], sxt_suture [2]
sxt_uniq [1], sxt_uniq [2], sxtpnt_sum, taer_rn, term_times
test_front_decimation_correct, test_rear_decimation_correct, tim2dbase
timegrid, timeline, timeline2html, topsdb [1], topsdb [2]
tr_mech_summary_img month, tr_reformat, trace_cat2data, trace_dph2struct [1]
trace_files, trace_get_vignette, trace_last_movie [1], trace_last_movie [3]
trace_movie_context, trace_movie_index [1], trace_movie_index [2]
trace_special_movie [1], trace_special_movie [2], trace_special_movie [3]
trace_special_movie2, trace_success_file, trace_uniq_movies, tvmulti
uniq_fid [1], uniq_fid [2], url_decode, vu_insitu, vu_insitu_raw, vu_mean, vu_movie
web_seq, weekfiles, weekid [2], wfilpck, wrt1orbit [1], wrt1orbit [2]
www_help_break, www_help_get_info, xcheckip, xdisp_sci5k, xgen_widget
xset_chain [1], xset_chain [2], xspr [1], xspr [2], ydb_exist [1], ydb_exist [2]
ydb_exist [3], ydb_exist [4], ydb_install [1], ydb_install [2], ydb_use
yo_index2path
COMMON BLOCKS:
None.
MODIFICATION HISTORY:
5 January 1991, AB
17-Apr-92 (MDM) - Adjusted so that a scalar input would work (should
return a value of zero)
12-Jan-92 (slf) - added 'first' keyword
24-Apr-95 (MDM) - Modified to work on arrays over 32,000 elements
[Previous]
[Next]
NAME:
uniq_fid
PURPOSE:
Return a list of the unique File IDs in a directory
INPUT:
dir - a list of directories to check
OUTPUT:
Returns a string array of all uniq fileIDs
METHOD:
Get a directory listing for each valid prefix and
sort on the file IDs for all files
CALLS: ***
PREFIXCK, SPLIT_FILES, UNIQ [1], UNIQ [2], UNIQ [3], file_list [1], file_list [2]
CALLED BY:
fndrids, mk_fidlist, mo_fndirck, newfiles [1], newfiles [2], newfiles [3]
HISTORY:
Written 18-Apr-92 by M.Morrison
[Previous]
[Next]
NAME:
UNIQ_NOSORT
PURPOSE:
Return the subscripts of the unique elements in an array.
Does not require array to be sorted (as in UNIQ).
CATEGORY:
Array manipulation.
CALLING SEQUENCE:
UNIQ_SORT(Array)
INPUTS:
Array: The array to be scanned.
OUTPUTS:
An array of indicies into ARRAY is returned. The expression:
ARRAY(UNIQ_NOSORT(ARRAY))
will be a copy of the sorted Array with duplicate elements removed.
COMMON BLOCKS:
None.
Written : Scott Paswaters, NRL, Dec 1996.
SCCS variables for IDL use
@(#)uniq_nosort.pro 1.1 05/14/97 :NRL Solar Physics
[Previous]
[Next]
Name: uniqo
Purpose: return subscripts of uniq elements and maintain original order
Input Parameters:
inarr - array to search (does not have to be in sorted order)
Optional Parameters:
sinarr - DUMMY, not used - (maintain interface compatible with userlib
uniq.pro)
Keyword Parameters:
last - NOT YET IMPLEMENTED, switch, if set, subscript of last
occurence if multiples
Calling Examples:
uss=uniqo(array) ; return subscripts of uniq elements in
; original order in variable uss
CALLED BY:
BATSE_ON, FILE_SEARCHER [1], FILE_SEARCHER [2], GD_TITLE, GET_GDFILE
GET_RECENT_FILE, HESSI_FILTERS, HESSI_ID2INDEX, HSI_FIND_FILE, OCC_DBASE
Pointing_Change, WRITE_DD, disk_monitor [1], disk_monitor [2], eit_fulldisk
html_get_files, mk_trace_i1, mplot_nar, new_dpath [1], new_dpath [2]
nobeyama_update, plot_ar_pfi, plot_nar [1], plot_nar [2], rd_ydbtap, rd_ydbtapedir
search [1], search [2], set_fastpath [1], set_fastpath [2], set_logvms
show_pix [1], show_pix [2], spex_intervals [1], spex_intervals [2], ssw_bin
ssw_instr_info, ssw_path, ssw_set_instr, sxt_prep [1], sxt_prep [2], sxt_prep [3]
timeline, topsdb [1], topsdb [2], web_seq, ydb_pre2dir [1], ydb_pre2dir [2]
History:
12-Apr-1993 (SLF) - to preserve order when uniqifying string array's
(idl sorurce code and data path arrays)
(userlib V. supplied with IDL seems to ignore order
Restrictions:
last - keyword not yet implemented - fastest for arrays with many
repeated elements
[Previous]
[Next]
NAME:
UNIX_CMD
PURPOSE:
To execute a UNIX command and to monitor the command to make
sure that it completed in the expected time. If not, kill the
process and re-submit the command
SAMPLE CALLING SEQUENCE:
unix_cmd, cmd, out, tkill
unix_cmd, 'rsh isass0 ls -l /ydb/evn', out, 5*60.
INPUT:
cmd - The command to execute
tkill - The time in seconds to wait before killing and
re-submitting the command (in the event that it
has hung).
OUTPUT:
out - The results from the command
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FILE_STAT [1], FILE_STAT [2]
STR2ARR [1], STR2ARR [2], concat_dir [4], file_stat [3], rd_tfile [1]
rd_tfile [2], tbeep [1], tbeep [2], tbeep [3]
OPTIONAL KEYWORD INPUT:
check - The number of seconds between checks. Defaults to
1 second.
qdebug - If set, then print some debug statements
outfil - The output file to send the results to
nockeck_connect - If set, do not check that a connection was made
to the remote node. Default is to check for lost
network connections.
METHOD:
Spawn the command as detached (using "&") and monitor the
process. The output goes to a file (default is in the
home directory)
Use double quotes (") to isolate wildcards * and any time
that quotes are required in the command to be executed.
EXAMPLE:
rsh sxt2 "setenv ys_quiet; source ~/.yslogin; printenv DIR_SFD_DAILY1"
HISTORY:
Written 1994 by M.Morrison/K.J.Liu
1-Feb-95 (MDM) - Modified to make the temporary file have the PID
in the file name so that two UNIX_CMD jobs can
run in parallel
9-Feb-95 (MDM) - Modified to recognize NFS stale handling error
- Added debug statement
27-Feb-95 (MDM) - Re-inserted 14-Dec-94 (MDM) debug statement
31-May-95 (MDM) - Added "protocol failure in circuit setup" check
- Changed how the check is done (works from a list now)
8-Jun-95 (MDM) - Corrected the 31-May-95 change
[Previous]
[Next]
NAME: UNPACK_ALL_SCIENCE
PURPOSE: Main program to unpack all science TM files
from DACS, or ECS into raw DDIS files
CATEGORY: REDUCTION
CALLING SEQUENCE: UNPACK_ALL_SCIENCE, Date
INPUTS: None
OPTIONAL INPUTS: Date = Date to be processed, YYMMDD
If date is not present, then all
science files in $LEB_IMG will be
processed.
KEYWORD PARAMETERS: /QKL Set to process only QKL files
OUTPUTS: None
OPTIONAL OUTPUTS: None
CALLS: ***
CHECK_IN_DUMP_FILE, CHECK_IN_FP_FILE, CHECK_IN_IMG_FILE, CLOSE_FILE
DDIS_FILENAME, ECS2DDIS, GETENV_SLASH, GET_UTC, OBT2TAI, OPEN_DDIS_FILE
READ_TM_PACKET, SPLIT_QKL, TAI2UTC, UNPACK_SCIENCE_PACKET, UTC2STR
COMMON BLOCKS: unpack_science
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
MODIFICATION HISTORY: Written RA Howard, NRL
Version 1 RAH, 21 Dec 1995, Initial Release
Version 2 RAH, 23 Dec 1995, Changed to read in QKL and REL files
Version 3 RAH, 25 Dec 1995, Added call to reduction processing
Version 4 RAH, 28 Dec 1995, Removed call to reduction processing
Version 5 SEP, 14 Jan 1996, Sort QKL/REL by time
Version 6 RAH, 19 Jan 1996, Modified FP file names
Version 7 RAH, 26 Jan 1996, Corrected write if nwds=0
Version 8 RAH, 22 Apr 1996, Mods for TM returning after 0 or FF
Version 9 RAH, 01 Aug 1996, Added check for end of packet
Version 10 RAH, 27 Aug 1996, Correct ddis_name for duplicate times
Version 11 SEP, 12 Dec 1996, Sort High & Low packets by time
Version 12 NBR, 29 Dec 1997, Ensure pkidwd is less than pktsize in
UNPACK_SCIENCE_PACKET
Version 13 NBR, 13 May 1998, Fix findfile to not find *.SDU files
Version 14 NBR, 4 Nov 1998, Call SPLIT_QKL.pro for QKL files
Version 15 NBR, 16 Nov 1998, Added QKL keyword
Version 16 NBR, 11 Dec 1998, Do not call SPLIT_QKL with QKL keyword
Version 17 NBR, Feb 2000, Fix unpack_science_packet again
Version 18 NBR, May 2000, Fix endelse in unpack_science_packet
Version 19 NBR, 31 Jan 2002, Add /SH to spawn calls
Karl Battams Nov 04, 2005 Add /swap_if_little_endian kw to open[ruw] calls
11/04/05 @(#)unpack_all_science.pro 1.17 LASCO IDL LIBRARY
[Previous]
[Next]
NAME: UNPACK_LZ_SCIENCE
PURPOSE: Main program to unpack all science TM files
from Level-0 disks into raw DDIS files
CATEGORY: REDUCTION
CALLING SEQUENCE: UNPACK_LZ_SCIENCE [, filenames]
INPUTS: None
OPTIONAL INPUTS: Name of d01 file[s] to be processed
filenames STR or STRARR Ex.: '70750101.d01'
KEYWORD PARAMETERS: None
OUTPUTS: None
OPTIONAL OUTPUTS: None
CALLS: ***
CHECK_IN_DUMP_FILE, CHECK_IN_FP_FILE, CHECK_IN_IMG_FILE, CLOSE_FILE
DATATYPE [1], DATATYPE [2], DATATYPE [3], DDIS_FILENAME, DEC2HEX, ECS2DDIS
FIX_TIME_JUMPS, GETENV_SLASH, GET_UTC, OBT2TAI, OPEN_DDIS_FILE, STR2UTC [1]
STR2UTC [2], STR2UTC [3], TAI2UTC, TRIM, UNPACK_SCIENCE_PACKET, UTC2STR
COMMON BLOCKS: unpack_science
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
MODIFICATION HISTORY: Written RA Howard, NRL
Version 1 RAH, 21 Dec 1995, Initial Release
Version 2 RAH, 23 Dec 1995, Changed to read in QKL and REL files
Version 3 RAH, 25 Dec 1995, Added call to reduction processing
Version 4 RAH, 28 Dec 1995, Removed call to reduction processing
Version 5 SEP, 14 Jan 1996, Sort QKL/REL by time
Version 6 RAH, 19 Jan 1996, Modified FP file names
Version 7 RAH, 26 Jan 1996, Corrected write if nwds=0
Version 8 RAH, 28 Feb 1996, Mods for level-0
Version 9 RAH, 21 Apr 1996, Corrected when TM comes back after off
Version 10 RAH, 04 Aug 1996, Don't process if date < May 1996
because getting disks out of order
Also check for end of packet
Version 11 RAH, 29 Aug 1996, Correct ddis_name for duplicate times
Version 12 RAH, 03 Sep 1996, Correct for time jumps
Version 13 RAH, 04 Feb 1997, Correct high/low rate packet lengths
Version 14 NBR, 3 Aug 1998, Allow optional input of search parameter
Version 15 NBR, 28 Jan 1998, Check for gaps in packet file
Version 16 NBR, 13 Sep 1999, Stop for gaps of 10 min. or more
Version 17 NBR, Feb 2000, 'first GT 0' instead of 'keyword_set(first)';
If apid NE '88ac' or '88af' then skip packet and go on to the next
Version 18 NBR, Apr 2000, Fix case where most of packet is 255 (skip the packet)
Version 19 NBR, 31 Jan 2002 - Add /SH to spawn calls
03.10.09, nbr - Allow input of d01 filename(s)
03/12/18 - KB - Changed findfiles() to findfiles('*d01') in Line #610
05/11/16 - KB - change pkidwd to type long for bad packets
@(#)unpack_lz_science.pro 1.30 11/16/05 LASCO IDL LIBRARY
[Previous]
[Next]
NAME: UNPACK_REDUCE_MAIN
PURPOSE: Main program to perform pipeline processing
on a file created by unpack_science
CATEGORY: REDUCTION
CALLING SEQUENCE: UNPACK_REDUCE_MAIN, Filename, Src
INPUTS: Filename = file name to process
Src = 1 for processing QL files at NRL
2 for processing Level-0 files at NRL
OPTIONAL INPUTS: None
KEYWORD PARAMETERS: None
OUTPUTS: None
OPTIONAL OUTPUTS: None
CALLS: ***
GETENV_SLASH, GET_UTC, REDUCE_IMAGE
COMMON BLOCKS: DBMS
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
MODIFICATION HISTORY: Written RA Howard, NRL
Version 1 RAH, 25 Dec 1995, Modified from REDUCE_MAIN, V3
Version 2 NBR, 31 Jan 2002 - Add /SH to spawn calls
Karl Battams 2 Nov 2005 - Add swap_if_little_endian keyword for opening binary data files
@(#)unpack_reduce_main.pro 1.3 11/02/05 LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS
Name : UPD_CDS_POINT
Purpose : Update pointing in CDS data structure
Category : CDS, Calibration, Class3
Explanation : Updates the pointing information in a CDS quicklook data
structure, based on information in a calibration database which
relates the OPS positions to pointing.
Syntax : UPD_CDS_POINT, QLDS
CALLED BY:
CDS_MOSAIC, GT_SOLAR_XY, MK_CDS_FITS, MK_CDS_GIF, READCDSFITS
Examples :
Inputs : QLDS = A CDS quicklook data structure.
Opt. Inputs : None.
Outputs : The modified structure is returned in place of the original
structure.
Opt. Outputs: None.
Keywords : NOROLL = If set, then the spacecraft roll angle is ignored in
determining the pointing.
*** THIS HAS BEEN SET TO BE THE DEFAULT FOR ***
*** ALL ROLL ANGLES SMALLER THAN 3 UNTIL ***
*** THE S/C ATTITUDE PROBLEM IS RESOLVED ***
To enable the use of the spacecraft roll angle, use
NOROLL=0
CENTER = The pointing to use for the center of the image as
[XCEN, YCEN]. Overrides the values derived from the
mechanism positions.
ADJUST = Adjust the position to account for the difference
between the solar photospheric and helium radii. The
calibration of the CDS pointing places the apparent
solar limb in helium 304 and 584 at the standard solar
radius as given by PB0R(). However, the true solar
photospheric limb should be somewhere interior to the
helium limb. The ADJUST keyword takes care of this
discrepency. There are three possible ways that this
keyword can be used:
ADJUST=value Where the value is the amount
to adjust the pointing by.
Only values >1 will be used.
ADJUST=1 or /ADJUST The default adjustment value of
1.01283 will be used.
ADJUST=0 Don't make the adjustment.
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 = ''
UPD_CDS_POINT, QLDS, ERRMSG=ERRMSG
IF ERRMSG NE '' THEN ...
Calls : ***
AVERAGE, DATATYPE [1], DATATYPE [2], DATATYPE [3], FXPAR [1], FXPAR [2]
GET_CDS_PNTCAL, POLY_FIT, STDEV
Common : None.
Restrictions: Assumes that the CDHS is in OPS or sunsensor pointing mode,
rather than internal mode. Otherwise, the OPS values are
simply commanded values, rather than actual values. Data taken
prior to 23 May 1996 were with the CDHS in internal mode.
Also assumes that the spacecraft pointing information in the
header is correct.
If the data was taken with feature tracking on, then the OPS
positions are extrapolated to the start of the observation.
Otherwise, the average OPS position is used.
Side effects: The parameters in the HDRTEXT part of the quicklook structure
are *not* updated.
Prev. Hist. : None.
History : Version 1, 25-Sep-1996, William Thompson, GSFC
Version 2, 11-Oct-1996, William Thompson, GSFC
Correct so that missing INS_X and INS_Y values are not
modified.
Version 3, 20-May-1997, William Thompson, GSFC
Added keyword NOROLL
Version 4, 29-Jul-1997, William Thompson, GSFC
Make even more sophisticated when OPS moves during
observation.
Version 5, 08-Aug-1997, William Thompson, GSFC
Added keyword CENTER
Version 6, 23-Aug-1997, William Thompson, GSFC
Fixed bug where one OPS position showed considerable
variation, while the other was rock steady.
Version 7, 30-Oct-1997, William Thompson, GSFC
Made NOROLL=1 the default.
Fixed bug involving applying UPD_CDS_POINT after
NOROLL=1 has already been applied.
Don't modify HDRTEXT--allow NOROLL=0 to be applied
to undo NOROLL=1.
Version 8, 25-Nov-1997, William Thompson, GSFC
Also made NOROLL=1 default for ROTATION tag within
window structures.
Version 9, 17-Dec-1997, William Thompson, GSFC
Added keyword ADJUST
Version 10, 12-Feb-1999, William Thompson, GSFC
Changed default to NOROLL=0 for all data after
19-Oct-1996. This change is necessary for data taken
immediately after the SOHO recovery.
Version 11, 21-Apr-1999, William Thompson, GSFC
Determine default behavior of roll based on value
rather than date. Assume all roll values below 3
degrees are really zero.
Version 12, 14-Jun-1999, William Thompson, GSFC
Make default adjustment 1.01283.
Version 13, 12-Jun-2003, William Thompson, GSFC
Fix bug with using /ADJUST multiple times.
Make /ADJUST the default.
Version 14, 01-Jul-2003, William Thompson, GSFC
Rotate coordinate system by 180 degrees when
upside-down.
Version 15, 14-Jul-2003, William Thompson, GSFC
Fixed bug in version 14 when called twice.
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : UPD_PLAN()
Purpose : Adds a SOHO science plan record to the database
Explanation : This procedure takes a SOHO science plan entry and adds it to
the database "sci_plan". This database contains a series of
such entries, making a historical list.
This routine differs from ADD_PLAN in two important ways.
First, it works for all the SOHO instruments, not just CDS.
Second, it overwrites whatever is already currently in the
database.
Use : Result = UPD_PLAN( DEF )
IF NOT UPD_PLAN( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing the following
tags:
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
It can also be an array of such structures.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
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 = ''
Result = UPD_PLAN( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
Bell, DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2]
DBBUILD [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]
DBUPDATE [1], DBUPDATE [2], DBUPDATE [3], DBUPDATE [4], GET_CAMPAIGN
GET_INSTRUMENT, GET_OBJECT, REMOVE [1], REMOVE [2], TAI2UTC, TRIM, UNIQ [1], UNIQ [2]
UNIQ [3]
CALLED BY:
READ_MSP_FILE
Common : None.
Restrictions: Only this routine or DEL_PLAN can be used to add or delete
science plan descriptions to or from the database.
Modifying the database by hand could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: Marks records as deleted. PRG_PLAN must be called to really
delete the records.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 7 November 1994
Modified : Version 1, William Thompson, GSFC, 7 November 1994
Version 2, William Thompson, GSFC, 3 April 1995
Fixed bug with conversion to instrument code
Version 3, William Thompson, GSFC, 8 May 1995
Modified to pay attention to DELETED field in database
Version 4, William Thompson, GSFC, 19 May 1995
Fixed bug when new entry would overlap more than one
old ones.
Changed way DBFIND is called, to speed up.
Version 5, William Thompson, GSFC, 22 May 1995
Modified to allow the input parameter to be an array.
Version 6, William Thompson, GSFC, 3 August 1995
Fixed bug when only one instrument referred to in list
of entries.
Version 7, William Thompson, GSFC, 15 August 1995
Modified to make more efficient.
Ignore overlapping entries rather than exit
Version 8, William Thompson, GSFC, 18 August 1995
Added tags XCEN, YCEN
Version 9, Zarro, ARC, 30 August 1996
Ignore ill-defined CAMPAIGN and OBJECT ID's rather
than exit.
Version : Version 9
[Previous]
[Next]
Project : SOHO-CDS
Name : UPD_SCI_PLAN
Purpose : Update SCIENCE plan with DETAILS plan
Category : planning
Explanation : Use info from DETAILS plan to update SCI_PLAN
Syntax : upd_sci_plan,iap
CALLED BY:
MK_CDS_PLAN
Examples :
Inputs : DETAILS = DETAILS plan array
SCIENCE = SCIENCE array to update
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
CALLS: ***
CONCAT_PNT, CONCAT_STRUCT, COPY_STRUCT [1], COPY_STRUCT [2], COPY_STRUCT [3]
DEF_INST_PLAN, EXIST, GET_CDS_FOV, GET_CDS_XY, GET_PLAN_PROG, GET_PLAN_TYPE
MK_PLAN_WRITE, REP_TAG_NAME, STR_FORMAT, WHERE_VECTOR
Common : None
Restrictions: None
Side effects: Science plan database will be modified
History : Written 9 January 1997, D. Zarro, ARC/GSFC
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
Project : SOHO - CDS
Name : UPD_SOHO_DET()
Purpose : Adds a SOHO detailed science plan record to the database
Explanation : This procedure takes a SOHO detailed science plan entry and
adds it to the database "soho_details". This database contains
a series of such entries, making a historical list. Anything
already in the database is overwritten.
Use : Result = UPD_SOHO_DET( DEF )
IF NOT UPD_SOHO_DET( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing the following
tags:
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
It can also be an array of such structures.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
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 = ''
Result = UPD_SOHO_DET( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
Bell, DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2]
DBBUILD [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]
DBUPDATE [1], DBUPDATE [2], DBUPDATE [3], DBUPDATE [4], GET_CAMPAIGN
GET_INSTRUMENT, GET_OBJECT, REMOVE [1], REMOVE [2], TAI2UTC, TRIM, UNIQ [1], UNIQ [2]
UNIQ [3]
Common : None.
Restrictions: Only this routine can be used to add or delete detailed science
plan descriptions to or from the database. Modifying the
database by hand could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 12 April 1995
Modified : Version 1, William Thompson, GSFC, 12 April 1995
Version 2, William Thompson, GSFC, 19 May 1995
Fixed bug when new entry would overlap more than one
old ones.
Changed way DBFIND is called, to speed up.
Modified to take into account DELETED field.
Version 3, William Thompson, GSFC, 22 May 1995
Modified to allow the input parameter to be an array.
Version 4, William Thompson, GSFC, 3 August 1995
Fixed bug when only one instrument referred to in list
of entries.
Version 5, William Thompson, GSFC, 15 August 1995
Modified to make more efficient.
Ignore overlapping entries rather than exit
Version 6, Zarro, ARC, 30 August 1996
Ignore ill-defined CAMPAIGN and OBJECT ID's rather
than exit
Version : Version 6
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
UPDATE_CAMPAIGN
PURPOSE:
Read the ASCII campaign file and update campaign database
CATEGORY:
Planning, database
SYNTAX:
update_campaign
OPTIONAL INPUTS:
ID - ID of a campaign to be inserted/updated
KEYWORDS:
TSTART,TEND = times to consider in update
ERROR - Named variable, error message returned. A null string is
returned if no error occurs
PROGRESS - show progress bar
VERBOSE - obvious
NOCAL - skip updating calibrations
CALLS: ***
ADD_CAMPAIGN, ADD_TAG [1], ADD_TAG [2], ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2]
ARR2STR [1], Arr2Str [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DPRINT
EXIST, GET_CAMPAIGN, GET_UTC, LOC_FILE [1], LOC_FILE [2], LOC_FILE [3], MATCH_STRUCT
MOD_CAMPAIGN, PROGMETER, RD_ASCII [1], RD_ASCII [2], RESET_ZDBASE, STR2ARR [1]
STR2ARR [2], STR2LINES, TAG_EXIST [1], TAG_EXIST [2], TAI2UTC, TRIM, TRIM_CAMPAIGN
UTC2TAI, WHICH_INST, XKILL, concat_dir [4], is_number [1], is_number [2]
CALLED BY:
UPDATE_KAP, XCAMP
RESTRICTIONS:
Requires campaign ASCII database file located in SOHO_EAP directory
HISTORY:
Version 1, September 9, 1996, Liyun Wang, NASA/GSFC. Written
Version 2, September 19, 1996, Liyun Wang, NASA/GSFC
Modified such that an empty CMP_end will cause CMP_end to
be set to 2005/12/31
Version 3, 23-Sep-1996, William Thompson, GSFC
Changed COMMENTS to COMMENT. Added CMP_TYPE to CDS structure.
Version 4, September 23, 1996, Liyun Wang, NASA/GSFC
Added optional input parameter: ID
Version 5, September 24, 1996, Liyun Wang, NASA/GSFC
Made campaign structure for SUMER similar to that for CDS
Filled multiple institutes fields for CDS
Taken out TEST keyword
Version 6, Sept 24 1996, Zarro, ARC
Made CDS campaign structure compatible with GET_CAMPAIGN
CONTACT:
dzarro@smmdac.nascon.nasa.gov
[Previous]
[Next]
Project : SOHO-CDS
Name : UPDATE_CDS_TARGETS
Purpose : Driver to update CDS target pages
Category : planning
Explanation : calls PLOT_CDS_POINT
Opt. Inputs : DATE = date to process
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
GET_UTC, PLOT_CDS_POINT [1], PLOT_CDS_POINT [2], TEST_DIR, concat_dir [4]
Restrictions: Unix only
History : Written 14 July 2001 D. Zarro (EITI/GSFC)
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
Project : SOHO - CDS
Name : UPDATE_DEX()
Purpose : Updates CDS data extraction windows for current setup
Explanation : The CDS data extraction windows depend not only on the
wavelength specified by the planner of the raster but also
upon the current wavelength calibration and setup (eg VDS
offsets) of the spectrographs. Since these may have changed
since the original planning was performed, this routine is
called by CPT to update the extraction windows immediately
prior to uplinking the commands. Note that the datawin
database (And mk-raster which writes it) use the convention
that NIS1 uses CCD rows 0-511 while NIS2 uses CCD rows 512-1023
That is the reverse of real operations and so this routine
automatically performs the switch required. Use of the
routine plot_dex on a raw structure returned by get_datawin
will show the wrong orientation so always use...
IDL> get_datawin, ID, dw
IDL> plot_dex, update_dex(dw)
Use : IDL> new_dex = update(old_dex,version=version)
Inputs : old_dex - the datawin structure as returned by GET_DATAWIN
Opt. Inputs : None
Outputs : Function returns same structure as input with window definition
values updated.
Opt. Outputs: None
Keywords : VERSION - returns the version number of the calibration
parameters.
Calls : ***
Bell, CP_GET_ENTRY, DATATYPE [1], DATATYPE [2], DATATYPE [3], GET_LINELIST
LOAD_WAVECAL, SAVE_WAVECAL, STR2ARR [1], STR2ARR [2], TRIM, WAVE2PIX, WHICH_GIS_BAND
CALLED BY:
RASTER_DUR, SHOW_DATAWIN
Common : None
Restrictions: None
Side effects: None
Category : Planning, command
Prev. Hist. : None
Written : C D Pike, RAL, 6-Feb-96
Modified : Added offsets from STATE db. CDP, 16-Feb-96
Cut out use of w_height tag so it will handle
IEF window structure as well. CDP, 20-Feb-96
Trap new windows going beyond upper pixel limit. CDP, 23-Feb-96
Sort out NIS1/2 and use NIS_HT parameter. CDP, 1-Mar-96
Updated to use new wavecal system. CDP, 14-Mar-96
Use X centre of window to calculate Y location,
and fix grating order blindness. CDP, 20-Mar-96
Allow NIS default extraction to have a window height.
CDP, 28-Mar-96
Fix bug associated with second order lines. CDP, 25-Mar-97
Version 10, 07-Dec-1998, William Thompson, GSFC
Round off vertical positions on window, instead of
simply rounding off.
Version : Version 10, 07-Dec-1998
[Previous]
[Next]
NAME:
UPDATE_HDR_ROLLXY
PURPOSE:
This function updates a level-1 hdr with the solar roll angle, sun xpos
and sun ypos obtained from stars and also their running median
equivalents. It also writes the number of stars used to calculate
the center and total number of stars that could have been used.
Center values from time files start with 0 but in FTS header
starts with 1, therefore 1 is added to these when updating the
header.
CATEGORY:
LASCO_ANALYSIS
CALLING SEQUENCE:
Result = UPDATE_HDR_ROLLXY (Hdr)
INPUTS:
Hdr: A LASCO header structure
OUTPUTS:
1: Update Success
0: Update Failure
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], FXADDPAR [1], FXADDPAR [2]
LASCO_FITSHDR2STRUCT, STR2UTC [1], STR2UTC [2], STR2UTC [3], UTC2YYMMDD
PROCEDURE:
Update the hdr using the time files as defined in the
c*_rollxy_yymmdd.dat format files.
MODIFICATION HISTORY:
Written by: 98/10/06 Ed Esfandiari
[Previous]
[Next]
Project : SOHO-CDS
Name : UPDATE_IAP
Purpose : Update Databases from latest IAP files from SOC
Category : planning
Explanation :
Syntax : update,date
Examples :
Inputs : DATE = date to update [def=current]
Opt. Inputs : None
Outputs : None
Opt. Outputs:
Keywords : VERBOSE = print some info
: IGNORE = ignore a particular instrument
: NOPURGE = don't purge DB's after update
: ERR = error messages
: DELETE = delete local IAP files when done
: FORWARD = days ahead to update
: BACKWARD = days backward to update
SOHO = force SOHO DB to be updated
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], EXIST, FIX_ZDBASE, GET_LATEST_IAP, GET_UTC
LOCK_ZDBASE, PRG_PLAN, PRG_SOHO_DET, READ_KAP, RM_FILE, UNLOCK_ZDBASE
Common : None
Restrictions: Unix only (with FTP access to SOC, and write access to DB)
Side effects: None
History : Written 9 January 1997, D. Zarro, ARC/GSFC
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
Name: update_image
Purpose: update image and image parameters for xstepper and display
Input Parameters:
topid - widget id of toplevel (xstepper) widget
Keyword Parameters:
quiet - if set, inhibits status messages
CALLS: ***
ZOOM_SINGLE [1], ZOOM_SINGLE [2], ZOOM_SINGLE [3], stepper_title [1]
stepper_title [2]
CALLED BY:
xstepper [1], xstepper [2], xstepper_event
History: slf, 30-Apr-92 (for xstepper)
slf, 4-Jun-92 (add ssmap option)
slf, 19-Oct-92 (fixed interp bug)
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
UPDATE_KAP
PURPOSE:
Read in the latest KAP files to keep database updated
CATEGORY:
Planning
EXPLANATION:
This routine checks the KAP related database against released
KAP files and makes sure that the KAP related database is
updated (by calling READ_KAP). It will examine and read, if
necessary, the KAP files from the date DATE to the next
SPAN days.
SYNTAX:
update_kap, date
CALLED BY:
MK_CDS_PLAN, MK_SOHO
EXAMPLES:
update_kap, '1995/11/07', ignore='CDS'
INPUTS:
None required. If no input parameter, current date is implied.
OPTIONAL INPUTS:
DATE - The date starting from which the KAP files will be checked.
This can be in any of the standard CDS time formats.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
TSTOP - stop date for update (inclusive)
KEYWORDS:
IGNORE - If passed, then contains the name or code value (see
GET_INSTRUMENT) of an instrument to ignore when
reading in SCIPLAN entries. This is so that one can
avoid overwriting one's own SCIPLAN entries, if
desired.
BACKWARD - Number of days backward from which the KAP files
are checked and read.
SPAN - Number of days to span (starting from given DATE)
STATUS - Indicator whether any new KAP file is read. 0 if no
KAP file is read; 1 otherwise
FORCE - Force the routine to read the latest KAP even if it
has been read
ERR - Returned err message; null for no err
PURGE - set to automatically purge the DB's each time
CAMP - set to update CAMPAIGN DB
CHECK - set to check KAP's for valid campaigns
SOHO - force SOHO DB to be updated
NORES - do not update Resource DB
CALLS: ***
ADD_TAG [1], ADD_TAG [2], ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2]
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CHECK_KAP, CONCAT_DIR [1]
CONCAT_DIR [2], CONCAT_DIR [3], CONCAT_STRUCT, DATATYPE [1], DATATYPE [2]
DATATYPE [3], DATE_CODE, DPRINT, ESPAWN, EXIST, FIND_WITH_DEF [1], FIND_WITH_DEF [2]
FIND_WITH_DEF [3], FIX_ZDBASE, GET_LATEST_KAP, GET_SOHO_INST, GET_UTC, LOCK_ZDBASE
LOC_FILE [1], LOC_FILE [2], LOC_FILE [3], OS_FAMILY, PRG_PLAN, PRG_SOHO_DET
READ_KAP, TAG_EXIST [1], TAG_EXIST [2], TEST_OPEN, TRIM, UNLOCK_ZDBASE
UPDATE_CAMPAIGN, WHERE_VECTOR, break_file [4], concat_dir [4], restgen [1]
restgen [2], savegen [1], savegen [2]
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, August 1, 1995, Liyun Wang, GSFC/ARC. Written
Version 2, August 3, 1995, Liyun Wang, GSFC/ARC
Added keyword STATUS
Version 3, February 27, 1996, Liyun Wang, GSFC/ARC
Added NO_X keyword
Version 4, March 4, 1996, Liyun Wang, GSFC/ARC
Added ERR keyword
Made input parameter DATE as an optional one
Version 5, June 3, 1996, Zarro, GSFC
Added check for KAP file creation date
Version 6, Jan 23, 1997, Zarro, GSFC
Added more error checks
Version 7, July 17, 1997, Zarro, GSFC
Added TSTOP
CONTACT:
Dominic Zarro, GSFC/ARC (zarro@solar.stanford.edu)
Liyun Wang, GSFC/ARC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
Project : SOHO - LASCO/EIT
Name : UPDATE_MPG
Purpose : Updates 13-day mpegs and writes daily mpegs for yesterday.
Calls : ***
ARR2STR [1], Arr2Str [2], FILE_DATE_MOD, GET_UTC, GIFS2MPEG, STR2UTC [1]
STR2UTC [2], STR2UTC [3], STR_SEP, TAI2UTC, UTC2STR, UTC2TAI, UTC2YYMMDD, w256 [1]
w256 [2]
Side effects: None.
Category : Image Display. Animation.
Written : Nathan Rich, NRL jan. 2000. Based on RTMVI.PRO
Version :
11/02/01 @(#)update_mpg.pro 1.1 :LASCO IDL LIBRARY
[Previous]
[Next]
Name: update_pixmap
Purpose: background task for xstepper pixmap movie sequence
CALLS: ***
GET_WVALUE, UPDATE_PIXIMG
History: slf, 2-Jun-92
[Previous]
[Next]
Project : SOHO - CDS
Name : UPDATE_RAS_DUR
Purpose : Updates all the raster durations in the database.
Explanation : The calculation of raster durations may change as properties
of the CDS are further understood. This routine allows a
global update of the raster duration parameter using output
from the function CALC_RAS_DUR().
Use : IDL> update_ras_dur [, /quiet]
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : QUIET - if set no details of the changes are output to the
screen
Calls : ***
Bell, CALC_RAS_DUR, FMT_VECT, GET_RASTER, LIST_F_RASTER, LIST_V_RASTER, MOD_V_RASTER
Common : None
Restrictions: None
Side effects: None
Category : Database
Prev. Hist. : None
Written : C D Pike, RAL, 9-Jun-95
Modified : Ignore existing negative raster durations as these are
a flag to indicate emoirically determined values. CDP 26-Feb-96
Don't update if the duration value has not changed.
CDP 10-Jun-96
Version : Version 3, 10-Jun-96
[Previous]
[Next]
Project : SOHO-CDS
Name : UPDATE_SOHO_TARGETS
Purpose : Driver to update SOHO target pages
Category : planning
Explanation : calls MK_SOHO_TARGET
Syntax : update_soho_target
Opt. Inputs : DATE = date to retrieve
Keywords : MAIL = send some mail
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
DATATYPE [1], DATATYPE [2], DATATYPE [3], EXIST, GET_USER_ID, GET_UTC, MK_PLAN_FORM
MK_SOHO_TARGET, SEND_MAIL, TEST_DIR, TRIM, concat_dir [4]
Restrictions: Unix only
History : Written 14 May 1998 D. Zarro, SAC/GSFC
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
Project : SOHO - CDS
Name : UPDATE_STUDY_DUR
Purpose : Updates all the study durations in the database.
Explanation : The calculation of raster durations may change as properties
of the CDS are further understood. This routine allows a
global update of the study duration parameters
Use : IDL> update_study_dur [, /quiet]
Inputs : None
Opt. Inputs : STUDY_ID = study ID of specific study to update
Outputs : None
Opt. Outputs: None
Keywords : QUIET - if set no details of the changes are output to the
screen
ERR - error strings
Calls : ***
Bell, DPRINT, EXIST, FMT_VECT, GET_F_STUDY, GET_RASTER_PAR, GET_STUDY, LIST_F_STUDY
LIST_V_STUDY, MOD_V_STUDY, TAG_EXIST [1], TAG_EXIST [2]
Common : None
Restrictions: None
Side effects: None
Category : Database
Prev. Hist. : None
Written : D. M. Zarro, ARC/GSFC, 3-Mar-96
Modified : D. M. Zarro, ARC/GSFC, 15-May-96
-- added single study option
-- added TITLE_ID search
Version : Version 2
[Previous]
[Next]
NAME:
user_time
PURPOSE:
get array of user entered start and stop times via widget
CALLING SEQUENCE:
user_times
INPUTS:
none
OUTPUTS:
none
COMMON BLOCK:
common comrange, numL, range
numL = number of starting and stopping time in the list
(number of "RANGE")
range = integer array to store startting and stopping time.
array of (7, 2, numL)
CALLS: ***
USER_TIMES, XMANAGER, XMENU [1], XMENU [2]
RESTRICTIONS:
length of the range list can not exceed Lmax(40)
PROCEDURE:
This widget including BUTTON, editable TEXT, LIST and TEXT
BUTTON: DELETE ONE, DELETE LAST, DELETE ALL, IDL, HELP and QUIT
DELETE ONE -- delete one range from the list.
DELETE LAST -- delete last range on the list.
DELETE ALL -- delete all the range from the list.
IDL -- escape to IDL
HELP -- (not in use)
QUIT -- exit from widget
TEXT(editable): To get user input.(start and stop time )
Update one range and append to current range
list.
user input: start time h:m:s d-m-y // stop time h:m:s d-m-y
start time only
// stop time only
start time // stop time h:m:s only, use d-m-y of
start time
LIST: To display array of RANGE list(start time and stop time)
mark entry or delete entry and compress list.
TEXT: Print out the error message
PROCEDURE CALLED:
usertimes_event
MODIFICATION HISTORY:
Written by Fei-Mei Chou, Jan. 1992
[Previous]
[Next]
NAME:
usertimes_event
PURPOSE:
This is widget application to be managed by XMANAGER.
Get array of user entered start and stop times via widget
CALLING SEQUENCE:
xmanager, 'usertimes', widget_id
INPUTS:
None
OUTPUTS:
None
CALLS: ***
gettime, gt_day [1], gt_day [2], gt_time [1], gt_time [2]
COMMON BLOCKS:
common comrange, numL, range
numL = total number of range in LIST
RESTRICTIONS:
Length of the range list can not exceed Lmax(40)
PROCEDURE:
Dialog box to get user input (widget_text, /editable)
There are 4 types of input:
0: start time h:m:s d-m-y // stop time h:m:s d-m-y
1: start time only
2: // stop time only
3: start time // stop time h:m:s(only)
If supply start time only, use previous stop time, and if
supply stop time only, then use previous start time, if there
is LIST exist. Otherwise will give a message and usr can try
again.
If provide only h:m:s for stop time, use d-m-y of starting
time, if there is starting tims, otherwise will give a error
message, and user can try input again.
save LIST, range, and numL in instance.Lnew, instance.range
instance.numL.
numL = number of range in the LIST
LIST = list of range in format of
hh:mm:ss dd-mm-yy hh:mm:ss dd-mm-yy
for starting and stopping time
range = integer array to store start and stop time (7,2,numL)
There are 6 "BUTTONS"
DELETE ONE = delete any one range from the list, bush this
button, then click on the line on the LIST to
be deleted.
DELETE LAST= delete last range in the list.
DELETE ALL = delete all the range from list.
IDL = escape to IDL
HELP = (not in use)
QUIT = quit from this widget.
If one click the line on the LIST(without push DELETE ONE
button) then will mark '****' on that line
The message text box will display all the error messages.
PROCEDURE CALLED:
gettime, gt_time, gt_day
MODIFICATION HISTORY:
Written by Fei-Mei Lee Chou, Jan, 1992.
[Previous]
[Next]
*******************************************************************************
Function UT_2_YYDOY(ut,[/STRING]) ; convert utime to year and doy, 'yydoy'
Purpose: Converts time from UTIME format, sec from 79/1/1, to
Year (YY) and Day of Year (DOY) as integers or strings
Inputs: UT - any time format accepted by anytim
STRING - If set, then return as a string in the format 'YYDOY'
Output: Default is a 2xN element INTARR where the first column is
YY, the truncated year (i.e. 79 for 1979)
and the second column is
DOY, the day number where 1 January is DOY=1
If only one time is passed, then a 2 element vector is returned
If the STRING keyword is set then an n element string vector
or scalar is returned in the format 'YYDOY'
CALLS: ***
DAYCNV [1], DAYCNV [2], DAYCNV [3], JDCNV [1], JDCNV [2], JDCNV [3], anytim [1]
anytim [2], anytim [3], anytim [4], anytim [5]
CALLED BY:
CP_CATREAD, HSI_UT_2_CLKDELTAFILETIME, Hsi_daily_catalog [1]
Hsi_daily_catalog [2], TWIDGET, cp_catwidget, hsi_clk_delta_calc
hsi_clock_drift_redo, hsi_clock_drift_soc, hsi_flare_id_check, hsi_orbpar4bck
hsi_rd_orbit_files, hsi_state_vectors, mksort, uvspplot
Restrictions:
Limited to 1950-2049
RAS, 93/1/25
ras, 7-jan-94, take advantage of anytim
*******************************************************************************
[Previous]
[Next]
NAME:
ut_time
PURPOSE:
Return UT time / convert input times between Local and UT time
OPTIONAL INPUT:
time_in - A time (or times) in the local time zone to be converted
to UT. Input can be any of the 3 standard input formats.
OR - uttimes to be converted to local times (/TO_LOCAL kwrd)
CALLS: ***
anytim2ex [1], anytim2ex [2], anytim2ints [1], anytim2ints [2], fmt_tim [1]
fmt_tim [2], int2secarr [1], int2secarr [2], tbeep [1], tbeep [2], tbeep [3]
udate2ex [1], udate2ex [2]
CALLED BY:
FIRST_LIGHT [1], FIRST_LIGHT [2], GOES_TODAY, MDI_SUMMARY, NORH_FITS_INTERP [1]
NORH_FITS_INTERP [2], ROLL_PLOT, ace_files, adjust_times, cam_run_sum
cfl_summary [1], cfl_summary [2], check_sci5k_trunc, disk_hog [1], disk_hog [2]
disp_gen [1], disp_gen [2], disp_therm_rs232, edac_summary, eit_catrd [3]
eit_files, eit_fulldisk, fl_goesplot [1], fl_goesplot [2], fl_goesplot [3]
fl_mktext, genx2html [1], genx2html [2], get1gbo, get_epoch_sfcs [1]
get_epoch_sfcs [2], get_newsoon, get_selsis, go_batch [1], go_batch [2]
go_yo_prod_batch, goes3sec_copy, goes_plot [1], goes_plot [2], goes_plot [3]
goes_plot [4], goes_plot [5], html_basics, html_doc, html_form_addtime [1]
html_form_addtime [2], html_form_addtime [3], image2movie, iperr_sea, jst
mdi_imagetool, mk_bad_pix_map_load, mk_formt_html [1], mk_formt_html [2]
mk_formt_html [3], mk_gif_mag_index, mk_imgsum_html, mk_lasteit_movie
mk_mdi_fits, mk_sfc [1], mk_sfc [2], mk_ssc_batch [1], mk_ssc_batch [2]
mk_synsfc_coeff [1], mk_synsfc_coeff [2], mon_health [1], mon_health [2]
mon_sci5k, new_edac_summary, new_mon_health [1], new_mon_health [2]
plot_loi_mmad, plot_loi_summary [1], plot_loi_summary [2], plot_pzt_corr
plot_shutter_perf, plot_therm_rs232a, plot_therm_rs232c, pr_maxmin_hk
pr_mdihk_trans [1], pr_mdihk_trans [2], pr_seq_frame_info, pr_status [1]
pr_status [2], pr_therm_rs232, pr_uniq_hk, quick_hkplot [1], quick_hkplot [2]
redo_disploi, redo_mon_sci5k, reltime [1], reltime [2], search_obs
sel_leak_image [1], sel_leak_image [3], sel_leak_image [4], selsis_copy [1]
selsis_copy [2], selsis_week, seq_run_sum [1], seq_run_sum [2], show_contacts
show_pix [1], show_pix [2], show_pix_event [1], show_pix_event [2]
show_pix_event [3], ssw_check_contrib, sxt2file, sxt2mpeg, sxt_html, sxt_mornint
sxt_plan, timeline, timeline2html, topsdb [1], topsdb [2], tr_lut_conv
tr_mech_summary_img month, tr_mk_seq_alph, trace_cat, web_seq, xdate [1]
xdate [2], xhkplot, xread_hist, xsearch_obs, xset_chain [1], xset_chain [2]
yopos [1], yopos [2]
OPTIONAL KEYWORD INPUT:
int - If set, return the time in the internal structure format
Default is in string format
ex - If set, return the time in the 7-element external format
Default is in string format
Calling Examples:
utnow = ut_time() ; current UT time
uttimes = ut_time(localtimes) ; local->ut
localtimes = ut_time(uttimes,/to_local)
HISTORY:
Written 4-Jun-93 by M.Morrison
9-Nov-93 (MDM) - Patch to work with SGI
4-apr-95 (SLF) - add TO_LOCAL keyword and function
use /noshell with spawn
7-Jun-95 (MDM) - Added eastern time zones
- Added check that time zone was recognized
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
UTC2DIFF()
PURPOSE:
Compute the difference in days between two dates
CATEGORY:
Time calculation
EXPLANATION:
UTC2DIFF calculates the difference in days between
the start date (start_time) and end date (intime).
The Keyword START_TIME is optional to give another
start date as the default. The default start date
is 2-dec-1995 which is day 1.
If intime is equal start_time it result as day 1
SYNTAX:
Result = utc2diff()
EXAMPLES:
INPUTS:
intime - date to calculate the difference
OPTIONAL INPUTS:
None.
OUTPUTS:
Difference in days between input dates
OPTIONAL OUTPUTS:
None.
KEYWORDS:
start_time - start date for calculation
default start date is 2-dec-1995 (SOHO launch)
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2]
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, July 7, 1999, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (Dietmar Germerott@linmpi.mpg.de)
[Previous]
[Next]
Project : SOHO - CDS
Name : UTC2INT()
Purpose : Converts CCSDS calendar time to internal format.
Explanation : This procedure converts Coordinated Universal Time (UTC)
calendar time, as either a seven element structure variable, or
in the CCSDS/ISO 8601 ASCII calendar format, into CDS internal
format. For notes on various time formats, see file
aaareadme.txt.
Use : Result = UTC2INT( UTC )
Inputs : UTC = This can either be a structure with the tags YEAR,
MONTH, DAY, HOUR, MINUTE, SECOND, MILLISECOND, or a
character string in CCSDS/ISO 8601 format, e.g.
"1988-01-18T17:20:43.123Z"
or one of it's variants--see STR2UTC for more
details.
Opt. Inputs : None.
Outputs : The result of the function is a structure with the tags:
MJD = The Modified Julian Day number
TIME = The time of day, in milliseconds since the
start of the day.
Opt. Outputs: None.
Keywords : ERRMSG = If defined and passed, then any error messages
will be returned to the user in this parameter
rather than being handled by the IDL MESSAGE
utility. If no errors are encountered, then a
null string is returned. In order to use this
feature, the string ERRMSG must be defined
first, e.g.,
ERRMSG = ''
RESULT = UTC2INT( UTC, ERRMSG=ERRMSG )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DATE2MJD [1], DATE2MJD [2], DATE2MJD [3]
STR2UTC [1], STR2UTC [2], STR2UTC [3]
CALLED BY:
ANYTIM2UTC [1], ANYTIM2UTC [2], CDS_VEL_SLICE [2], CHECK_EXT_TIME, STR2UTC [1]
STR2UTC [2], STR2UTC [3], UTC2DOW, UTC2SEC, UTC2TAI
Common : None.
Restrictions: None.
Side effects: If an error is encountered and the ERRMSG keyword is set,
UTC2INT returns an integer scalar equal to -1.
Category : None.
Prev. Hist. : None. However, the concept of "internal" and "external" time
is based in part on the Yohkoh software by M. Morrison and G.
Linford, LPARL.
Written : William Thompson, GSFC, 13 September 1993.
Modified : Version 1, William Thompson, GSFC, 21 September 1993.
Version 2, William Thompson, GSFC, 14 November 1994
Changed .DAY to .MJD
Version 3, Donald G. Luttermoser, GSFC/ARC, 3 January 1995
Added the keyword ERRMSG. Check to see if the input
structure (if sent) has 2 or 7 tags. If 2 tags (MJD &
TIME), this procedure returns the input variable with
no changes (i.e., already in CDS internal format).
Version 4, Donald G. Luttermoser, GSFC/ARC, 30 January 1995
Added ERRMSG keyword to internally called procedures.
Made error handling routine more robust. Note that
this procedure allows both scalars and vectors as
input.
Version : Version 4, 30 January 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : UTC2INT()
Purpose : Converts CCSDS calendar time to internal format.
Explanation : This procedure converts Coordinated Universal Time (UTC)
calendar time, as either a seven element structure variable, or
in the CCSDS/ISO 8601 ASCII calendar format, into CDS internal
format. For notes on various time formats, see file
aaareadme.txt.
Use : Result = UTC2INT( UTC )
Inputs : UTC = This can either be a structure with the tags YEAR,
MONTH, DAY, HOUR, MINUTE, SECOND, MILLISECOND, or a
character string in CCSDS/ISO 8601 format, e.g.
"1988-01-18T17:20:43.123Z"
or one of it's variants--see STR2UTC for more
details.
Opt. Inputs : None.
Outputs : The result of the function is a structure with the tags:
MJD = The Modified Julian Day number
TIME = The time of day, in milliseconds since the
start of the day.
Opt. Outputs: None.
Keywords : ERRMSG = If defined and passed, then any error messages
will be returned to the user in this parameter
rather than being handled by the IDL MESSAGE
utility. If no errors are encountered, then a
null string is returned. In order to use this
feature, the string ERRMSG must be defined
first, e.g.,
ERRMSG = ''
RESULT = UTC2INT( UTC, ERRMSG=ERRMSG )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DATE2MJD [1], DATE2MJD [2], DATE2MJD [3]
STR2UTC [1], STR2UTC [2], STR2UTC [3], UTC2INT_KB
CALLED BY:
ANYTIM2UTC [1], ANYTIM2UTC [2], CDS_VEL_SLICE [2], CHECK_EXT_TIME, STR2UTC [1]
STR2UTC [2], STR2UTC [3], UTC2DOW, UTC2SEC, UTC2TAI
Common : None.
Restrictions: None.
Side effects: If an error is encountered and the ERRMSG keyword is set,
UTC2INT returns an integer scalar equal to -1.
Category : None.
Prev. Hist. : None. However, the concept of "internal" and "external" time
is based in part on the Yohkoh software by M. Morrison and G.
Linford, LPARL.
Written : William Thompson, GSFC, 13 September 1993.
Modified : Version 1, William Thompson, GSFC, 21 September 1993.
Version 2, William Thompson, GSFC, 14 November 1994
Changed .DAY to .MJD
Version 3, Donald G. Luttermoser, GSFC/ARC, 3 January 1995
Added the keyword ERRMSG. Check to see if the input
structure (if sent) has 2 or 7 tags. If 2 tags (MJD &
TIME), this procedure returns the input variable with
no changes (i.e., already in CDS internal format).
Version 4, Donald G. Luttermoser, GSFC/ARC, 30 January 1995
Added ERRMSG keyword to internally called procedures.
Made error handling routine more robust. Note that
this procedure allows both scalars and vectors as
input.
Version : Version 4, 30 January 1995
[Previous]
[Next]
NAME:
UTC2YYMMDD
PURPOSE:
This function converts a modified julian date structure into a date
string in the format yymmdd
CATEGORY:
UTIL
CALLING SEQUENCE:
Result = UTC2YYMMDD(Utc)
INPUTS:
Utc: Universal time in the CDS time structure
OPTIONAL KEYWORDS:
Use /HHMMSS to have '_HHMMSS' added. Ex result: 'YYMMDD_HHMMSS'
Use /YYYY to have 4 digit year. Ex result: 'YYYYMMDD_HHMMSS'
OUTPUTS:
This function returns a date string in the format YYMMDD.
CALLS: ***
UTC2STR
CALLED BY:
C2_CALIBRATE, C3_CALIBRATE, CHECK_EXP_FACTOR_DUPS, CHECK_MONEXP_DUPS
COMPUTE_MONEXP_FACTORS, DELETE_EXPFAC, GETBKGIMG, GET_EXP_FACTOR [1]
GET_EXP_FACTOR [2], GET_SOLAR_RADIUS, MAKE_ALL_MONTHS, MAKE_DAILY_IMAGE
MAKE_DIFF_MPEG, MAKE_GIFS, MONITOR_EXP, MONITOR_EXP_IMG, MVI2FRAMES, PB_INVERTER
PLOT_EXP_FACTOR, PLOT_SUBHTR, READ_EXP_FACTOR, READ_MONEXP_DATA, REDUCE_DAILY
REDUCE_IMG_HDR, REDUCE_MAIN, RTMVI [1], UPDATE_HDR_ROLLXY, UPDATE_MPG
WRITE_EXP_FACTOR, carrmapmaker2, get_daily_list cam dte QLql FILTERfilter
rt_carrmapmaker yymmdd num_r rad limb wlimb hdr disp saveset nextrot
MODIFICATION HISTORY:
Written by: RA Howard, 1995
Updated : 97/01/28 SE Paswaters - Added /HHMMSS keyword
Updated : 97/12/15 SE Paswaters - Added /HHMMSS keyword
@(#)utc2yymmdd.pro 1.2 05/14/97 LASCO IDL LIBRARY
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
UTC_HEAD()
PURPOSE:
Calculates the UTC_HEAD when the integration of a SUMER image started
CATEGORY:
RAW processing
EXPLANATION:
SYNTAX:
Result = utc_head(header[,/EXTERNAL,/CCSDS,/ECS])
CALLED BY:
NLINE_DISPLAY, RAW2BIN
EXAMPLES:
INPUTS:
header - 92..,n Byte ARRAY SUMER binary header
OPTIONAL INPUTS:
None.
OUTPUTS:
struct or string Array of dimension n
The result of the function will be the UTC calendar time in one
of several formats, depending on the keywords passed.
Internal: A structure containing the tags:
MJD: The Modified Julian Day number.
TIME: The time of day, in milliseconds since
the beginning of the day.
Both are long integers. This is the default
format.
External: A structure containing the integer tags
"18-JAN-1988 17:20:43.12", "18-JAN-1988 17:20:43.123"
"1988-01-18T17:20:43.123Z", "1988/01/18 17:20:43.123"
CCSDS: An ASCII string containing the UTC time to, DAY
ECS: Similar to CCSDS, HOUR, MILLISECOND., MINUTE, MONTH, SECOND
STIME: The date and time has the format
See UTC2STR for more information.
VMS: The date and time has the format, YEAR, and, e.g.
except that the date has, for Space Data Systems (ISO 8601)
millisecond accuracy in the format
recommended by the Consultative Committee, the format:
Opt. Outputs: None.
Keywords : EXTERNAL = If set, then the output is in external format, as
explained above.
CCSDS = If set, then the output is in CCSDS format, as
explained above.
ECS = If set, then the output is in ECS format, as
explained above.
VMS = If set, then the output will be in VMS format, as
described above.
STIME = If set, then the output will be in STIME format, as
described above.
The following keywords are only valid if one of the string
formats is selected.
TRUNCATE = If set, then the time will be truncated to 1 second
accuracy. Note that this is not the same thing as
rounding off to the nearest second, but is a
rounding down.
DATE_ONLY = If set, then only the date part of the string is
returned.
TIME_ONLY = If set, then only the time part of the string is
returned.
UPPERCASE = If set, then the month field in either the VMS or
STIME format is returned as uppercase.
The following keyword is always valid.
ERRMSG = If defined and passed, then any error messages
will be returned to the user in this parameter
rather than being handled by the IDL MESSAGE
utility. If no errors are encountered, then a null
string is returned. In order to use this feature,
the string ERRMSG must be defined first, e.g.,
ERRMSG = ''
RESULT = UTC_HEAD( head, ERRMSG=ERRMSG )
IF ERRMSG NE '' THEN ...
CALLS: ***
OBT2TAI, TAI2UTC
COMMON:
None.
RESTRICTIONS:
Calls OBT2TAI, TAI2UTC
SIDE EFFECTS:
None.
HISTORY:
Version 1, March 4, 1997, Dietmar Germerott, MPAE Lindau. Written
UTC_HEAD.PRO uses routines programmed by W.Thompson (GSFC)
September 23, 1996 Georg Tomasch
Version 2.0, June 20, 1997, Dietmar Germerott, MPAE Lindau
changed name to utc_head because of name conflict
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
Name: utcursor
Purpose: allow user to click on utplot and return utplot time
Calling Sequence:
(first display utplot)
utcursor,x [,y, xd, /normal, /data, /device ,
/mark , /label , yrange=[y0,y1], /ticks , /quiet ,
err=err ]
Output Parameters:
x - time coordinate (Yohkoh internal time format)
y - y coordinate (default is data, use /device or /normal to override)
xd - x coordinate (same format as y)
Keyword Parameters:
data, device, normal - switches specify y, xd output
mark, label, ticks - switches to control labeling (see evt_grid.pro)
yrange - [y0,y1] in normalized coord for evt_grid vertical line
err - gets !err value after selection
CALLS: ***
GETUT [1], GETUT [2], anytim2ints [1], anytim2ints [2], evt_grid, fmt_tim [1]
fmt_tim [2]
CALLED BY:
evt_demo, goes_log
History:
11-Dec-1993 (SLF)
[Previous]
[Next]
.NAME:
utilities.pro
.PURPOSE:
Define a bunch of handy IDL utilities.
.COMMENT:
Compile with ".run utilities" from IDL V2.
.AUTHOR:
Hans-Martin Adorf
Space Telescope - European Coordinating Facility
European Southern Observatory
D-8046 Garching bei Muenchen
Karl-Schwarzschild-Str. 2
F.R. Germany
Internet: adorf@eso.org SPAN: ESO::ADORF or adorf@eso.span
.MODIFICATION HISTORY:
Jul 1990 HMA Initial implementation
Aug 1990 HMA Further improvements
Sep 1991 HMA Some comments provided
Oct 1991 HMA Added new features
Feb 1992 HMA Added new utilities
jan 1994 M.B Truncated version for IDL v 3.1.1 <==> LASCO
.TO DO
Introduce global variables to control, e.g. the verbosity of
graphics and image display of intermediate results.
CALLS:
[Previous]
[Next]
NAME:
UTIME
PURPOSE:
Function to return time in seconds from 79/1/1,0000 corresponding to
the ASCII time passed in the argument.
N.B. Valid only from 1950-2050
CATEGORY:
CALLING SEQUENCE:
RESULT = UTIME(UTSTRING,/ERROR)
INPUTS:
UTSTRING - String containing time in form YY/MM/DD,HHMM:SS.XXX
Also accepts Yohkoh format time string:
DD-MON-YY HH:MM:SS.XXX
Will not accept HH:MM:SS.XXX DD-MON-YY
ERROR - =0/1. If set to 1, there was an error in the ASCII
time string.
/date - return only the calendar date component of the UTIME
/time - return only the time day
OUTPUTS:
Double precision time in seconds since 79/1/1, 0000.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], JDCNV [1], JDCNV [2], JDCNV [3]
Month_id [1], Month_id [2], anytim [1], anytim [2], anytim [3], anytim [4]
anytim [5]
CALLED BY:
ACRIM, ACRIM_EV, ACRIM_OUT, BATSE_FILE2TIME, BATSE_ON, BATSE_ONTIMES, CHKPOINT
CONT_READ, CREATE_GIF_HTML, CREATE_HTML, DCFREAD, DET_POINT, DISCSP_READ, DN_FILE
DO_ALANSLIST, DO_FITSFILES, FILELIST, FIND_DBFILE, FLSTRING_TYPE, GAP_FILE, GETFLARE
GET_DAYN, GET_DISCSP511, GET_LAD_GAIN, GET_SLLD, GET_SPEC_CAL, GRABTIME, HFLARE
HV_FILE, HXARCHIVE, HXIS, HXRBS, HXRBS_FILETIMES, Load_sher, MEMORY_INTRVLS
MK_DISCSP_CAL, OP_COM [1], OP_COM [2], PLOTBATSE, PLOTFIT, PLOTMAP, PURGE_KAPS
QLDISPLAY, RDFCS, RDFIS, RDFIS_SPEC, RD_EXB, RD_TGRS_SPEC [1], RD_TGRS_SPEC [2]
READ_EPHEM, SC4TREAD, SPEX_COMMONS [2], SPEX_COMMONS [4], SPEX_HANDLES [1]
SPEX_HANDLES [2], SPEX_PROC [1], SPEX_PROC [2], SPEX_THISTORY [1]
SPEX_THISTORY [2], UPDATE_HTML, YYDOY_2_UT, YYDOY_2_UT TIME, anytim [1]
anytim [2], anytim [3], anytim [4], anytim [5], batse_create_html, batse_sea_html
bfits_burst [1], bfits_burst [2], drot, find_uvexp, getbrr_spec, hxrbs_response
mksort, mrdfits_spectra, plot_bda, rdfis_img, rdmap, read_dd, spex_evnt [1]
spex_evnt [2], spex_soxs_specfile__define, spex_xsm_specfile__define, uvspplot
wbs_response [1], wbs_response [2]
COMMON BLOCKS:
None.
SIDE EFFECTS:
If just a time is passed (no date - detected by absence of slash
and comma in string), then just the time of day is converted to
seconds relative to start of day and returned. If date and time
are passed, then day and time of day are converted to seconds and
returned. In other words, doesn't 'remember' last date used if
no date is specified. There is only rudimentary error checking,
strings like 82/02/30 will have the same value as 82/03/02.
PROCEDURE:
Parses string into component parts, i.e. YY,MM,DD,HH,MM,SS.XXX,
converts the strings into double precision seconds using a gregorian
date to julian date algorithm. Accepts vectors of strings as well
as scalar strings.
MODIFICATION HISTORY:
Written by Kim Tolbert 7/89
Modified for IDL Version 2 by Richard Schwartz Feb. 1991
Corrected RAS 91/05/02, error should be initialized to 0
Modified to accept vectors of dates by RAS, 92/07/07
Modified to accept vectors of any dimensionality by RAS, 92/08/10
Modified to automatically convert Yohkoh string format, ras, 01-May-93
Corrected 07-May-93 to again take whitespace in old date format, RAS
added time and date keywords, ras, 5-jan-94
minor changes to error handling, ras, 7-jan-94
[Previous]
[Next]
Function :
Utime2str
Use:
ut_str= utime2str( seconds [,utbase=utime('yy/mm/dd, hhmm:ss.xxx')] )
Inputs:
Seconds - time in seconds from basetime in UTcommon or as --->
Utbase - Reference time in seconds from 79/1/1
0 is accepted as a valid argument.
Output:
Structure UT_STR with two tagnames
.DAY - Day from 79/1/1 (day=1), longword
.TIME- Msec from start of day, longword
Purpose:
To facilitate passing times to Yohkoh software without using double
precision and to make it compatible with the Yohkoh UTPLOT package.
N.B. Not all versions of IDL can sucessfully translate double
precision between DEC VMS and MIPS machines even in XDR
format. Also, integers cannot be used for .DAY and Longword
for .TIME because it fails to be read properly. Probably, an
alignment problem, Unix lkes variables on fullword boundaries.
CALLS: ***
GETUTBASE [1], GETUTBASE [2]
CALLED BY:
READ_CONT_FITS, READ_DISCSP_FITS, anytim [1], anytim [2], anytim [3], anytim [4]
anytim [5]
History:
RAS, 93/4/6
ras, 29-nov-93, fixed structure/scalar incompatibilty
rad, 11-jan-94, fixed problem with negative numbers
[Previous]
[Next]
NAME: UTLABEL
PURPOSE: Print start date and time on plot drawn with UTPLOT routine.
Called by UTPLOT.
CALLING SEQUENCE: UTLABEL,LABEL,XPOS=XPOS,YPOS=YPOS
CALLING PARAMETERS:
LABEL - Date and time string to be written
XPOS - x value of location where LABEL will be printed in
normalized coordinates.
YPOS - Same as x for y location for printing LABEL.
CALLS: ***
CHECKVAR [1], checkvar [2]
MODIFICATION HISTORY:
Written by Richard Schwartz, Feb. 1991
[Previous]
[Next]
NAME:
UTPLOT
PURPOSE:
Plot X vs Y with Universal time labels on bottom X axis. X axis
range can be as small as 5 msec or as large as 20 years.
CALLING SEQUENCE:
UTPLOT,X,Y
UTPLOT, roadmap, y
utplot, x, y, '1-sep-91'
utplot, x, y, '1-sep-91', timerange=['1-sep-91', '2-sep-92']
utplot, x, y, '1-sep-91', timerange=[index(0), index(i)], xstyle=1
INPUTS:
X - X array to plot in seconds relative to base time.
(MDM) Structures allowed
Y - Y array to plot.
xst - Optional. The reference time to use for converting a structure
into a seconds array (OR) the time for the first value if
passing a floating array.
timerange - Optional. This can be a two element time range to be
plotted. It can be a string representation or structure.
LBL - 2 element vector selecting substring from publication format
of ASCII time (YY/MM/DD, HH:MM:SS.XXX). For example,
LBL=[11,18] would select the HH:MM:SS part of the string.
SAV - If set, UTPLOT labels, tick positions, etc. in !X... system
variables will remain set so that they can be used by
subsequent plots (normally !x... structure is saved in
temporary location before plot and restored after plot).
To clear !x... structure, call CLEAR_UTPLOT.
TICK_UNIT - Time between Major tick marks is forced to TICK_UNIT
Has no effect for axis longer than 62 days.
MINORS - Number of minor tick marks is forced to MINORS
NOLABEL If set then UTLABEL isn't printed on plot
XTITLE - text string for x-axis label - If the string contains
4 asterisks ('****'), the UT time will be substituted
for that substring
OPTIONAL OUTPUT PARAMETERS:
None.
CALLS: ***
ANYTIM2UTPLOT, ATIME [1], ATIME [2], CHECKVAR [1], Ex2Int [1], Ex2Int [2], FCHECK
GETUTBASE [1], GETUTBASE [2], SET_UTPLOT [1], SET_UTPLOT [2], anytim2ex [1]
anytim2ex [2], checkvar [2], int2secarr [1], int2secarr [2], str_replace [1]
str_replace [2]
CALLED BY:
ACRIM, ACRIM_EV, ACRIM_OUT, ACRIM_READER, AR_AREAS, BATSE_FLARES_WEEK
BCS_24HR_PLOT [1], BCS_24HR_PLOT [3], BCS_SPMOVIE [1], BCS_SPMOVIE [2]
BORN_AGAIN, BOX_LC, CHECK_SFC_PNT, COMPUTE_MONEXP_FACTORS, COMPUTE_MONEXP_POLY
DEMODULATOR_TEST, ECLIPSE_PLOTTER, EVAL_SHERB, FE25_BSC_TEMP, FIND_FAST_DATA
FLAREMETER, FS_GRAPH, GET_HXRBS_FITS, GIS_UTPLOT, GLITCH_TRACKER
HESSI FASTRATE CLASS DEFINITION, HESSI PACKET CLASS DEFINITION
HESSI ROLL_DB CLASS DEFINITION, HSI_ANY_SOHDATA, HSI_DO_QLOOK_PLOTS
HSI_NPAK_HISTOGRAM, HSI_VCFILE_PACKET_RATE, HXARCHIVE, HXFITS, HXISLIFE, HXISTPLOT
HXT_4CHPLOT, HXT_AUTOIMG, HXT_BACK, HXT_FANS, HXT_LCURVE, HXT_SPECTRA, HXT_SUMMER
LCBDA, NEUPERT_PLOT, NIS_BIAS_DEMO, NOV93_ECLIPSE, NOV_ECLIPSE, OBS_PLOT, ORB_EXTRAP
OVER_THE_LIMB, OVSA_EXPLORER formerly OVSA_PRESUB, OVSA_PRESUB, OVSA__DEFINE
PIXEL_LC, PLOTBATSE_QL, PLOT_BSC [1], PLOT_BSC [2], PLOT_BSC_AS2, PLOT_CDS_CRAYS
PLOT_ERR, PLOT_EXPINT, PLOT_EXP_FACTOR, PLOT_GCPARM, PLOT_GRSPCH, PLOT_GRSPCL
PLOT_GRSPHH, PLOT_GRSPHL, PLOT_HKLZ, PLOT_HT, PLOT_HXSPC, PLOT_HXSPH, PLOT_MED
PLOT_MONEXP_STD, PLOT_OCCS, PLOT_OCC_ONDAY, PLOT_SUBHTR, PROFILES2, Plot
QL_DAY_PLOT, QL_ORBIT_PLOT, QUICKATT [1], QUICKATT [2], QUICKDARK [2]
QUICKDRIFT [1], QUICKDRIFT [2], QUICKSTRAY [2], QUICK_DPE, READ_HXT_CAL, ROLL_PLOT
SET_UTAXIS, SOLAID, SPARTAN_PLANNER, SPEX_THISTORY [1], SPEX_THISTORY [2]
SPLINE_PLOT, SXSPC, SXT_HYST, SYNOPTIC_STATS, Sxt_goes_teem, TERM_QUICK, TERM_REVIEW
TERM_REVIEW_GIF, TEST_ATT, TV_SSX, TV_SYNOP, UTPLOT_IMAGE, UTPLOT_IO [1]
UTPLOT_IO [2], UTPLOT_IO [3], UTPLOT__DEFINE, WINDMETER, WL_CUBE_II, WPLOT_NONOP
WPLOT_SUBHTR [2], W_HISTOGRAM, XPLOT_HT, auto_bck_find, auto_bck_find0, avsig_temp
bcs_survey, box_lc_plot, box_sxthxt_fsp, cal_fig_mich, db_gbo, edac_summary
eis_status_sts1_conversions [5], eis_status_sts2_conversions [1]
eis_status_sts3_conversions [1], eit_proton_summary, emi_plot [1]
fit_bsc_plot, get_utevent [1], get_utevent [2], go_teem_plots, goes_plot [1]
goes_plot [2], goes_plot [3], goes_plot [4], goes_plot [5], goes_teem, goes_widget
goesem_eqn [1], goest_eqn [1], gr_summary_plot, grs32_fsp, grsl_fsp, high_mag_lat
hsi_as_plquality, hsi_obs_times, hsi_sas_plot_scpointing, hsi_test_packet_rate
hxs_fsp, hxsgrs_fsp, hxt_fsp, hxt_survey, hxt_utplot, hxtbox_fsp, imspec [10]
imspec [11], imspec [12], imspec [13], imspec [14], imspec [15], imspec [16]
imspec [17], imspec [18], imspec [19], imspec [1], imspec [20], imspec [21]
imspec [22], imspec [23], imspec [24], imspec [25], imspec [26], imspec [27]
imspec [28], imspec [29], imspec [2], imspec [30], imspec [31], imspec [32]
imspec [33], imspec [34], imspec [35], imspec [36], imspec [3], imspec [4]
imspec [5], imspec [6], imspec [7], imspec [8], imspec [9], jitter_gif_xyimg
last_lc, lcbsd, lchda, lcobs, lcur_plot [1], lcur_plot [2], lcwda, lsplot
mon_health [1], mon_health [2], mwlt_select, new_edac_summary
new_mon_health [1], new_mon_health [2], ovsa_interact, pl_dt_genx
pl_monitor_center, plot_door_open, plot_evn, plot_fem, plot_fft, plot_gbl [1]
plot_gbl [2], plot_img_cadence, plot_lcur [1], plot_lcur [2], plot_loi_mmad
plot_loi_summary [1], plot_loi_summary [2], plot_pzt_corr, plot_shutter_perf
plot_ssl, plot_ssw_fov, plot_sxg, plot_sxl [1], plot_sxl [2], plot_temps2 [1]
plot_trav [1], plot_trav [2], plot_trav [3], plotbft [1], plotbft [2], plotltc [1]
plotltc [2], plott_bda, plott_bda_dp, plott_hda, plott_hi_sum, plott_low_sum
plott_med1_sum, plott_med2_sum, plott_wda, ploty [1], ploty [2], pmtras_analysis
psk_correlate, rd_so_at_ftr, rd_sxs_pha [1], rd_sxs_pha [2], rd_therm_rs232
read_yohkoh_4_spex [1], read_yohkoh_4_spex [2], ref_day_plot, res_freq
show_obs2, show_obs3, show_obs4, sld_sls_vstrips, sld_vstrips, soon_cadence
soon_catstat, sooncat_cadence, soup_obs2, spectro_plot2, ssw_apkpbar, stt_plot
sxt_align, sxt_temps, sxtbox_fsp, tim2tfss, tprofiles, uvspplot, wdefroi [1]
wdefroi [2], yo_height
COMMON BLOCKS:
COMMON UTCOMMON, UTBASE, UTSTART, UTEND = base, start, and
end time for X axis in double precision variables containing
seconds since 79/1/1, 00:00.
COMMON UTSTART_TIME, PRINT_START_TIME = 0/1: don't/do print
start time label on plot
SIDE EFFECTS:
X vs Y plot is produced on current graphics device. The normal
X-axis is replaced by an axis with ticks and labels showing the
universal time. The start time of the plot is displayed in the
upper right inside corner of the plot if SET_UTLABEL,0 hasn't been
called.
RESTRICTIONS:
Cannot be used for times before 79/1/1 or after 99/1/1.
Range of X axis can be anywhere between 5 msec and 20 years.
PROCEDURE:
If start or end time hasn't been set, autoscale X axis.
If either has been set (via routines SETUTSTART and SETUTEND,
or directly), only data between times selected will be displayed;
i.e. X min = UTSTART - UTBASE; X max = UTEND - UTBASE.
Calls SET_UTPLOT using keyword LABELPAR to customize X
axis labels and tickmarks. Otherwise it uses all normal plotting
procedures and the !X and !Y system variables.
Note: Format of time written in labels differs slightly from format
used to pass times to routines. Input format contains only one colon
between minutes and seconds (makes the meaning of a partial string
precise) while labels include an extra colon between hours and minutes
(more acceptable for publication).
MODIFICATION HISTORY:
Written by Kim Tolbert, 4/88.
Mod. by Richard Schwartz to Version 2 91/02/17
Mod. by Richard Schwartz for compatibility with OPLOT. 3/26/91
Mod. by RAS, keywords TICK_UNIT and MINORS added 91/05/02
MOD. BY RAS TO ACCEPT ALL PLOT KEYWORDS, 91/10/03
Mod. by MDM to only save utstart setting if it is already defined
Mod by MDM to work with YOHKOH data (structure data types)
Mod by MDM to expand the COMMON block so that OUTPLOT will work
Mod by MDM 21-Apr-92 to not set !quiet
Mod by SLF 26-Apr-92 to reinstate the xtitle option
Mod by MDM 28-Aug-92 to add keyword YEAR to print the year on the
tick label
Mod by MDM 9-Apr-93 to added TIMERANGE option
Mod by MDM 12-Apr-93 to removed ZMARGIN since older IDL versions had
trouble with 9-Apr addition of TIMERANGE parameter
[Previous]
[Next]
NAME:
UTPLOT
PURPOSE:
Plot X vs Y with Universal time labels on bottom X axis. X axis
range can be as small as 5 msec or as large as 20 years.
CALLING SEQUENCE:
UTPLOT,X,Y
UTPLOT, roadmap, y
utplot, x, y, '1-sep-91'
INPUTS:
X - X array to plot in seconds relative to base time.
(MDM) Structures allowed
Y - Y array to plot.
xst - Optional. The reference time to use for converting a structure
into a seconds array (OR) the time for the first value if
passing a floating array.
LBL - 2 element vector selecting substring from publication format
of ASCII time (YY/MM/DD, HH:MM:SS.XXX). For example,
LBL=[11,18] would select the HH:MM:SS part of the string.
SAV - If set, UTPLOT labels, tick positions, etc. in !X... system
variables will remain set so that they can be used by
subsequent plots (normally !x... structure is saved in
temporary location before plot and restored after plot).
To clear !x... structure, call CLEAR_UTPLOT.
TICK_UNIT - Time between Major tick marks is forced to TICK_UNIT
Has no effect for axis longer than 62 days.
MINORS - Number of minor tick marks is forced to MINORS
NOLABEL If set then UTLABEL isn't printed on plot
XTITLE - text string for x-axis label - If the string contains
4 asterisks ('****'), the UT time will be substituted
for that substring
OPTIONAL OUTPUT PARAMETERS:
None.
CALLED BY:
ACRIM, ACRIM_EV, ACRIM_OUT, ACRIM_READER, AR_AREAS, BATSE_FLARES_WEEK
BCS_24HR_PLOT [1], BCS_24HR_PLOT [3], BCS_SPMOVIE [1], BCS_SPMOVIE [2]
BORN_AGAIN, BOX_LC, CHECK_SFC_PNT, COMPUTE_MONEXP_FACTORS, COMPUTE_MONEXP_POLY
DEMODULATOR_TEST, ECLIPSE_PLOTTER, EVAL_SHERB, FE25_BSC_TEMP, FIND_FAST_DATA
FLAREMETER, FS_GRAPH, GET_HXRBS_FITS, GIS_UTPLOT, GLITCH_TRACKER
HESSI FASTRATE CLASS DEFINITION, HESSI PACKET CLASS DEFINITION
HESSI ROLL_DB CLASS DEFINITION, HSI_ANY_SOHDATA, HSI_DO_QLOOK_PLOTS
HSI_NPAK_HISTOGRAM, HSI_VCFILE_PACKET_RATE, HXARCHIVE, HXFITS, HXISLIFE, HXISTPLOT
HXT_4CHPLOT, HXT_AUTOIMG, HXT_BACK, HXT_FANS, HXT_LCURVE, HXT_SPECTRA, HXT_SUMMER
LCBDA, NEUPERT_PLOT, NIS_BIAS_DEMO, NOV93_ECLIPSE, NOV_ECLIPSE, OBS_PLOT, ORB_EXTRAP
OVER_THE_LIMB, OVSA_EXPLORER formerly OVSA_PRESUB, OVSA_PRESUB, OVSA__DEFINE
PIXEL_LC, PLOTBATSE_QL, PLOT_BSC [1], PLOT_BSC [2], PLOT_BSC_AS2, PLOT_CDS_CRAYS
PLOT_ERR, PLOT_EXPINT, PLOT_EXP_FACTOR, PLOT_GCPARM, PLOT_GRSPCH, PLOT_GRSPCL
PLOT_GRSPHH, PLOT_GRSPHL, PLOT_HKLZ, PLOT_HT, PLOT_HXSPC, PLOT_HXSPH, PLOT_MED
PLOT_MONEXP_STD, PLOT_OCCS, PLOT_OCC_ONDAY, PLOT_SUBHTR, PROFILES2, Plot
QL_DAY_PLOT, QL_ORBIT_PLOT, QUICKATT [1], QUICKATT [2], QUICKDARK [2]
QUICKDRIFT [1], QUICKDRIFT [2], QUICKSTRAY [2], QUICK_DPE, READ_HXT_CAL, ROLL_PLOT
SET_UTAXIS, SOLAID, SPARTAN_PLANNER, SPEX_THISTORY [1], SPEX_THISTORY [2]
SPLINE_PLOT, SXSPC, SXT_HYST, SYNOPTIC_STATS, Sxt_goes_teem, TERM_QUICK, TERM_REVIEW
TERM_REVIEW_GIF, TEST_ATT, TV_SSX, TV_SYNOP, UTPLOT_IMAGE, UTPLOT_IO [1]
UTPLOT_IO [2], UTPLOT_IO [3], UTPLOT__DEFINE, WINDMETER, WL_CUBE_II, WPLOT_NONOP
WPLOT_SUBHTR [2], W_HISTOGRAM, XPLOT_HT, auto_bck_find, auto_bck_find0, avsig_temp
bcs_survey, box_lc_plot, box_sxthxt_fsp, cal_fig_mich, db_gbo, edac_summary
eis_status_sts1_conversions [5], eis_status_sts2_conversions [1]
eis_status_sts3_conversions [1], eit_proton_summary, emi_plot [1]
fit_bsc_plot, get_utevent [1], get_utevent [2], go_teem_plots, goes_plot [1]
goes_plot [2], goes_plot [3], goes_plot [4], goes_plot [5], goes_teem, goes_widget
goesem_eqn [1], goest_eqn [1], gr_summary_plot, grs32_fsp, grsl_fsp, high_mag_lat
hsi_as_plquality, hsi_obs_times, hsi_sas_plot_scpointing, hsi_test_packet_rate
hxs_fsp, hxsgrs_fsp, hxt_fsp, hxt_survey, hxt_utplot, hxtbox_fsp, imspec [10]
imspec [11], imspec [12], imspec [13], imspec [14], imspec [15], imspec [16]
imspec [17], imspec [18], imspec [19], imspec [1], imspec [20], imspec [21]
imspec [22], imspec [23], imspec [24], imspec [25], imspec [26], imspec [27]
imspec [28], imspec [29], imspec [2], imspec [30], imspec [31], imspec [32]
imspec [33], imspec [34], imspec [35], imspec [36], imspec [3], imspec [4]
imspec [5], imspec [6], imspec [7], imspec [8], imspec [9], jitter_gif_xyimg
last_lc, lcbsd, lchda, lcobs, lcur_plot [1], lcur_plot [2], lcwda, lsplot
mon_health [1], mon_health [2], mwlt_select, new_edac_summary
new_mon_health [1], new_mon_health [2], ovsa_interact, pl_dt_genx
pl_monitor_center, plot_door_open, plot_evn, plot_fem, plot_fft, plot_gbl [1]
plot_gbl [2], plot_img_cadence, plot_lcur [1], plot_lcur [2], plot_loi_mmad
plot_loi_summary [1], plot_loi_summary [2], plot_pzt_corr, plot_shutter_perf
plot_ssl, plot_ssw_fov, plot_sxg, plot_sxl [1], plot_sxl [2], plot_temps2 [1]
plot_trav [1], plot_trav [2], plot_trav [3], plotbft [1], plotbft [2], plotltc [1]
plotltc [2], plott_bda, plott_bda_dp, plott_hda, plott_hi_sum, plott_low_sum
plott_med1_sum, plott_med2_sum, plott_wda, ploty [1], ploty [2], pmtras_analysis
psk_correlate, rd_so_at_ftr, rd_sxs_pha [1], rd_sxs_pha [2], rd_therm_rs232
read_yohkoh_4_spex [1], read_yohkoh_4_spex [2], ref_day_plot, res_freq
show_obs2, show_obs3, show_obs4, sld_sls_vstrips, sld_vstrips, soon_cadence
soon_catstat, sooncat_cadence, soup_obs2, spectro_plot2, ssw_apkpbar, stt_plot
sxt_align, sxt_temps, sxtbox_fsp, tim2tfss, tprofiles, uvspplot, wdefroi [1]
wdefroi [2], yo_height
COMMON BLOCKS:
COMMON UTCOMMON, UTBASE, UTSTART, UTEND = base, start, and
end time for X axis in double precision variables containing
seconds since 79/1/1, 00:00.
COMMON UTSTART_TIME, PRINT_START_TIME = 0/1: don't/do print
start time label on plot
SIDE EFFECTS:
X vs Y plot is produced on current graphics device. The normal
X-axis is replaced by an axis with ticks and labels showing the
universal time. The start time of the plot is displayed in the
upper right inside corner of the plot if SET_UTLABEL,0 hasn't been
called.
RESTRICTIONS:
Cannot be used for times before 79/1/1 or after 99/1/1.
Range of X axis can be anywhere between 5 msec and 20 years.
PROCEDURE:
If start or end time hasn't been set, autoscale X axis.
If either has been set (via routines SETUTSTART and SETUTEND,
or directly), only data between times selected will be displayed;
i.e. X min = UTSTART - UTBASE; X max = UTEND - UTBASE.
Calls SET_UTPLOT using keyword LABELPAR to customize X
axis labels and tickmarks. Otherwise it uses all normal plotting
procedures and the !X and !Y system variables.
Note: Format of time written in labels differs slightly from format
used to pass times to routines. Input format contains only one colon
between minutes and seconds (makes the meaning of a partial string
precise) while labels include an extra colon between hours and minutes
(more acceptable for publication).
MODIFICATION HISTORY:
Written by Kim Tolbert, 4/88.
Mod. by Richard Schwartz to Version 2 91/02/17
Mod. by Richard Schwartz for compatibility with OPLOT. 3/26/91
Mod. by RAS, keywords TICK_UNIT and MINORS added 91/05/02
MOD. BY RAS TO ACCEPT ALL PLOT KEYWORDS, 91/10/03
Mod. by MDM to only save utstart setting if it is already defined
Mod by MDM to work with YOHKOH data (structure data types)
Mod by MDM to expand the COMMON block so that OUTPLOT will work
Mod by MDM 21-Apr-92 to not set !quiet
Mod by SLF 26-Apr-92 to reinstate the xtitle option
Mod by MDM 28-Aug-92 to add keyword YEAR to print the year on the
tick label
[Previous]
[Next]
NAME:
UTPLOT_IO
PURPOSE:
Plot X vs Y with Universal time labels on bottom X axis. X axis
range can be as small as 5 msec or as large as 20 years. Y-axis is
logarithmic.
CALLING SEQUENCE:
UTPLOT_IO,X,Y,UTSTRING,LABELPAR=LBL, /SAV,TICK_UNIT=TICK_UNIT,$
MINORS=MINORS, /NOLABEL, [& ALL KEYWORDS AVAILABLE TO PLOT]
IDENTICAL TO UTPLOT
CALLS: ***
UTPLOT [1], UTPLOT [2], UTPLOT [3], UTPLOT [4], UTPLOT [5], UTPLOT [6]
CALLED BY:
AR_AREAS, AR_SPECTRUM, BORN_AGAIN, GIS_UTPLOT, GOES_SAFE, GOES_TEK [1], GOES_TEK [2]
MAKE_TPOVIEW, NEUPERT_PLOT, PLOTBATSE, PLOT_ASC, QUICK_DPE, SOLAID
HISTORY:
11-Nov-92 (MDM) - Removed "ztype" keyword call to UTPLOT
19-Apr-93 (MDM) - Removed "zmargin" keyword call to UTPLOT
[Previous]
[Next]
NAME:
utplot_UTIME
PURPOSE:
Function to return time in seconds from 79/1/1,0000 corresponding to
the ASCII time passed in the argument.
CATEGORY:
CALLING SEQUENCE:
RESULT = utplot_UTIME(UTSTRING,/ERROR)
INPUTS:
UTSTRING - String containing time in form YY/MM/DD,HHMM:SS.XXX
ERROR - =0/1. If set to 1, there was an error in the ASCII
time string.
OUTPUTS:
Double precision time in seconds since 79/1/1, 0000.
CALLS: ***
YMD2SEC [1], YMD2SEC [2]
CALLED BY:
SETUT [1], SETUT [2]
COMMON BLOCKS:
None.
SIDE EFFECTS:
If just a time is passed (no date - detected by absence of slash
and comma in string), then just the time of day is converted to
seconds relative to start of day and returned. If date and time
are passed, then day and time of day are converted to seconds and
returned. In other words, doesn't 'remember' last date used if
no date is specified.
PROCEDURE:
Parses string into component parts, i.e. YY,MM,DD,HH,MM,SS.XXX,
converts the strings into double precision seconds, and sums them.
MODIFICATION HISTORY:
Written by Kim Tolbert 7/89
Modified for IDL Version 2 by Richard Schwartz Feb. 1991
Corrected RAS 91/05/02, error should be initialized to 0
15-Nov-91 (MDM) Renamed from UTIME to UTPLOT_UTIME to avoid
conflict with existing routine