[Previous]
[Next]
Project : HESSI
Name : Y2KFIX
Purpose : apply Y2K correction to date
Category : utility time
Explanation : uses pivot method. Dates earlier than pivot
will be corrected.
Syntax : IDL> fixed_date=y2kfix(date)
Inputs : DATE = date to fix
Outputs : FIXED_DATE = fixed date
Keywords : PIVOT = pivot year [def = 1950]
(e.g. dates like 1940/01/02 -> 2040/01/02)
CALLS: ***
ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2]
DATATYPE [3], DPRINT, HAVE_TAG, PR_SYNTAX, TRIM2, str_replace [1], str_replace [2]
CALLED BY:
ITOOL_SET_CSI
History : Written, 5-Jan-2000, Zarro (SM&A/GSFC)
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
PROJECT:
SDAC
NAME:
Y_AVERAGE
PURPOSE:
Get the average value of an array of displayed y values during a selected
interval.
CATEGORY:
UTILITY, GEN, GRAPHICS
CALLING SEQUENCE:
Y_AVERAGE, Tarray, Yarray, Average
CALLS: ***
ATIME [1], ATIME [2], GETUTBASE [1], GETUTBASE [2], MARK_REGION [1]
MARK_REGION [2]
INPUTS:
Tarray: X-axis array
Yarray: Y-axis array
OUTPUTS:
Average: Average of y values in specified interval.
More outputs in keyword format.
KEYWORDS:
STIME_STR: Interval starting time string: 'dd-Mon-yy hh:mm:ss.xxx' (output).
ETIME_STR: Interval ending time string: 'dd-Mon-yy hh:mm:ss.xxx' (output).
WMESSAGE: If set, instructions on marking using mouse with
non-X device will be displayed. (input)
ERROR: 0 if no error, 1 if error (output).
PROCEDURE:
y_average gets the average value of an array of y values during a
specified interval. Assumes that a time plot has been drawn.
mark_region is called to bring up cursor to allow user to specify
start and end time of region. Result is returned in average.
MODIFICATION HISTORY:
Written by ??
Mod. 08/13/96 by RCJ. Added documentation.
ras, 3-3-2003, change variable average to yaverage
CONTACT:
richard.schwartz@gsfc.nasa.gov
[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_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: ***
ATT_STRUCT [1], ATT_STRUCT [2], BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3]
CHMOD, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DPRINT, EVN_STRUCT
Ex2Int [1], Ex2Int [2], FEM_OLD_STRUCT, FEM_STRUCT, FILE_EXIST [2]
FIND_COMPRESSED, GBO_STRUCT [1], GBO_STRUCT [2], GET_NBYTES, GOES_SERVER
GOES_TEMP_DIR, IS_DIR, Int2Ex [1], Int2Ex [2], LOCAL_NAME, LOC_FILE [1]
LOC_FILE [2], LOC_FILE [3], MK_DIR, OBS_STRUCT [1], OBS_STRUCT [2], ORB_STRUCT
PNT_STRUCT, Rd_NewOrb_p [1], Rd_NewOrb_p [2], Rd_Pointer [1], Rd_Pointer [2]
Rd_fHeader [1], Rd_fHeader [2], Rd_fHeader [3], SOCK_COPY, SOCK_FIND, SOCK_GOES
SXT_STRUCT, UNIQ [1], UNIQ [2], UNIQ [3], YDB_PATH, anytim2ex [1], anytim2ex [2]
anytim2ints [1], anytim2ints [2], anytim2weeks [1], anytim2weeks [2]
break_file [4], concat_dir [4], data_type [1], data_type [2], ex2fid [1]
ex2fid [2], file_exist [1], file_exist [3], file_list [1], file_list [2]
fmt_tim [1], fmt_tim [2], gt_day [1], gt_day [2], int2secarr [1], int2secarr [2]
is_member [1], is_member [2], rd_week_file [1], rd_week_file [2]
rd_week_file [3], rd_week_file [4], rdwrt [1], rdwrt [2], rdwrt [3]
sel_timrange [1], sel_timrange [2], str_copy_tags [1], str_copy_tags [2]
str_copy_tags [3], str_copy_tags [4], str_replace [1], str_replace [2]
tim2orbit [1], tim2orbit [2], wc_where [1], wc_where [2], week_loop [1]
week_loop [2], week_loop [3], weekid [1], weekid [2], weekid [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]
Project : HESSI
Name : YDB_PATH
Purpose : return path to synoptic data
Category : synoptic sockets
Inputs : None
Outputs : PATH = environment value associated with $ydb
[def=''/sdb/yohkoh/ys_dbase']
Keywords : None
CALLED BY:
rd_week_file [2], weekid [2], ydb_exist [2]
History : 29-Dec-2001, D.M. Zarro (EITI/GSFC) Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
NAME:
YDN2MD
PURPOSE:
Convert from year and day number of year to month and day of month.
CALLING SEQUENCE:
YDN2MD,yr,dy,m,d
INPUTS:
yr = 4 digit year (like 1988), integer scalar
dy = day number in year (like 310), integer scalar or vector
OUTPUTS:
m = month number (1-12, e.g. 11 = Nov)
d = day of month (like 5).
Note: On error returns m = d = -1.
EXAMPLE:
Find the month/day of days 155 and 255 in the year 2001
IDL> ydn2md, 2001, [155,255], m, d
==> m = [6,9] & d = [4,12] ; = June 4 and September 12
MODIFICATION HISTORY:
Adapted from Johns Hopkins University/Applied Physics Laboratory
Update to use VALUE_LOCATE, W. Landsman January 2001
[Previous]
[Next]
Project : SOHO - CDS
Name : YES_NO
Purpose : Prompts and checks for a user answer of either YES or NO
Explanation : Prompts user for a yes/no answer and will not give up until
it gets one.
Use : yes_no, query, answer [,default,check=check]
Inputs : query - The question string
Opt. Inputs : default - The default answer. If a <CR> response is given,
select the default answer. If this is not present,
the default answer is "NO"
Outputs : answer - Returns a 0 for no, a 1 for yes
Opt. Outputs: None
Keywords : check - Double check the answer given for super-secure
applications.
Calls : ***
Bell
CALLED BY:
CAL_DETSELECT, CAT_DURATION, DETSELECT, FF_DEMO, FIX_LINELIST, GHOST_BUSTER
GIS_HV_CAL, NEW_FF_DEMO, NIS_AVG_SPECT_DEMO, NIS_WAVECAL_DEMO, SUMDETSELECT
SYNOPTIC_STATS, print2d_plot
Restrictions: None
Side effects: None
Category : Util, user
Prev. Hist. : Based on Yohkoh routine by M Morrison
Written : CDS version by C D Pike, RAL, 12-May-93
Modified :
Version : Version 1, 12-May-93
[Previous]
[Next]
NAME:
yesno
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
CALLED BY:
BCS_FREE_DATA, hardcopy [1], hardcopy [2], yesnox [1], yesnox [2]
HISTORY:
Written by Michael VanSteenberg Update 5/27/81
[Previous]
[Next]
NAME:
yesnox
PURPOSE:
Ask a yes/no question and check the answer
for validity (calls "yesno")
CALLING SEQUENCE
yesnox, 'Do you wish to extract the data', in, 'Yes'
INPUT:
str - The question string
OUTPUT:
in - Returns a 0 for no, a 1 for yes
OPTIONAL INPUT:
default - Select the default answer. If a
<CR> is chosen, select the default answer
If not present, the default answer is "NO"
CALLS: ***
yesno [1], yesno [2]
CALLED BY:
Alt_tim_sel, GET_TRANGE, HXTPIXON, HXT_QLOOK, OPEN_ANACUBE, PIXEL_LC, PREP_HXTDAT
RD_TAR, SIMPLE_TV2, TEMP_BCK_TIME_INTV, WR_PLAN_AREA, XMOVIE_SFM, any_fsp, ar_prep
box_sxthxt_fsp, cancel_dsn, choose_interval, daily_forecast [2], dbase2disk
delete_week [1], delete_week [2], ext_subset [1], ext_subset [2], file_purge [1]
file_purge [2], fix_pars0, focus_trace [1], focus_trace [2], focus_trace_flt
gbo_obs_coord, go_get_sirius, go_rdtap [1], go_rdtap [2], go_yo_prod_batch
goes_teem, goesem_eqn [1], goest_eqn [1], grs32_fsp, grsl_fsp, hxs_fsp, hxsgrs_fsp
hxt_fsp, hxt_survey, hxtbox_fsp, input_time [1], input_time [2], jitter_gif_xyimg
lastspd, mdifocus2, mdiiss, mdilaser, mk_mdi_iap, mk_mo_disk, mk_mo_disk2
mk_orbit_sum, mk_pix [1], mk_pix [2], mk_ssc_batch [1], mk_ssc_batch [2]
mult_th_fsp, op_get_special, op_times, plot_ssl, quit, sector_avg, sel_region
sxt_etemp, sxt_summary, sxt_uniq [1], sxtbox_fsp, teambb [1], teambb [2]
term_score2, video_menu, yoyo_man2
HISTORY:
Written 1988 by M.Morrison
27-Oct-96 [LWA], added CALLING SEQUENCE to header.
[Previous]
[Next]
Project : HESSI
Name : YMD2DATE
Purpose : convert YMD to date
Category : time utility
Inputs : YMD - year, month, day string, e.g. '040311'
Outputs : DATE - 11-Mar-2004
Keywords : ERR - error string
CALLS: ***
ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], COMDIM2, IS_BLANK, IS_STRING, is_struct
CALLED BY:
SYNOP_DEFINE
History : 29-Aug-2004, D.M. Zarro (L-3Com/GSFC). Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
NAME:
YMD2DN
PURPOSE:
Convert from year, month, day to day number of year.
CATEGORY:
CALLING SEQUENCE:
dy = ymd2dn(yr,m,d)
INPUTS:
yr = year (like 1988). scalar or vector
m = month number (like 11 = Nov). scalar or vector
d = day of month (like 5). scalar or vector
KEYWORD PARAMETERS:
OUTPUTS:
dy = day number in year (like 310). out
CALLED BY:
DT_TM_MAK [1], DT_TM_MAK [2], DT_TM_MAK [3], WFPC2_METRIC
COMMON BLOCKS:
NOTES:
MODIFICATION HISTORY:
Written by R. Sterner, 20 June, 1985.
Johns Hopkins University Applied Physics Laboratory.
RES 18 Sep, 1989 --- converted to SUN
R. Sterner, 1997 Feb 3 --- Made work for arrays.
Copyright (C) 1985, Johns Hopkins University/Applied Physics Laboratory
This software may be used, copied, or redistributed as long as it is not
sold and this copyright notice is reproduced on each copy made. This
routine is provided as is without any express or implied warranties
whatsoever. Other limitations apply as described in the file disclaimer.txt.
Converted to IDL V5.0 W. Landsman 2-Jan-1998
[Previous]
[Next]
NAME:
YMD2JD
PURPOSE:
From Year, Month, and Day compute Julian Day number.
CATEGORY:
CALLING SEQUENCE:
jd = ymd2jd(y,m,d)
INPUTS:
y = Year (like 1987). in
m = month (like 7 for July). in
d = month day (like 23). in
KEYWORD PARAMETERS:
OUTPUTS:
jd = Julian Day number (like 2447000). out
CALLED BY:
JD2YMD [1], JD2YMD [2], JD2YMD [3], SUN [1], SUN [2], WEEKDAY [1], WEEKDAY [2]
WEEKDAY [3]
COMMON BLOCKS:
NOTES:
MODIFICATION HISTORY:
R. Sterner, 23 June, 1985 --- converted from FORTRAN.
Johns Hopkins University Applied Physics Laboratory.
RES 18 Sep, 1989 --- converted to SUN
Copyright (C) 1985, Johns Hopkins University/Applied Physics Laboratory
This software may be used, copied, or redistributed as long as it is not
sold and this copyright notice is reproduced on each copy made. This
routine is provided as is without any express or implied warranties
whatsoever. Other limitations apply as described in the file disclaimer.txt.
[Previous]
[Next]
NAME: YMD2SEC
PURPOSE: Convert YY/MM/DD string to sec. Or if YMD and SEC parameters
aren't passed, to return arrays containing first of month and
first of year relative to start of year and 79/1/1 respectively
CALLING SEQUENCE:
YMD2ED,YMD=YMD,SEC=SEC,DAYS_MONTH=DAYS_MONTH,IUTYEARS=IUTYEARS,
ALT=ALT,ERROR=ERROR
INPUT PARAMETERS:
YMD - ASCII string YY/MM/DD
ALT - If set, then just return DAYS_MONTH and IUTYEARS arrays
OUTPUT PARAMETERS:
SEC - Result. Number of seconds since 79/1/1,0000 corresponding to
beginning of day specified in YMD.
DAYS_MONTH - Array containing first of month relative to start of year
in double precision seconds.
IUTYEARS - Array containing first of year relative to 79/1/1 in double
precision seconds for 21 years starting at 80/1/1.
ERROR - =0/1. If set to 1, indicates error in YY/MM/DD format.
CALLED BY:
ATIME [1], ATIME [2], SET_UTPLOT [1], SET_UTPLOT [2], utplot_UTIME [1]
utplot_UTIME [2]
MODIFICATION HISTORY:
Written by Richard Schwartz, Feb. 1991
[Previous]
[Next]
Project:
SDAC
NAME:
YMD2TJD
PURPOSE:
This function converts standard format times to truncated Julian day,
returned in double precision floating point. This is a standard
CGRO/BATSE time format.
Category:
UTPLOT, TIME, BATSE
CALLS: ***
anytim [1], anytim [2], anytim [3], anytim [4], anytim [5]
CALLING SEQUENCE:
time = ymd2tjd( item, [,error=error])
time = ymd2tjd('1-jan-79')
print, time
;3874.0
INPUT:
Item - The input time in any standard format accepted by ANYTIM
TJD of 3874 is equivalent to 1-jan-1979
KEYWORDS:
ERROR - set if there is an error in time conversion
CALLED BY:
GRABTIME, HV_FINDER, OCC_DBASE, WRITE_DD, batse_file_search [1]
batse_file_search [2], mrdfits_spectra
RESTRICTIONS:
limited to ANYTIM formats.
HISTORY:
ras, 19-march-94,
MODIFIED:
Version 2, documented RAS, 5-Feb-1997
[Previous]
[Next]
Project : SDAC
Name : YOHKOH_FORMAT
Purpose : This procedure sets the default style
for ATIME.PRO to the Yohkoh format, i.e.
dd-mon-yr hh:mm:ss.xxx
Category : UTPLOT, TIME
Explanation : A logical in the common is set.
Use : HXRBS_FORMAT
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : OLD_FORMAT - Format before changing.
Calls : ***
hxrbs_format
CALLED BY:
BATSE_ONTIMES, DO_ARCHIVEPLOTS, DO_EVENTLISTS, DO_FDBFILES, DO_PSPLOTS, FLDISPLAY
FLIST, FSPLOT, HXRBS, QLARCHIVE, QLDISPLAY, RAWDUMP, batse_menu, pro ratesdump
Common : UTSTART_TIME_
Restrictions: UTPLOT directories should be in !path.
Side effects: None.
Prev. Hist : First written, RAS, 1988?
Modified :
1/10/94 by AKT to return old format
RAS, 5-Feb-1997, completed documentation.
[Previous]
[Next]
Project : SDAC
Name : YOHKOH_FORMAT
Purpose : This procedure sets the default style
for ATIME.PRO to the Yohkoh format, i.e.
dd-mon-yr hh:mm:ss.xxx
Category : UTPLOT, TIME
Explanation : A logical in the common is set.
Use : YOHKOH_FORMAT
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : OLD_FORMAT - Format before changing.
Calls :
CALLED BY:
BATSE_ONTIMES, DO_ARCHIVEPLOTS, DO_EVENTLISTS, DO_FDBFILES, DO_PSPLOTS, FLDISPLAY
FLIST, FSPLOT, HXRBS, QLARCHIVE, QLDISPLAY, RAWDUMP, batse_menu, pro ratesdump
Common : UTSTART_TIME_
Restrictions: UTPLOT directories should be in !path.
Side effects: None.
Prev. Hist : First written, RAS, 1988?
Modified :
1/10/94 by AKT to return old format
RAS, 5-Feb-1997, completed documentation.
[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
[Previous]
[Next]
Project : SDAC
Name : YYDOY_2_UT
Purpose : This function converts time from Year (YY) and Day of Year (DOY)
into the UTIME format, sec from 1-jan-1979.
Category : UTPLOT, TIME
Explanation :
Use : Ut = YYDOY_2_UT('YYDOY') or
Ut = YYDOY_2_UT( [yy, doy] )
Inputs : Time - [YY,DOY] a 2 element or 2 x n vector
or a string or string array in the format 'YYDOY'
where YY is the last 2 digits of the year from 1950-2049,
i.e. 80 for 1980.
Also accepts years as 4 digit numbers or strings. Cannot
mix 4 digit years with 2 digit years for string input.
Opt. Inputs : None
Outputs : The function returns time in double precision seconds from
1-jan-1979, the ANYTIM(input, /sec) format.
Opt. Outputs: None
Keywords :
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], UTIME [1], UTIME [2]
CALLED BY:
GFITS_W, GRS2UTIME, HSI_CLKDELTAFILETIME_2_UT, HSI_ORBFILETIME_2_UT
Hsi_daily_catalog [1], Hsi_daily_catalog [2], RD_EXB, RD_UVCAT, TWIDGET
YYDOY_2_UT TIME, cp_catwidget, file name, hsi_flare_id_check, hsi_rd_trackfile
hsi_rdstatevectorfile
Common : None
Restrictions:
Limited to 1950-2049
Side effects: None.
Prev. Hist :
RAS, 93/1/25
Modified :
Version 2, RAS, 5-feb-1997, documentation header updated
Version 3, RAS, 19-Mar-1997, accepts 4 digit years