t7tosec $SSW/yohkoh/ucon/idl/mctiernan/t7totsec.pro
[Previous] [Next]
 NAME:
	t7tosec
 CALLING SEQUENCE:
	tsec=t7tosec(t7)
 PURPOSE:
	One of a set of routines designed to deal with the time
	structures used in fitspec
	t7totsec converts to seconds from the start of the day, actually, 
       from a seven element array, hr min sec msec day mon year
 INPUT:
	t1= time in [hr,min,sec,msec,day,mo,yr]
 OUTPUT:
	tsec= time in seconds from start of the day
 CALLS: ***
	T7TOTSEC
 HISTORY:
       17-jul-95, as a part of switching the tfsp time structure to the 7 element array


table_dump $SSW/yohkoh/gen/idl/reformat/table_dump.pro
[Previous] [Next]
NAME:
	table_dump
PURPOSE:
	To write an SXT table to a text disk file and a binary
	disk file.
INPUT:
	infil0	- Raw telemtry input file.
	strec	- Starting record where the dump begins (the
		  engineering program "table" or the reformatter
		  has searched until it found a table dump)
	year	- The year of the dump (since the raw telemetry
		  does not have the year)
	dir	- The output directory
OPTIONAL INPUT:
	rec1	- The telemetry major frame record with the dump
		  If this is passed, the raw file is not read.
 CALLS: ***
	BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], TABLE_PRINT [1], break_file [4]
	fmt_tim [1], fmt_tim [2], get_seq_tab, rd_telem, table_print [2], ttim2ex
HISTORY:
	Written 21-Nov-91 by M.Morrison (taking TABLE1 as the starting
			point.
	18-Dec-91 (MDM) - Routine was only displaying one of 4 PFI/FFI
			  sequence entry tables
	25-Mar-92 (MDM) - Changed to use "table_print" routine (extracted
			  the print portion and made that new routine)
        4-Sep-94 (SLF) - replaced all the spawn,'rm' with file_delete calls


table_print [2] $SSW/yohkoh/gen/idl/reformat/table_print.pro
[Previous] [Next]
NAME:
	table_print
PURPOSE:
	Take a binary (BTB) SXT table and write a text format to
	disk.
INPUT:
	fileid	- The fileID of the BTB file which should have an
		  ASCII file made.  It should be the exact time.
	dir	- The output directory name
OPTIONAL INPUT:
	prefix	- The prefix of the output filename.  If not specified
		  it will be 'TAB'.  
 CALLS: ***
	TAB_PRINT, TAB_READ, TEXTCLOSE [1], TEXTCLOSE [2], TEXTCLOSE [3]
 CALLED BY:
	table_dump
HISTORY:
	Written 25-Mar-92 by M.Morrison (taking TABLE_DUMP as the starting
			point.
	8-Jul-92 (MDM) - Adjusted to use headline - the 2 lines of 
			 comments in the table dump


taer_rn $SSW/yohkoh/ucon/idl/lemen/taer_rn.pro
[Previous] [Next]
 NAME:
    taer_rn
 PURPOSE:
    Generate randomn numbers for taers.

    Tries to return values that are increments of N*0.25 from AVG
 INPUTS:
    AVG	- Desired average.  Should be modulo 0.25 to work optimally.
    RANGE	- Limit on the +/- deviation.  Range=5 will result in values
		  within the range AVG +/- RANGE
    NPTS	- Number of values (number of days)
 OPTIONAL INPUT KEYWORDS:
    seed	- Starting seed for RANDOMN
    limit	- Limit on how close result*NPTS is to AVG*NPTS
    		  If limit=0 or is less than 0, the routine just takes
		  the first guess. If limit is positive, taer_rn will iterate,
		  calling randomn until it comes up with a desireable solution.
    preselect	- A vector which can contain preselected values.
		  If -1: then a randomn number is returned.
		  If -2: then 0 is returned and not included in the average
			 (for the case of an "off" day).

		  if n_elemetns(preselect) eq Npts, then the predicted and
		  off days will be returned in the same positions as they were
		  passed in through preselect.
 CALLS: ***
	UNIQ [1], UNIQ [2], UNIQ [3]
 RESTRICTIONS:
    If PRESELECT contains any negative values, it's length must be equal to NPTS
 
 HISTORY:
   20-feb-92, J. R. Lemen (LPARL), Written
   18-dec-95, JRL, Added preselect keyword


TANGENT_HEIGHT $SSW/yohkoh/ucon/idl/hudson/tangent_height.pro
[Previous] [Next]
 NAME:
     TANGENT_HEIGHT
 PURPOSE:
     compute the height of the intersection of a solar radius
       and the line of sight
 CATEGORY:
 CALLING SEQUENCE:
     position = tangent_height(latlon, date=date)
 INPUTS:
     latlon is the solar latitude and longitude, e.g. N10W95 is [10,95]
     NOTE THAT THIS IS IN NNWW FORMAT, NOT XXYY
 OPTIONAL (KEYWORD) INPUT PARAMETERS:
     date is the time of observation (default 5-Oct-96) 
     qstop stops
     debug prints out the vector manipulations
 OUTPUTS:
     [height, pa] height in km, pa in degrees measured CCW, N to E
 CALLS: ***
	get_rb0p [1], get_rb0p [2]
 COMMON BLOCKS:
 SIDE EFFECTS:
 RESTRICTIONS:
 MODIFICATION HISTORY:
     HSH, written 15-May-97


tap2tap $SSW/yohkoh/gen/idl/tape/tap2tap.pro
[Previous] [Next]
   Name:tap2tap

   Purpose: unix tape to tape copy routine

   Input Parameters:
      d1 - drive name for source 	(input)  - string or #
      d2 - drive name for destination  (output) - string or #
	    (note - type of d1 must=type of d2)

   Calling Examples:
      tap2tap, '/dev/nrmt0h','/dev/nrmt1h'     ;drive0->drive1
      tap2tap,0,1				;same (on ultrix)
      tap2tap,0,1,/log,block=1024		;blocking factor

   Optional Keyword Parameters:
      log - if set, log file written to current directory
      block - blocking factor

   Method: uses unix dd command

 CALLS: ***
	def_tapd [1], def_tapd [2], def_tapd [3], mt
   Restrictions: unix only


tap_wrt_chk $SSW/yohkoh/gen/idl/atest/tap_wrt_chk.pro
[Previous] [Next]
       NAME: tap_wrt_chk
               
       Purpose: Compare data on stage disk with XBD records.

       Keyword Parameters:

               stage_disk      Complete Path to stage area on disk. If not 
                               supplied, then default staging area for dumping
                               and compression will be /sxt8data5/stage_b1

               weekid          Complete name of tape, e.g., '95_381.01-1.220'

       Output Parameters:     

               bad_vects       A structure containing an explanatory readme string,
                               and 6 vectors with value 0 in position index
                               where no write error was found after dump from disk,
                               and contain a 1 in the position index where a write 
                               error was found for that type of file, e.g., ada, sfr,... 

  Some Example Calls:          
 CALLS: ***
	BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], Rd_TapDir, break_file [4]
	file_list [1], file_list [2], file_size [1], file_size [2], weekfiles
       History:
               
                               16-Feb-98 Adapted from go_mk_cd2.pro code


TapDir $SSW/yohkoh/gen/idl/tape/tapdir2.pro
[Previous] [Next]
   	NAME:
		TapDir
	PURPOSE:
		Write the tape directory file for an archive tape.
	CALLING SEQUENCE:
		TapDir, archdir, drecs, cpiosw, [startT=starttime, $
			endT=endTime, tDirfn=tDirfn], softw, tardirs, $
			cdidxpos, ver, tapeName, alldata,weekDir, $
			mktapverno=mktapverno
	INPUT/KEYWORD:
		archdir		list of data directories to backup.
		startTime	String: 'yymmdd.hhmm'--stating the 1st
				day of the archive tape.
		endTime		String:	'yymmdd.hhmm'--stating the last
				day of the archive tape.
		tDirfn		fileID for the binary tape dir. file.
		softw		tar command for software archive
		tardirs		paths and sizes of each software tar file
		ver		version # of mktap
		alldata		flag to override prompts and get all data
		weekDir		path to weekly files
		mktapverno	ver# of data structure to tape dir. file.
	Returned/Results:
		drecs		list of fileIDs vs file prefix w/ sizes
		cpiosw		list of cpio soft switches used 
		tDirfn		compute fileID for the binary tape dir. file.
				if one is not supplied. ex: yy_wka.01
		cdidxpos	index position for "cd" commands
		tapeName	derived tapeName "yy_wka.01-0.043
		
	General Notes on TapDir file:
		Header: size of file, # of logical data records, 
			date written, machine information (!version),
			Reformatter ver #,
			Tape # & Name, start date of data,
			Last date of data, # of tailing files following
			the cpio archives, spare byte array.

		Logical data records:
			fileId       	bytarr(11)???
			cpio_h_size     byte
			ada file size	(0 bytes indicates file does 
			bda file size    not exist)
			cba file size	Long ....
			hda file size
			sfr file size
			spr file size
			wda file size
			sp1 spare #1
			sp2 spare #2
			sp3 spare #3
 CALLS: ***
	FndDur, GetObsID, Load_recs, PREFIXCK, TAPDIR2, cktapdir, fndrids, load_hd, mkdirst
	wrttapdir
	HISTORY:
		written by GAL, 5-sep-91
		23-Sep-91, debug and integration with UNIX and 
			the real world...
		23-Oct-91, changed tape dir fileName to be:
				yy_wkd.a	"d" for directory.
		24-Oct-91, changed the tape-directory-header section
			to include # files following cpio archive and
			spare byte array.
		10-Feb-92, added feature for data within multiple 
			directories.
		17-Feb-92, added feature for weekly files (obs,...)
		18-Feb-92, updated filename for tape dir. files
		19-Feb-92, updated for bunch of changes
		24-Feb-92, update to read old tape-dir files and compute
			version # for the new tape-dir file.
		5-Mar-92, add alldata flag
		17-Apr-92, add weekDir 
		 6-Nov-92 (MDM) - Added file remove before OPENW
		11-jun-93, added mktapverno to formal parameter list.


tar_size $SSW/yohkoh/gen/idl/tape/tar_size.pro
[Previous] [Next]
   Name:tar_size

   Purpose:return file name and size (in bytes)

   Input Parameters:
      filter - file filter (wildcards, etc) default to *.tar)
   Optional Keyword Parameters
      direct - string directory name
      vari - structure is variable size vector of structures and file
	      name field is character type - otherwise, force fixed and
      template - if set, only empty structures returned
      mktapverno - has the mktap version #
 CALLS: ***
	MAKE_STR [1], MAKE_STR [2], mktapver
 CALLED BY:
	Rd_TapDir, mktap, rd_dsktapdir
   History: slf, 11/20/91 for yohkoh tape 
		3-Mar-92 , added mktapverno keyword and increased bytarr 
		from 50 to 70, gal
		21-May-92	- Change /ys to $ys
               11-May-93	- compreesed tar changes
		11-jun-93	- change max number of tar files to 40
				and dum print statement.
	         4-Jul-94	- made quieter


target [2] $SSW/yohkoh/ucon/idl/mcallister/target.pro
[Previous] [Next]
 NAME: target

 PURPOSE: formulate the target info (centroid and radius) for use
	 with various routines.

 METHOD:  test for index and then call genloc


 CALLING SEQUENCE: trgt=target(image[,index][,/rough])


 PARAMETERS: 	image  	is the image you want the target variables for
		index   Index in case its an SXT image

 KEYWORDS: 	rough 	for use with sxt images, makes it much
			faster, only slightly less accurate
		inter   do the fit interactively

 CALLED BY:
	ar_prep, background, darklimb_correct, gbo_rot_t, rd_lonlat, rect_rot, rm_darklimb
	rt_hdha, rt_mag, rt_nkr, set_back, wl_process
 RESTRICTIONS:   assumes the target is round. 

 CALLS: GENLOC
	RETURN TYPE:  FLOAT
 HISTORY: Drafted by A. McAllister Feb. 1993
	   Added INTER pass-through, AMcA, Apr. 1994                            
          S.L. Freeland - changed return statement syntax


TASK_OS $SSW/yohkoh/bcs/idl/util/task_os.pro
[Previous] [Next]
 NAME:
	TASK_OS
 PURPOSE:
	Converts F77 "task" name into system dependant name
 CALLING SEQUENCE:  
	newname = TASK_OS(name)
 INPUTS:
	name		name of the F77 task
 OUTPUTS:
	newname		name with a postfix 
			(e.g. on Sun bsdcal => bsdcal_s)
 CALLED BY:
	FLARE_POS
 RESTRICTIONS:

 PROCEDURE:
	Uses !version.os to determine operating system
 MODIFICATION HISTORY:
	RDB  02-Jul-92	Written
	RDB  17-Jul-92	Changed MIPS suffix to _m
	RDB  11-Feb-94  Added OSF (_o) and vms on Alpha (_a)


tbb_info [2] $SSW/yohkoh/gen/idl/util/tbb_info.pro
[Previous] [Next]
   Name: tbb_info

   Purpose: team bb information

   Calling Sequence:
      tbb_info,'name',/address

 CALLS: ***
	CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], MORE [1], MORE [2], concat_dir [4]
	rd_tfile [1], rd_tfile [2], wc_where [1], wc_where [2]
   History:
      24-Feb-1994


tbeep [3] $SSW/yohkoh/ucon/idl/mctiernan/you_really_want_a_tbeep.pro
[Previous] [Next]
   Name: tbeep

   Purpose: beep terminal

   Input Paramters:
      nbeeps - number of beeps (defalut=1)
      ibwait - inter-beep wait

   Keyword Parameters:
      waitn  - inter-beep wait (can be positional too)

   History - slf, 2-Sep-92 (couldnt rembember existing one)
             jmm, 2-dec-95, turned it off
             jmm, 13-feb-96, changed it's name, turned it back on
 CALLS: ***
	YOU_REALLY_WANT_A_TBEEP
 CALLED BY:
	ACOPY [1], CH_XMENU_SEL, COVER_PAGE [1], COVER_PAGE [2], DPE_GUESS
	FIX_OLD_ATT [1], FIX_OLD_ATT [2], GET_SUNCENTER [1], GET_SUNCENTER [2], HXT_EFF
	PICK_CAN_PRELIM, RD_HXT_DBOOK, ROT, STEPPER [3], STEPPER [4], SXT_PREP0, SXT_TE
	SXT_TEEM [1], SXT_TEEM [2], SXT_TEEM1 [1], SXT_TEEM1 [2], SXT_TEEM1 [3]
	SXT_TEEM2 [1], SXT_TEEM2 [2], SXT_TEEM2 [3], UNIX_CMD [1], UNIX_CMD [2]
	WL_CUBE_II, XMENU_SEL [1], XMENU_SEL [2], azimuth_avg, cancel_dsn
	check_compile [1], check_compile [2], check_log [1], check_log [2], collexc [1]
	collexc [2], cont2time [1], cont2time [2], cube_edit, daily_forecast [2]
	dark_sub [1], dark_sub [2], dark_sub [3], dbase2disk, delete_week [1]
	delete_week [2], do_demo [1], do_demo [2], dont_use_this [1], dont_use_this [2]
	dummy [10], dummy [11], dummy [12], dummy [13], dummy [14], dummy [1], dummy [2]
	dummy [3], dummy [4], dummy [5], dummy [6], dummy [7], dummy [8], dummy [9]
	eit_getobs, evt_demo, evt_grid, file_compress [1], file_compress [2]
	file_uncompress [1], file_uncompress [2], first_bcs, first_over, fitstap2tap [1]
	fitstap2tap [2], flares2disk, fort2hxi [1], fort2hxi [2], ftp_copy2sites
	genx_newver [1], genx_newver [2], get_last_tfr, get_sfc_info, get_utevent [1]
	get_utevent [2], goes_plot [1], goes_plot [2], goes_plot [3], goes_plot [4]
	goes_plot [5], gt_day [1], gt_day [2], gt_expdur [1], gt_expdur [2], gt_time [1]
	gt_time [2], gtt_info, hardcopy [1], hardcopy [2], hxt_survey, is_alive [1]
	is_alive [2], jitter_gif_xyimg, lcur_image, mdi_display, mk_mdi_load, mk_pix [1]
	mk_pix [2], mk_sdm, mk_sfc [1], mk_sfc [2], mk_trace_i0, mk_vcr, mk_week_file [1]
	mk_week_file [2], mo_check, mo_init [1], mo_init [2], mo_patch, mo_prep, mod_res
	nobeyama_update, ocontour [1], ocontour [2], ocontour [5], op_pass_sheets [1]
	op_pass_sheets [2], op_same_time [1], op_same_time [2], op_times, pass_sheets
	plot_eit_flux, pointing, pr_visible, pref_super, radial_avg, rd_atodat [1]
	rd_atodat [2], rd_old_obs, rd_tr_seq_head, rd_trace_i0 [1], rd_ydbtap, res_freq
	run_dsnfil, sector_avg, sel_dc_image [1], sel_dc_image [2], sel_dc_image [3]
	set_printer [1], set_printer [2], set_printer [5], sft2sfc, show_contacts
	show_pixf, sonyloop [1], sonyloop [2], soon_search [1], soon_search [3]
	sxt_cen [1], sxt_cen [2], sxt_decon [1], sxt_decon [2], sxt_dn_unc, sxt_eff_area
	sxt_etemp, sxt_flux [1], sxt_flux [2], sxt_flux [3], sxt_interp [1]
	sxt_interp [2], sxt_mwave, sxt_prep [1], sxt_prep [2], sxt_prep [3], sxt_sumtime
	sxt_sumxy, sxt_vignette, sxt_xsaa, tim2dbase, tim2pass, timeavg [1], timeavg [2]
	timeline, topsdb [1], topsdb [2], tr_build_img [1], ut_time [1], ut_time [2]
	video_menu, web_seq, where_change [1], where_change [2], where_pattern [1]
	where_pattern [2], xcheckip, xdisp_fits, xdisp_sci5k, xdisp_tfr, xdisp_trace [1]
	xdisp_trace2, xdisp_trace3, xhkplot, xread_hist, xsearch_obs, xset_chain [1]
	xset_chain [2], xso_butevents [1], xso_butevents [2], xso_search, xspr [1]
	xspr [2], xsw2tree, xsw2tree_event, xswlist [2], xsxt_prep, xsxt_prep_event
	ydb_install [1], ydb_install [2], yoyo_man2, zcurs_ok
   Restrictions:
      if ibwait is less then .15, not all beeps are visible


teambb [2] $SSW/yohkoh/gen/idl/util/teambb.pro
[Previous] [Next]
 NAME:
   teambb
 PURPOSE:
   Display items from the teambb

 CALLS: ***
	ADD, BAN, BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CDIR, CHECK_TREE, CLEAR
	CLEAR_SCREEN [1], CLEAR_SCREEN [2], ET_TOPIC, ET_TOPIC_NOLIST, INTER_STIR
	MORE [1], MORE [2], MORE_TBB, NEWS, OLD, PRINT_AST, QUIT_TEAM_BB, SCI, SCI_CL, SCI_EA
	SCI_ET, SCI_EV, SCI_SU, SCI_TH, SCI_UW, SETLOG, SET_TREE, SPACE_RETURN, SU_NOLIST
	TBB_HELP, break_file [4], rd_tfile [1], rd_tfile [2], scratch [1], scratch [2]
	str_replace [1], str_replace [2], yesnox [1], yesnox [2]
 Note: needs logical or environment variable DIR_GEN_TBB defined.

 CALLING SEQUENCE:
   teambb
   teambb,'add'	; Access member addresses
   teambb,'sci'	; Access the science menu
 INPUTS:
   command	= The entry top level menu item
 MODIFICATION HISTORY:
   D.M. fecit, 9 December, 1993. Version A.0.3.
   11-dec-93, J. R. Lemen, V A.0.4 Changed to a procedure;
		            write temporary files to user's home directory
   13-dec-93, JRL,  V A.0.5 Changed directory name strategy; Fixed some bugs
   14-dec-93, DMZ,  V A.0.6 Changed DIR_GEN_TBB to $DIR_GEN_TBB
   10-feb-94, JRL,  V A.0.7 Deleted the trailing '\' in inter_stir. Save the
			     entry directory to return there on exiting.  
			     Renamed "more" procedure to more_tbb.
			     Renamed file_list variables to file_list_t
   17-feb-94, JRL,  V A.0.8 Call clear_screen if VMS
   13-oct-94, NN,   V A.0.81 Add 'mi' in the author search
   13-feb-95, JRL,  V A.0.9 Added access to completed items.  Changed code
 			     to use break_file so that items are correctly
			     listed on an VMS system

   28-apr-95, SLF,  	     Add SCI_EV procedure


TEEM_BIT $SSW/yohkoh/ucon/idl/hudson/teem_bit.pro
[Previous] [Next]
 NAME:
     TEEM_BIT
 PURPOSE:
     Sample an SXT image pair for temperatures
 CATEGORY:
     Yohkoh
 CALLING SEQUENCE:
     teem_bit, ii, dd, i1, i2, nn
 INPUTS:
     index and data
     i1, i2 to identify the image pair in (ii, dd)
     nn the number of samples taken
 OPTIONAL (KEYWORD) INPUT PARAMETERS:
 OUTPUTS:
     print to screen - sample location, temperature
 CALLS: ***
	SXT_TEEM [1], SXT_TEEM [2]
 COMMON BLOCKS:
 SIDE EFFECTS:
 RESTRICTIONS:
     this is very preliminary, quite cumbersome for getting
       properly set up with adjacent image pairs. Perhaps
       GO_TEEM does this kind of thing better!
 MODIFICATION HISTORY:
     HSH, written 13-apr-95


TEK [3] $SSW/yohkoh/bcs/idl/util/tek.pro
[Previous] [Next]
 NAME:
	TEK
 PURPOSE:
    	Writes an escape sequence to switch Tek displays to graphics
 CALLING SEQUENCE:  
	TEK
 INPUTS:
	none
 OUTPUTS:
	none
 CALLS: ***
	SETPLOT [1], SETPLOT [2]
 RESTRICTIONS:

 PROCEDURE:

 MODIFICATION HISTORY:
	JP	1991
	RDB	1991	Only issues escape sequence if !d.name='TEK'


TEMP_CUBE $SSW/yohkoh/ucon/idl/wuelser/temp_cube.pro
[Previous] [Next]
 NAME:
        TEMP_CUBE
 PURPOSE:
        Reads a sequence of FITS 3-D images into a 4-D array.
        Options: extract subarray of 3-D image, rebin (sub)array,
                 extract any channels in x (MCCD data: x = wavelength)
 CALLING SEQUENCE:
        array = temp_cube(file,from,count)
        array = temp_cube(file,ivect)
 INPUTS:
        file = string containing the file name without the extension ".i"
        from = index number of the first file (extension .from)
        count = number of frames in movie.  Corresponds to number of files
                being read.  The file numbers must be contiguous.
        ivect = vector.  index numbers of files to be read.
                Enables reading of non-contiguous file numbers.
 OUTPUTS:
        array = 4-D array of extracted data.
 KEYWORDS (INPUT):
        xrange = 2-element vector. size of subarray in x ("subscript range").
        yrange = 2-element vector. size of subarray in y.
        zrange = 2-element vector. size of subarray in z.
        xvect = vector of pixel indices in x ("subscript array").
                xrange is ignored if xvect is present.
        xbin = data rebinned to xbin pixels in x. 
               xbin must be integral factor of number of pixels in x.
        ybin = data rebinned to ybin pixels in y.  Same restrictions as xbin.
        zbin = data rebinned to zbin pixels in z.  Same restrictions as xbin.
 KEYWORDS (OUTPUT):
        time = string vector with the time for each frame.
        outheader = string vector.  Description of the movie, each line
                    (string element) starting with HISTORY.  Can be added
                    to a FITS header in wfits.
 CALLS: ***
	RFITS [1], RFITS [2], RFITS [3]
 COMMON BLOCKS:
        None.
 SIDE EFFECTS:
 RESTRICTIONS:
 PROCEDURE:
 MODIFICATION HISTORY:
        JPW, Feb. 1992
        JPW, Feb. 1993 added ivect option
        JPW, Nov. 1993 made this version to work with old rfits


TERM_ATT_CHECK $SSW/yohkoh/ucon/idl/hudson/term_att_check.pro
[Previous] [Next]
 NAME:
     TERM_ATT_CHECK
 PURPOSE:
 CATEGORY:
 CALLING SEQUENCE:
     .run 
 INPUTS:
 OPTIONAL (KEYWORD) INPUT PARAMETERS:
 OUTPUTS:
     bad_uns is a list of SFCs with bad attitudes
 COMMON BLOCKS:
 SIDE EFFECTS:
     grabs IDL 0
 RESTRICTIONS:
 MODIFICATION HISTORY:
     24-Jan-98, HSH written


TERM_FIDS $SSW/yohkoh/ucon/idl/sxt_co/term_fids.pro
[Previous] [Next]
 NAME:
     TERM_FIDS
 PURPOSE:
     show where the SFC's are relative to the HXA fiducial marks
 CATEGORY:
 CALLING SEQUENCE:
     term_fids
 INPUTS:
 OPTIONAL (KEYWORD) INPUT PARAMETERS:
 ROUTINES:
     calls JPW's program SHOW_HXAFID
 CALLS: ***
	FILE2TIME, Rd_Roadmap [2], file_list [1], file_list [2], rd_roadmap [1]
	show_hxafid, sxt_cen [1], sxt_cen [2], tim2dset [1], tim2dset [2]
 SIDE EFFECTS:
     makes a plot
 RESTRICTIONS:
 MODIFICATION HISTORY:
     25-Sep-98, written (HSH)
      5-Jul-99, replaced FINDFILE (HSH)
     19-Apr-00, hacked file-finding again (HSH)


TERM_IMAGE_ID $SSW/yohkoh/ucon/idl/hudson/term_image_id.pro
[Previous] [Next]
 NAME:
	TERM_IMAGE_ID
 PURPOSE:
 	Strip out table information on FFI#2 1-1 and 2-1 (terminator slots)	
 CATEGORY:
	Yohkoh
 CALLING SEQUENCE:
	term_image_id,index,seq_11,seq_21
 INPUTS:
	index
 OUTPUTS:
	strings containing table info
 CALLS: ***
	gtab_ffi
 MODIFICATION HISTORY:
	HSH< written 24-Dec093


TERM_LIST $SSW/yohkoh/ucon/idl/hudson/term_list.pro
[Previous] [Next]
 NAME:
     TERM_LIST
 PURPOSE:
     list the scheduled terminator image times
 CATEGORY:
     Yohkoh
 CALLING SEQUENCE:
     term_list
 INPUTS:
 OPTIONAL (KEYWORD) INPUT PARAMETERS:
 OUTPUTS:
 COMMON BLOCKS:
 SIDE EFFECTS:
 RESTRICTIONS:
 MODIFICATION HISTORY:
     HSH, written 22-Mar-95


term_obs $SSW/yohkoh/ucon/idl/labonte/term_obs.pro
[Previous] [Next]

 Returns the Observing Log information for SXT terminator images.


PRO term_obs, weekid, sxtf, time2set, suncent


 INPUT PARAMETERS:
	week_id = year and week number, string, e.g. '94_12'

 OUTPUT PARAMETERS:
	sxtf = FFI observing log structure for all valid terminators
		during the specified week.
	time2set = time in seconds,  image time minus sunset time.
	suncent = sun center position in SXT Full resolution pixels,
		dimensioned 2 x n.


 PROCEDURES CALLED:
	TERM_TIMES, TIM2ORBIT, GET_SUNCENTER

 CALLS: ***
	GET_SUNCENTER [1], GET_SUNCENTER [2], anytim2ints [1], anytim2ints [2], rd_obs
	str_concat [1], str_concat [2], term_times, tim2orbit [1], tim2orbit [2]
 HISTORY:
	Written June 7, 1994  Barry LaBonte
	Add sun center positions  June 10, 1994  BJL


TERM_QUICK $SSW/yohkoh/ucon/idl/sxt_co/term_quick.pro
[Previous] [Next]
 NAME:
    TERM_QUICK
 PURPOSE:
    Show the SFC pointing locations graphically for a specific
      time range. This program feeds information to QUICK.HTML.
      To monitor the OP functions of the terminator acquisition,
      use OP_TERM_SCORE
 CATEGORY:
 CALLING SEQUENCE:
 INPUTS:
 OPTIONAL (KEYWORD) INPUT PARAMETERS:
    radius, makes a plot of apparent solar radius at each 
      terminator time
    list, makes a list of SFC filter positions
    tstart, start time (default currently 11-Feb-00)
    tstop, stop time (default !stime)
 ROUTINES CALLED
    FINDFILE, GT_FILTA, GT_FILTB, RD_ROADMAP, !stime, TIM2DSET
 OUTPUTS:
 CALLS: ***
	ARROW, CLEAR_UTPLOT [1], CLEAR_UTPLOT [2], FILE2TIME, OUTPLOT [1], OUTPLOT [2]
	OUTPLOT [3], PAUSE [1], RD_SDA [1], RD_SDA [2], RD_SDA [3], Rd_Roadmap [2], STDEV
	THINAL_INDEX, UTPLOT [1], UTPLOT [2], UTPLOT [3], UTPLOT [4], UTPLOT [5], UTPLOT [6]
	WDEF [1], WDEF [2], clearplot [1], clearplot [2], file_list [1], file_list [2]
	get_rb0p [1], get_rb0p [2], gt_filta, gt_filtb, gt_pix_size, lastsfd [1]
	lastsfd [2], pause [2], plottime [1], plottime [2], rd_roadmap [1], sxt_cen [1]
	sxt_cen [2], tim2dset [1], tim2dset [2]
 COMMON BLOCKS:
 SIDE EFFECTS:
    LINECOLORS
 RESTRICTIONS:
 MODIFICATION HISTORY:
    HSH, written 5-Jul-99 based on TERM_REVIEW_GIF
    11-Jul-99, /list added (HSH)
    16-Jul-99, plottime + charsize=1.25 (BNH)
    19-Jul-99, fixed bug (HSH) and added /stats
    14-Aug-99, adjusted range and title of plot (HSH)
    14-Feb-00, revised according to new normal pointing (HSH)
    19-Aug-99, adjusted plot (HSH)
    12-jan-00, y2k fix
    12-feb-00, update plot range (HSH)
     6-mar-00, update plot range (HSH)
    14-apr-00, update (HSH)


TERM_REVIEW $SSW/yohkoh/ucon/idl/hudson/term_review.pro
[Previous] [Next]
 NAME:
    TERM_REVIEW
 PURPOSE:
    Show the SFC pointing locations graphically for a specific
      time range. Specific for terminators since rupture #4.
 CATEGORY:
 CALLING SEQUENCE:
    term_review
    term_review,filcon1,filcon2
    term_review, tstart, tstop, sfc_rm = sfc_rm, /q
    term_review,rm_sft=rm_sft,rm_sfc=rm_sfc,xy_sfc=xy_sfc,xy_sft=xy_sft,/wide
      (this gives you the works)
 INPUTS:
    filcon1, filcon2, Numerical format for filter configurations to 
	plot:   21=Al.1/Open	26=Al.1/NuDen
		31=AlMg/Open	36=AlMg/NuDen
		41=Be/Open	46=Be/NuDen
		51=Al12/Open	56=Al12/NuDen
		61=Mg/Open	66=Mg/NuDen
	defaults to filcon1=21, filcon2=31 (If choose only one, it
	will still plot two configurations..DEM)
 OPTIONAL (KEYWORD) INPUT PARAMETERS:
    tstart, tstop, any format (defaults to the current interval,
      ie from rupture #3 to the present)
    wide => displays the extended EW range needed to see the offpoints
    rm_sfc, rm_sft, xy_sft, xy_sfc send back info 
    compare => plot showing core distributions of SFM and SFC images
    qstop
    set => offpoint information for re-setting OG 32
 ROUTINES CALLED
    FINDFILE, GT_FILTA, GT_FILTB, RD_ROADMAP, !stime
 OUTPUTS:
    rm_sfc and rm_sft, the roadmap files for the selected SFC(SFT) entries 
 CALLS: ***
	ARROW, CLEAR_UTPLOT [1], CLEAR_UTPLOT [2], FMT_TIMER [1], FMT_TIMER [2]
	OUTPLOT [1], OUTPLOT [2], OUTPLOT [3], PAUSE [1], RD_SDA [1], RD_SDA [2], RD_SDA [3]
	Rd_Roadmap [2], THINAL_INDEX, UTPLOT [1], UTPLOT [2], UTPLOT [3], UTPLOT [4]
	UTPLOT [5], UTPLOT [6], WDEF [1], WDEF [2], clearplot [1], clearplot [2]
	file_list [1], file_list [2], fmt_tim [1], fmt_tim [2], gt_filta, gt_filtb
	gt_pix_size, lastsfd [1], lastsfd [2], linecolors [1], linecolors [2], pause [2]
	rd_roadmap [1], sxt_cen [1], sxt_cen [2], tim2dset [1], tim2dset [2]
 COMMON BLOCKS:
 SIDE EFFECTS:
 RESTRICTIONS:
    Grabs IDL 0 and graphs the (x,y) coordinates of the SFC's from the
      two soft filters
 MODIFICATION HISTORY:
    HSH, written 24-aug-96 - one day before rupture!
    HSH, added some stuff 30-aug-96
    HSH, looked things over 18-sep-96
    HSH, removed hard-wired directories and enlarged, 27-Nov-96
    HSH, added a table of SFC successes, 29-Nov-96
    HSH, colored the most recent point, 18-Dec-96
    HSH, added "quiet" keyword, 1-Mar-97
    HSH, added xy outputs and /plot, 28-Mar-97
    HSH, made the default plot better for monitoring NS drift. /wide
         now gives the whole offpointing EW range.
    HSH, switched to index.his to get sxt_cen values (Sam's suggestion), 
         16-May-97
    HSH, fixed to work with TEK graphics, 1-jun-97
    HSH, added /compare 18-jul-97
    HSH, added /set 14-aug-97
    DEM, added options of plotting different filters, 19-oct-97
    HSH, changed /compare to look at current SFD's, 23-oct-97
    HSH, routine pointing update 30-Oct-97
    HSH, repaired /compare and /set functions 22-Dec-97
    HSH, routine pointing update 24-Dec-97 (last entry like this!)
    HSH, updated for rupture #4 4-Feb-98 (default tstart = 24-Jan-98)
    DMcK, colored SFD points in /comp for better visibility, and
	  cleaned up textual output related to addition of 19-oct-97,
	  29-jan-99.
    HSH, replaced FIND_FILE with FILE_LIST, 21-Jun-99


TERM_REVIEW_GIF $SSW/yohkoh/ucon/idl/sxt_co/term_review_gif.pro
[Previous] [Next]
 NAME:
    TERM_REVIEW_GIF
 PURPOSE:
    Show the SFC pointing locations graphically for a specific
      time range. Specific for terminators since rupture #4.
      Dumps to .gif files for QUICK survey.
 CATEGORY:
 CALLING SEQUENCE:
    term_review
    term_review,filcon1,filcon2
    term_review, tstart, tstop, sfc_rm = sfc_rm, /q
    term_review,rm_sft=rm_sft,rm_sfc=rm_sfc,xy_sfc=xy_sfc,xy_sft=xy_sft,/wide
      (this gives you the works)
 INPUTS:
    filcon1, filcon2, Numerical format for filter configurations to 
	plot:   21=Al.1/Open	26=Al.1/NuDen
		31=AlMg/Open	36=AlMg/NuDen
		41=Be/Open	46=Be/NuDen
		51=Al12/Open	56=Al12/NuDen
		61=Mg/Open	66=Mg/NuDen
	defaults to filcon1=21, filcon2=31 (If choose only one, it
	will still plot two configurations..DEM)
 OPTIONAL (KEYWORD) INPUT PARAMETERS:
    tstart, tstop, any format (defaults to the current interval,
      ie from rupture #3 to the present)
    wide => displays the extended EW range needed to see the offpoints
    rm_sfc, rm_sft, xy_sft, xy_sfc send back info 
    compare => plot showing core distributions of SFM and SFC images
    qstop
    set => offpoint information for re-setting OG 32
 ROUTINES CALLED
    FINDFILE, GT_FILTA, GT_FILTB, RD_ROADMAP, !stime
 OUTPUTS:
    rm_sfc and rm_sft, the roadmap files for the selected SFC(SFT) entries 
 CALLS: ***
	ARROW, CLEAR_UTPLOT [1], CLEAR_UTPLOT [2], CONGRID [1], CONGRID [2], CONGRID [3]
	FMT_TIMER [1], FMT_TIMER [2], OUTPLOT [1], OUTPLOT [2], OUTPLOT [3], PAUSE [1]
	RD_SDA [1], RD_SDA [2], RD_SDA [3], Rd_Roadmap [2], THINAL_INDEX, UTPLOT [1]
	UTPLOT [2], UTPLOT [3], UTPLOT [4], UTPLOT [5], UTPLOT [6], WDEF [1], WDEF [2]
	WRITE_GIF, clearplot [1], clearplot [2], fmt_tim [1], fmt_tim [2], gt_filta
	gt_filtb, gt_pix_size, lastsfd [1], lastsfd [2], linecolors [1], linecolors [2]
	pause [2], plottime [1], plottime [2], rd_roadmap [1], sxt_cen [1], sxt_cen [2]
	tim2dset [1], tim2dset [2]
 COMMON BLOCKS:
 SIDE EFFECTS:
 RESTRICTIONS:
    Grabs IDL 0 and graphs the (x,y) coordinates of the SFC's from the
      two soft filters
 MODIFICATION HISTORY:
    HSH, written 24-aug-96 - one day before rupture!
    HSH, added some stuff 30-aug-96
    HSH, looked things over 18-sep-96
    HSH, removed hard-wired directories and enlarged, 27-Nov-96
    HSH, added a table of SFC successes, 29-Nov-96
    HSH, colored the most recent point, 18-Dec-96
    HSH, added "quiet" keyword, 1-Mar-97
    HSH, added xy outputs and /plot, 28-Mar-97
    HSH, made the default plot better for monitoring NS drift. /wide
         now gives the whole offpointing EW range.
    HSH, switched to index.his to get sxt_cen values (Sam's suggestion), 
         16-May-97
    HSH, fixed to work with TEK graphics, 1-jun-97
    HSH, added /compare 18-jul-97
    HSH, added /set 14-aug-97
    DEM, added options of plotting different filters, 19-oct-97
    HSH, changed /compare to look at current SFD's, 23-oct-97
    HSH, routine pointing update 30-Oct-97
    HSH, repaired /compare and /set functions 22-Dec-97
    HSH, routine pointing update 24-Dec-97 (last entry like this!)
    HSH, updated for rupture #4 4-Feb-98 (default tstart = 24-Jan-98)
    HSH, specified .gif output files
    DMcK, added PLOTTIME to output 6-jan-99.
    DMcK, colored SFD points in /comp for better visibility, and
         cleaned up textual output related to addition of 19-oct-97,
         08-feb-99.


TERM_SCORE $SSW/yohkoh/ucon/idl/hudson/term_score.pro
[Previous] [Next]
 NAME:
	TERM_SCORE
 PURPOSE:
	to find terminator images and assess the success rate 

 first part of a reporting program for terminator exposures
 as of 12/24, we're happily doing scheduled terminators as 
 reported by term_times. Now, on to accidentals!

 CATEGORY:
	Yohkoh
 CALLING SEQUENCE:
	main program
 INPUTS:
	week = week number
 OPTIONAL (KEYWORD) INPUT PARAMETERS:
 OUTPUTS:
	results
 COMMON BLOCKS:
 SIDE EFFECTS:
 RESTRICTIONS:
 MODIFICATION HISTORY:
	HSH, written 24-Dec-93


term_score2 $SSW/yohkoh/ucon/idl/sxt_co/term_score2.pro
[Previous] [Next]
 NAME:
  	term_score2
 PURPOSE:
  1.  Collect SFT and SXTF data from database.
  2.  Prepare a window with data coordinates so that plot2offset can be run.
  3.  Enable flexible plotting of SFT locations on top of SXTF locations.
 CALLING SEQUENCE
	term_score2,sft_file=sft_file,sxtf_file=sxtf_file,nusft=nusft, $
             st_date, en_date, filta=filta, filtb=filtb
 KEYWORD INPUT
	sxtf_file, string with name of sxtf save file.
 OPTIONAL KEYWORD INPUT
       sft_file, string with name of sft save file,
               e,g, 'complete_sft_list_950521.sav'
       nusft, /nusft will cause the sft data to be read 
		from $DIR_SXT_SFT
	filta, filtb - SXTF filter pair of interest
       filta = number of filter A
                 1   Open       Op
                 2   NaBan      NB
                 3   Quart      Qz
                 4   Diffu      Df
                 5   WdBan      WB
                 6   NuDen      ND
       filtb = number of filter B
                 1   Open       Op
                 2   Al.1       A1
                 3   AlMg       AM
                 4   Be119      Be
                 5   Al12       A2
                 6   Mg3        Mg
 CALLS: ***
	WDEF [1], WDEF [2], filter_combo, input [1], input [2], lastsfd [1], lastsfd [2]
	linecolors [1], linecolors [2], plot2offset [1], plot2offset [2], pr_sxt_term
	restgen [1], restgen [2], sxt_cen [1], sxt_cen [2], yesnox [1], yesnox [2]
	  NOTE:  SFT filters are interactively
		 selected during running of the program.
	blowup, array to specify expanded region, blowup=[x0,x1,y0,y1]
               default:  blowup=[0,1023,0,1023]
 OPTIONAL INPUT
	st_date, en_date - beginning and ending dates for collecting 
		sft files from $DIR_SXT_SFT.  Defaults:
		st_date = '15-nov-92'
		en_date = !stime
 OPTIONAL KEYWORD OUTPUT
	out, array of Yohkoh Euler angles for offpoints.
 RESTRICTIONS
	sxtf_file and sft_file must be genx files prepared with get_points.pro.
 PROGRAMS CALLED
	restgen, pr_sxt_term, filter_combo, wdef, lastsfd, sxt_cen,
	plot2offset, linecolors
 HISTORY
	Checkered history, i.e.,
  This is a tremendous kluge of a program.  I don't
  take full responsiblity since I think Acton and Weber
  desire some of the blame.

	5/16/95 LWA, Changed plot3offset back to plot2offset.
		     Moved all software and data to 
		     /0p/sxt_co/terminator/analysis.
       5/25/95 LWA, Total rewrite of this "tremendous kluge of a program."
	11/7/95 LWA, Corrected minor error in header.
	11/11/95 LWA, Added blowup keyword.
	11/17/95 LWA, Added PROGRAMS CALLED to header
	12/08/95 LWA, Clarified filter selection in header.
		      Altered hardwire st_date & Al.1 tim2night.


term_times $SSW/yohkoh/gen/idl/orbit/term_times.pro
[Previous] [Next]
   Name: term_times

   Purpose: return times of planned terminator images
            optionally generate terminator log file

   Input Parameters:
      startt - (optional) first image cutoff
      stopt  - (optional) last image cutoff

   Keyword Parameters:
      log    -     (in)   switch, if set generate or append to existing log fi$
      full   -     (in)   switch, if set, return full records
      type   -     (in)   switch, if set, type full terminator records to screen
      one_page     (in)   switch, if set, type only last 15 entries
      weekid -     (in)   images for specified week
			      string of form 'yy_ww' or integer week (uses current year)
      term_recs - (out)   full records from log file
      uniqt  -     (in)   if set, only uniq times (within 64 seconds)

   Calling Sequence:
      times = term_times()     ; read existing log (makes new if non  exists)
      times = term_times(/log) ; search opog, update log (append uniq records)
      times = term_times(start,stop,/type)      ; images in range and display full records
      times = term_times(weekid='yy_ww')        ; images for week

   Calling Examples:
      times = term_times(week=43,/type)         ; times for week 43 and display full records
      times = anytim2ints(term_times,week=44)   ; convert to internal format

 CALLS: ***
	FILE_EXIST [2], STR2ARR [1], STR2ARR [2], UNIQ [1], UNIQ [2], UNIQ [3]
	anytim2ex [1], anytim2ex [2], anytim2ints [1], anytim2ints [2], curdir [1]
	curdir [2], file_append [1], file_append [2], file_exist [1], file_exist [3]
	fmt_tim [1], fmt_tim [2], get_logenv [1], get_logenv [2], int2secarr [1]
	int2secarr [2], prstr [1], prstr [2], rd_tfile [1], rd_tfile [2], sel_timrange [1]
	sel_timrange [2], week2ex [1], week2ex [2]
 CALLED BY:
	FIRST_LIGHT [1], FIRST_LIGHT [2], ref_term [2], term_obs
   History:
      30-Oct-1993 (SLF)
      31-Oct-1993 (SLF)  minor mods, add full keyword
      16-Apr-1993 (HSH)  added one_page keyword
      12-jan-1996 (SLF)  add UNIQT switch (uniq term times within 64 secs)


termlite $SSW/yohkoh/ucon/idl/acton/termlite.pro
[Previous] [Next]
 NAME:
	termlite
 PURPOSE
	To prepare a vector of signals in terminator images and
	return that data and the corresponding index structures.
 PROCEDURE
  1.  SFT files from infil are read and processed in sequence.
  2.  A where statement is used to select images based upon parameters
	given in rgn,filta,filtb,dpe.
  3.  Dark sub is run on the data array.
  4.  Total signal is computed.
  5.  Index structures and signals are accumulated.
  6.  When infil is complete index and signals are time-ordered and
	duplicates are removed.
 CALLING SEQUENCE
	termlite,infil,rgn,filta,filtb,dpe,index,signals
 INPUT
	infil - array of SFT files to use.
	rgn   - output of sxt_cen(roadmap(ss),/cmd) for the pointings
		you want, select with plot_fov,roadmap,sel,ss.
	filta, filtb - gt_filta/b numbers for the fron and back filters
	dpe - DPE value of exposure yout want
 OUTPUT
	index   - index structures of terminator images
	signals  - total DN in dark-corrected terminator images
 HISTORY
	11-May-95 Written by LWA.
 CALLS:


TEST_ATT $SSW/yohkoh/ucon/idl/hudson/test_att.pro
[Previous] [Next]
 NAME:
     TEST_ATT
 PURPOSE:
     look at ATT.PNT and SXT_CEN database information
 CATEGORY:
 CALLING SEQUENCE:
     test_att, infil
 INPUTS:
     infil, the files you want to look at (spr's)
 OPTIONAL (KEYWORD) INPUT PARAMETERS:
 OUTPUTS:
 CALLS: ***
	CLEAR_UTPLOT [1], CLEAR_UTPLOT [2], FMT_TIMER [1], FMT_TIMER [2], Rd_Roadmap [2]
	UTPLOT [1], UTPLOT [2], UTPLOT [3], UTPLOT [4], UTPLOT [5], UTPLOT [6]
	clearplot [1], clearplot [2], fem_grid [1], fem_grid [2], rd_att, rd_roadmap [1]
	sxt_cen [1], sxt_cen [2]
 COMMON BLOCKS:
 SIDE EFFECTS:
     makes a plot
 RESTRICTIONS:
 MODIFICATION HISTORY:
     HSH, written 14-jun-97


test_integer $SSW/yohkoh/ucon/idl/lemen/test_integer.pro
[Previous] [Next]
 NAME:
  test_integer
 PURPOSE:
   Test a string to see if it is a valid integer 
 CALLING STATEMENT:
   result = test_integer( string_variable )

   test_integer('32')   will return 1
   test_integer('32b')  will return 0
   test_integer('3 21') will return 0
   test_integer('a321') will return 0

 INPUTS:
   string_variable	= Must be a scalar string
 RETURNS:
   1 if input can be converted to an integer 
   0 if input CANNOT be converted to an integer
   1 if the input variable is not a string

 MODIFICATION HISTORY:
   12-may-95, J. R. Lemen (LPARL), Written.


TEST_OUTG $SSW/yohkoh/ucon/idl/hiraoka/test_outg.pro
[Previous] [Next]

 NAME:
       TEST_OUTG
 PURPOSE:
       To write WBS grs_phl spectrum data on the text file for spfd. 
 CALLING SEQUENCE:
       test_outg,index,data,ph=1,fltime=fltime,bgtime=bgtime
       test_outg,index,data,ph=2,/disp
 INPUT:
       index - Wbs index structure from reformat data.
       data  - Wbs data structure from reformat data.
       ph    - Detector number of wbs grs_phl 
       fltime - Flare time. for example, fltime = ['22:37 11-NOV-91',
                '22:38:32.114 11-NOV-91']
       bgtime - Background time.
       disp - If set, you can select the data on display by mouse.
         ( If you do not select the background data, no background-
           subtracted data are written. )
 OPTIONAL INPUT:
       int   - Integration time of flare data. For example, int = 4 then
               integration time is 4 seconds. If present, fltime is divided
               by int.
       pname - String containing the name of printer.
               if not present, the printer name is 'lp'.
       sav   - If set, the flare time and background time are saved in
               'flbktime.dat' file.
       fn    - String containing the name of output file. If not present,
               fn is 'GRS_SPECTRUM.DATA'
 CALLS: ***
	OUT_GRSPHL1, OUT_GRSPHL2, SPPLOT_GRS, WRITE_GRSPH, wmenu_sel [1], wmenu_sel [2]
 RESTRICTIONS:
       Flare data (fltime & bktime) are restricted to high and medium 
       bit rate data.
 HISTORY:
       Written 4-aug-93 by T.Hiraoka ( Rikkyo Univ.)
       Updated 6-aug-93 by T.Hiraoka ; added INT option.
       Updated 11-aug-93 by T.Hiraoka ; added SAV option.
       Updated 25-oct-93 by T.Hiraoka ; added plotting Counts Spectrum.
       Updated 15-nov-93 by K.Morimoto ; added get cal data.
       Updated 16-nov-93 by K.Morimoto : delete write enr-scale.
       Updated 19-nov-93 by T.Hiraoka ; added FN option.
       Updated 10-dec-93 by T.Hiraoka ; deleted cal option and separated
                                        into several subroutine.
       Updated 15-dec-93 by T.Hiraoka ; revesed for grs_phl.


TEST_OUTH $SSW/yohkoh/ucon/idl/hiraoka/test_outh.pro
[Previous] [Next]

 NAME:
       TEST_OUTH
 PURPOSE:
       To write WBS hxs_ph spectrum data on the text file for spfd. 
 CALLING SEQUENCE:
       test_outh,index,data,fltime=fltime,bgtime=bgtime
       test_outh,index,data,/disp
 INPUT:
       index - Wbs index structure from reformat data.
       data  - Wbs data structure from reformat data.
       fltime - Flare time. for example, fltime = ['22:37 11-NOV-91',
                '22:38:32.114 11-NOV-91']
       bgtime - Background time.
       disp - If set, you can select the data on display by mouse.
         ( If you do not select the background data, no background-
           subtracted data are written. )
 OPTIONAL INPUT:
       int   - Integration time of flare data. For example, int = 2 then
               integration time is 2 seconds. If present, fltime is divided
               by int.
       pname - String containing the name of printer.
               if not present, the printer name is 'lp'.
       sav   - If set, the flare time and background time are saved in
               'flbktime.dat' file.
       fn    - String containing the name of output file. If not present,
               fn is 'HXS_SPECTRUM.DATA'
 CALLS: ***
	OUT_HXSPH, SPPLOT_HXS, WRITE_HXSPH, wmenu_sel [1], wmenu_sel [2]
 RESTRICTIONS:
       Flare data (fltime & bktime) are restricted to high and medium 
       bit rate data.
 HISTORY:
       Written 4-aug-93 by T.Hiraoka ( Rikkyo Univ.)
       Updated 6-aug-93 by T.Hiraoka ; added INT option.
       Updated 11-aug-93 by T.Hiraoka ; added SAV option.
       Updated 25-oct-93 by T.Hiraoka ; added plotting Counts Spectrum.
       Updated 15-nov-93 by K.Morimoto ; added get cal data.
       Updated 16-nov-93 by K.Morimoto : delete write enr-scale.
       Updated 19-nov-93 by T.Hiraoka ; added FN option.
       Updated 10-dec-93 by T.Hiraoka ; deleted cal option and separated
                                        into several subroutine.


TEST_RD [1] $SSW/yohkoh/gen/idl/to_be_deleted/test_rd.pro
[Previous] [Next]
ROUTINE:
	TEST_RD
PURPOSE:
	Read an any of the reformatted data files
INPUT:
	This is a program and there are several questions asked.  Sample
	responses are listed below.

	The first question is the input file name.  Examples:
		menu
		many spr*			;all spr files in whole path
		menu bda920224*
		many /yd3/reformat/sfr*	
		many sfr* last			;sfr files in last dir in path
		many sfr* flares		;sfr files in flares directory
		many /yd*/*/hda920325*
		many ./wda*			;wda files in default dir
		spr*				;spr files in default dir
		time
		same bda
	The second question is for datasets to extract.  The options are listed
	there in detail.  Further questions are optionally asked depending on 
	instrument file being read and the kind of data present in it.

	It is possible to extract ground based data using TEST_RD.  If the first
	character of the input file name is "g", then it is assumbed to be GBO
	data of FITS format.  The MANY and MENU options will work for extracting
	GBO data but only if the filename portion is entered on the same line as
	MENU or MANY (ie: "many gbh*" will work, but entering "many" and then
	entering "gbh*" at the second question will not work).  Using the many
	option will only work if all images selected are the same size.  Do not
	select very many images at once since it the concatenation is not very
	efficient.
HISTORY:
	MDM	Early-1991
       JRL     Updated 18-sep-91 to create info_array
       MDM     Updated 25-Sep-91 to assemble observing regions
	MDM     Updated  1-Oct-91 to only read BCS DP_Sync if asked to
	MDM Ver 3.3 4-Oct  - Allowed SEQ_NUM selection for FFI (as well as PFI)
	MDM Ver 3.4 10-Oct - Changed default answer for "Assemble OR" question
			     to yes
			   - Also, removed GET_INFO asking if the data should
			     be written to disk
			   - Also added RD_QS for BCS files
	MDM Ver 3.5 11-Oct - Returned GET_INFO to printing out information
	MDM Ver 3.6 11-Oct - Changed case statement that calls reading routines
			     to only look at first letter of the file name
			     (instead of the whole prefix)
	MDM Ver 3.7 17-Oct - For SXT, when printing out the summary of what
			     Sequence lines are used, print out the parameters
			     for the FIRST (only first) image for that sequence
			   - Also added option -888 to get out without reading
			     any file.
	MDM Ver 3.8 19-Oct - Put in "stop" when "ndset"=0
			   - Also, if file # entered is -1, stop
	MDM Ver 3.9 20-Oct - Modified how option -888 works (first read roadmap,
			     and have option to read DP section). 
	MDM Ver 4.0 21-Oct - Added the menu option for the input file.
       CDP/JRL Ver 4.1 29-Oct - Set stdset_out=0 even when not used by
                               not used by test_rd (used by other routines).
	MDM Ver 4.2  7-Nov-91 - Expanded the SXT seq_num information being printed.
	MDM Ver 4.3 10-Nov-91 - New method of determining what type of file it is
				is to check the "fheader.st$instrument) field.
				Old method was to look at the first letter of the
				file name.
	MDM Ver 4.4 13-Nov-91 - Used new calling sequence for "seq_summary"
				Added option to select sequence by menu
	MDM Ver 4.5 20-Nov-91 - Added capability to select multiple sequences
				using the sequence menu option
	MDM Ver 4.6 21-Nov-91 - Added "SAME" option to select a different instrument
				with the same fileid
	MDM Ver 4.7 22-Nov-91 - Fixed bug with using SXT -777 option (if asked for
				invalid option, it never recovered)
	MDM Ver 4.8  3-Dec-91 - Changed the "normal" option of entering # of data
				sets and starting dataset to check that it does no
				run past the last dataset in the file.
				Also deleted the "significant update" message
				and removed the compiliation of all "_struct" routines
	MDM Ver 5.0 12-Dec-91 - Major changes
				Allowed multiple files to be selected (added "MANY" option)
				Allow user to specify the time (added "TIME" option)
	MDM Ver 5.1 28-Feb-92 - * Removed code that turned "SS" dataset #'s into 
				  a structure and replaced with MK_DSET_STR.
				* Print out total # of datasets
				* Put "break_file" call back in (after 
				  upgrading it to handle arrays of filenames
				* Fixed but with "TIME" option for cases where
				  time span is short (doesn't cross file boundry)
				* Adjusted "SAME" option code to work for
				  multiple file input.
	MDM Ver 6.0  8-Mar-92 - * Added options to plot the lightcurve for
					- HXT sum_l, sum_m1, sum_m2, sum_h
					- WBS sxs1, sxs2, hxs
					- BCS total_cnts(1,2,3,4)
				* Also added option to extract flare data only
	MDM Ver 6.1 10-Mar-92 - * Added "show_obs3" and "plot_fov" options for 
				  SXT
	MDM Ver 6.2 10-Mar-92 - * As per Bob Bentley suggestion, the "dset_arr"
				  will always be the structure equivalent.  This
				  meant that the new options added in Ver 6.0
				  dataset #s are held in the variable "ssss"
	MDM Ver 6.3 12-Mar-92 - * Added "stdset_out" to be defined when using
				  the "ss" option and any of the options using
				  PLOT_LCUR
	MDM Ver 6.4 19-Mar-92 - * Changed the variable name of the roadmap that
				  is returned from the "RD_xxx" routines to be
				  "roadmap2" since it is only the roadmap for 
				  the files that are read for the particular
				  extraction.  The full roadmap of all files is
				  still held in "roadmap".
	MDM Ver 6.5 20-Mar-92 - * Try to trap on an unrecognized command option
				* Added titles to the PLOT_LCUR options
	MDM Ver 6.6 24-Mar-92 - * For the TIME option, make sure that the file
				  names are time ordered before doing search on
				  start/end times
	MDM Ver 6.7 24-Mar-92 - * Return DSET_STR for all calls to RD_xxx
				* Ask before reading HXA scan data for ADA files
	MDM Ver 6.8 25-Mar-92 - * Fixed typo in TIME option (abcde vs abcd)
	MDM Ver 6.9 25-Apr-92 - * Changed the way that SXT was calling sequence
				  summary listing.  It will not do that by default
				  any more, only when asked to do it.
				* Added the TEST_RD_NSAMP option
	MDM Ver 7.0  2-May-92 - * Adjusted TEST_RD_NSAMP option to work for 
				  SXT PFI observing regions
				* Had to add a goto statement with -774 option.
				* GT_DP_MODE was updates so that now option
				  -333 (all flare mode extraction) works for BCS
				* Modified MANY and MENU options to work if a
				  directory is passed with the file specification.
				* Modified MANY and MENU to accept a third 
				  parameter.  If the word "LAST" is added after
				  the file specification, then only files in the 
				  last non-empty directory is listed.
	MDM Ver 7.1  3-May-92 - * Fixed bug in MANY and MENU option when used
				  without any second or third parameter
				* Adjusted code to always call MK_DSET_STR
				  DSET_ARR is always in indicy to roadmap
				  DSET_STR is always the structure
	MDM          2-Jun-92 - * Modified to not stop when there are no datasets
				  only when input file is BCS (so that it can
				  read the DP_SYNC)
	MDM Ver 7.2 24-Jun-92 - * Modification to SXT extraction selection by
				  sequence table number and sequence number
				  (avoid problems with extraction from same file
				  twice)
	MDM Ver 8.0 26-Jun-92 - * Expanded to allow extraction of the standard
				  ground based FITS files.
	MDM Ver 8.1 26-Jun-92 - * Added QTEST_RD_SCALE option for GBO access
	MDM Ver 8.2 29-Jul-92 - * Added capability to read HXI datafiles
	MDM Ver 8.3  3-Aug-92 - * Modified GBO file access instruction information
		    22-Feb-93 - * Modified to say not to run this routine, to run
				  YODAT instead


TEST_RD [2] $SSW/yohkoh/ucon/idl/morrison/test_rd0.pro
[Previous] [Next]
ROUTINE:
	TEST_RD
PURPOSE:
	Read an any of the reformatted data files
HISTORY:
	MDM	Early-1991
       JRL     Updated 18-sep-91 to create info_array
       MDM     Updated 25-Sep-91 to assemble observing regions
	MDM     Updated  1-Oct-91 to only read BCS DP_Sync if asked to
	MDM Ver 3.3 4-Oct  - Allowed SEQ_NUM selection for FFI (as well as PFI)
	MDM Ver 3.4 10-Oct - Changed default answer for "Assemble OR" question
			     to yes
			   - Also, removed GET_INFO asking if the data should
			     be written to disk
			   - Also added RD_QS for BCS files
	MDM Ver 3.5 11-Oct - Returned GET_INFO to printing out information
	MDM Ver 3.6 11-Oct - Changed case statement that calls reading routines
			     to only look at first letter of the file name
			     (instead of the whole prefix)
	MDM Ver 3.7 17-Oct - For SXT, when printing out the summary of what
			     Sequence lines are used, print out the parameters
			     for the FIRST (only first) image for that sequence
			   - Also added option -888 to get out without reading
			     any file.
	MDM Ver 3.8 19-Oct - Put in "stop" when "ndset"=0
			   - Also, if file # entered is -1, stop
	MDM Ver 3.9 20-Oct - Modified how option -888 works (first read roadmap,
			     and have option to read DP section). 
	MDM Ver 4.0 21-Oct - Added the menu option for the input file.


TEST_RD [3] $SSW/yohkoh/ucon/idl/morrison/test_rd00.pro
[Previous] [Next]
ROUTINE:
	TEST_RD
PURPOSE:
	Read an any of the reformatted data files
HISTORY:
	MDM	Early-1991
       JRL     Updated 18-sep-91 to create info_array
       MDM     Updated 25-Sep-91 to assemble observing regions
	MDM     Updated  1-Oct-91 to only read BCS DP_Sync if asked to
	MDM Ver 3.3 4-Oct  - Allowed SEQ_NUM selection for FFI (as well as PFI)
	MDM Ver 3.4 10-Oct - Changed default answer for "Assemble OR" question
			     to yes
			   - Also, removed GET_INFO asking if the data should
			     be written to disk
			   - Also added RD_QS for BCS files
	MDM Ver 3.5 11-Oct - Returned GET_INFO to printing out information
	MDM Ver 3.6 11-Oct - Changed case statement that calls reading routines
			     to only look at first letter of the file name
			     (instead of the whole prefix)
	MDM Ver 3.7 17-Oct - For SXT, when printing out the summary of what
			     Sequence lines are used, print out the parameters
			     for the FIRST (only first) image for that sequence
			   - Also added option -888 to get out without reading
			     any file.
	MDM Ver 3.8 19-Oct - Put in "stop" when "ndset"=0
			   - Also, if file # entered is -1, stop
	MDM Ver 3.9 20-Oct - Modified how option -888 works (first read roadmap,
			     and have option to read DP section). 
	MDM Ver 4.0 21-Oct - Added the menu option for the input file.
       CDP/JRL Ver 4.1 29-Oct - Set stdset_out=0 even when not used by
                               not used by test_rd (used by other routines).
	MDM Ver 4.2  7-Nov-91 - Expanded the SXT seq_num information being printed.
	MDM Ver 4.3 10-Nov-91 - New method of determining what type of file it is
				is to check the "fheader.st$instrument) field.
				Old method was to look at the first letter of the
				file name.
	MDM Ver 4.4 13-Nov-91 - Used new calling sequence for "seq_summary"
				Added option to select sequence by menu
	MDM Ver 4.5 20-Nov-91 - Added capability to select multiple sequences
				using the sequence menu option
	MDM Ver 4.6 21-Nov-91 - Added "SAME" option to select a different instrument
				with the same fileid
	MDM Ver 4.7 22-Nov-91 - Fixed bug with using SXT -777 option (if asked for
				invalid option, it never recovered)
	MDM Ver 4.8  3-Dec-91 - Changed the "normal" option of entering # of data
				sets and starting dataset to check that it does no
				run past the last dataset in the file.
				Also deleted the "significant update" message
				and removed the compiliation of all "_struct" routines


test_spl $SSW/yohkoh/ucon/idl/pike/test_spl.pro
[Previous] [Next]
   Example of how the data window finding, spline fitting routines might
   work.  See FIND_DATA, BELLS, FIT_SPL_WIND

  CDP     Jan '92


text_size $SSW/yohkoh/ucon/idl/lemen/text_size.pro
[Previous] [Next]
  Name:
    text_size
  Purpose:
    Try to figure out the size of a text drawn in a window

  Calling sequence:
    text_size,text,ncolumns,nrows
    text_size,text,ncolumns,nrows,xsize=size,ysize=ysize

  Inputs:
    text	= A text string, scalar or array.
  Outputs:
    ncolumns	= Number of columns required (array if text is an array)
    nrows	= Numbe of rows required     (array if text is an array)

  Optional Input Keywords:
    xsize	= Size of the pixmap window (default is 512)
    ysize	= Size of the pixmap window (default is 512)
    size	= Size parameter in the call to xyouts (may be a vector to
	;		match text)

  Method:
    Open a window and then read back the results

 CALLS: ***
	SUMCOL [1], SUMCOL [2], SUMROW [1], SUMROW [2], SUMROW [3]
  Side effects:
    A window will be created temporarily and then deleted.
  Modification History:
    13-apr-92, Written, JRL


THERMAL_KEV $SSW/yohkoh/ucon/idl/hudson/thermal_kev.pro
[Previous] [Next]
 NAME:
	THERMAL_KEV
 PURPOSE:
	hard X-ray spectrum calculation in energy (keV) units
 CALLING SEQUENCE:
	flux = thermal_kev(te, energy)
	flux = thermal_kev(te, energy, date=date)
 OUTPUTS:
	units of flux are ph/cm^2/sec/keV, spectral number flux at Earth
	as computed for input date. Normalization is to an
	emission measure 10^44 cm^3. Calculation calls MEWE_SPEC.
 INPUTS:
	te is temperature in million K (T6)
	energy is photon energy in keV, a regular grid of energies
 KEYWORDS
	date = date if you want to allow for Earth_Sun distance variation
 WARNING
	this only works for a regular energy grid
 MODIFICATION HISTORY
	HSH 11-Apr-93
       20-feb-1997 - S.L.Freeland - use <get_rb0p> in place of "old" pb0r
 CALLS:
 CALLED BY
	thomas_goes


THERMAL_POWER $SSW/yohkoh/ucon/idl/hudson/thermal_power.pro
[Previous] [Next]
 NAME:
	THERMAL_POWER
 PURPOSE:
	Return total radiated power for a given temperature, per 10^44 cm^-3
         emission measure
	Uses information compiled by Jim Lemen in LINFLX, CONFLX, and 
	  MEWE_SPEC
 CALLING SEQUENCE:
	power = thermal_power(temp)
 INPUTS:
	temperature in MK
 OPTIONAL (KEYWORD) INPUT PARAMETERS:
 OUTPUTS:
	power in ergs/s
 CALLED BY:
	tem_thermal_power
 RESTRICTIONS:
	This is an interim program, pending better understanding of the
	  source info in MEWE_SPEC, specifically how to treat He 304 and 
	  Lyman-alpha; also the present calculation is for cosmic abundances;
	  also would be more accurate with a splined table read. Present
         fit accuracy is < 5% for 5-30 MK
 MODIFICATION HISTORY:
	HSH, written 21 Feb. 1993


THICK_FFI $SSW/yohkoh/ucon/idl/hudson/thick_ffi.pro
[Previous] [Next]
 NAME:
     THICK_FFI
 PURPOSE:
     find thick-filter FFIs from the observing log
 CATEGORY:
     Yohkoh
 CALLING SEQUENCE:
     thick_ffi, t1, t2, info
 INPUTS:
     start and stop time of search
 OPTIONAL (KEYWORD) INPUT PARAMETERS:
 OUTPUTS:
    information array, if non-zero
 CALLS: ***
	get_info [1], get_info [2], get_info [3], get_info [4], gt_filtb, gt_percentd
	rd_obs
 COMMON BLOCKS:
 SIDE EFFECTS:
 RESTRICTIONS:
 MODIFICATION HISTORY:
     HSH 21-Jan-93


THICKAL_INDEX $SSW/yohkoh/ucon/idl/hudson/thickal_index.pro
[Previous] [Next]
 NAME:
       THICKAL_INDEX 
 PURPOSE:
       find thick al images
 CALLING SEQUENCE
	al12 = thickal_index(index)
 INPUTS
	index or roadmap structure
 OUTPUT:
       subscript array for thick al images 
 CATEGORY:
       Yohkoh stuff
 ROUTINES USED:
       GT_FILTB
 CALLS: ***
	gt_filtb
 HISTORY: 
       HSH, 19 Aug 1994 (written)


THIN_FILM $SSW/yohkoh/ucon/idl/labonte/thin_film.pro
[Previous] [Next]

 NAME: THIN_FILM

 PURPOSE: Computes reflectance, phase shift, and absorbance of multilayer
	coating.


PRO thin_film, thickness, index, ambient, substrate, wavel, $
		reflect, phase, absorb, $
		angle=angle, transmit=transmit


 INPUT PARAMETERS:

	thickness = thicknesses of layers, vector.  First layer is
		farthest from substrate.

	index = indices of refraction of layers, vector.  May be
		complex if materials absorb.  To include dispersion,
		input as array dimensioned (nlayers, nwavel).

	ambient = index of refraction of incident medium.  
		Must be float, not complex. May be vector (nwavel).

	substrate = index of refraction of substrate. 
		Must be float, not complex. May be vector (nwavel).

	wavel = wavelength(s) to calculate for.  Units of thickness
		and wavel must be the same.

 OUTPUT PARAMETERS:

	reflect = reflectance, dimensioned (nwavel).

	phase = phase shift on reflection, radians.

	absorb = absorbance.  Set to zero if index is real.

 OPTIONAL INPUT KEYWORDS:
	angle = angle of incidence, radians.  Default = 0.  If nonzero,
		reflectance, phase, absorbance are computed for p- and
		s- polarizations and returned dimensioned (nwavel,2).

 OPTIONAL OUTPUT KEYWORDS:
	transmit = transmittance of coating.  Should obey the relation
		1 = Reflect + Absorb + Transmit

 METHOD: 
	Uses the notation of H.A. MacLeod, 1986, Thin-Film Optical
	Filters, 2nd edition, Macmillan.

 HISTORY:
	Written  February 13, 1995  Barry LaBonte
	Add /TRANSMIT keyword  March 15, 1995   BJL


THINAL_INDEX $SSW/yohkoh/ucon/idl/hudson/thinal_index.pro
[Previous] [Next]
 NAME:
       THINAL_INDEX 
 PURPOSE:
       find thin al images
 CALLING SEQUENCE
	thinal = thinal_index(index)
 INPUTS
	index or roadmap structure
 OUTPUT:
       subscript array for thin al images 
 CATEGORY:
       Yohkoh stuff
 ROUTINES USED:
       GT_FILTA, GT_FILTB
 CALLS: ***
	gt_filta, gt_filtb
 CALLED BY:
	TERM_QUICK, TERM_REVIEW, TERM_REVIEW_GIF
 HISTORY: 
       HSH, 17 May 1994 (written)
       BNH, 23 Jul 1999 - Don't get the NuDen entries


thomas_goes $SSW/yohkoh/ucon/idl/hudson/thomas_goes.pro
[Previous] [Next]
 NAME:
	thomas_goes
 PURPOSE:
	function to return GOES temperature and emission measure, 
	  based on fits made by Thomas, Starr, and Crannell (Solar Phys.
	  95, 323, 1985).
 CALLING SEQUENCE:
	tem = thomas_goes(hi, lo)
	tem = thomas_goes(hi, lo, /energy)
 INPUTS: 
	hi = goes high-energy channel flux, MKS (W/m^2) 
	lo = goes low-energy  channel flux, MKS (W/m^2) 
 OUTPUT:
	tem(0) is the temperature, in million K
       tem(1) is the emission measure, in cm^-3 * 10^(-55)
       tem(2) is the luminosity, ergs/s
 KEYWORDS:
	energy = energy is the solar X-ray luminosity integrated
	  over all wavelengths from an isothermal source with these
	  parameters, ergs/s. Assumes 1 A.U. distance. Not calculated
	  without the keyword setting.
       quiet turns off the "Blame Roger Thomas" message. 
       fail_count = fail_count the number of entries outside
          the range of the fitting function
 WARNING:
	VERY APPROXIMATE, CAVEAT CALCULATOR!
	...no background subtraction yet...
	These fits are good only for flare temperatures, so if you are
	  interested in active regions, you should get better calibration
	  data.
 CALLS: ***
	THERMAL_KEV
 HISTORY:
	HSH, AB Jan. 9, 1992
       HSH 6-Feb-95 irrelevant line removed
       HSH 11-May-95 added fail_count output and /quiet


tic $SSW/yohkoh/sxt/idl/util/tic.pro
[Previous] [Next]
   Name: tic

   Calling sequence:
	tic,x,y,res,bin,arcmin,color=color

   Purpose: overplot bar scale on images

       Procedure to place 1 arcmin bar scale on images.
       x is rh end of bar in device coordinates
       y is ver loc of bar in device coordinates
       res is the on-chip sum (1, 2, or 4)
       bin is the rebin factor
       sh is the color to be used for the bar (0-255)
       arcmin is the bar length in minutes of arc
       L. Acton, Feb. 1992

       Modified, slf 7-mar-92 to use plots (idl) instead of tvplot(user)
	Added calling sequence to header.  LWA  20-May-95


TIDY_DATA $SSW/yohkoh/ucon/idl/hudson/tidy_data.pro
[Previous] [Next]
 NAME:
     TIDY_DATA
 PURPOSE:
     remove gt_percentd < 100
 CATEGORY:
 CALLING SEQUENCE:
     clean_data, index, data, ii, dd
 INPUTS:
 OPTIONAL (KEYWORD) INPUT PARAMETERS:
 OUTPUTS:
 CALLS: ***
	KILL_INDEX [1], KILL_INDEX [2], gt_percentd
 COMMON BLOCKS:
 SIDE EFFECTS:
 RESTRICTIONS:
 MODIFICATION HISTORY:
     HSH, written 4-Feb-97


tim2dbase $SSW/yohkoh/gen/idl/ys_util/tim2dbase.pro
[Previous] [Next]
   Name: tim2dbase

   Purpose: return fileid, weekid & moname for input times

   Input Parameters:
      time0 - time(s) vector or start time of a range (if time1 defined)
      time1 - optional stop time - if supplied, same dimension as time0
              and interpreted as stop time of range.

   Optional Keyword Parameters:
      infile - May be used in place of input time0/1 - file which contains
               input times in Yohkoh string standard may contain one or two 
		times per line (first entries in ascii file)

      hc   -    (input)  if set, produce hardcopy
      fids -    (output) fileids corresponding to input times  (YYMMDD.HHMM)
      weekids - (output) weekids corresponding to input times  (YY_WW)
      mos  -    (output) monames coresponding to 	        (xxxN)
      umos -    (output) uniq mos				uniq mo names
      uweekid   (output) uniq weekids				uniq weekids

   Calling Sequence:
      OPTION 1 - supply time vector - output parameters will be same dimension

         tim2dbase,times, fids=fids, weekids=weekids, mos=mos

      OPTION 2 - suppy time range(s) - output parmeter dimensions may be 
                 different from from input dimensions; spanning orbits implies
                 spanning fileids and possibly spanning weekids and mos

         tim2dbase, starttimes, stoptimes, fids=fids, weekid=weekid, mos=mos

   Applications:
      1) given list of event times (ex: flares), identify the corresponding
         fileids, tapes, and/or MOs required for access
 
 CALLED BY:
	dbase2disk
   History:
      2-Dec-1994 (SLF) - to simplify various repeated tasks 

 CALLS: ***
	ANYTIM2FID, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FILE_EXIST [2]
	UNIQ [1], UNIQ [2], UNIQ [3], anytim2weekid [1], anytim2weekid [2], concat_dir [4]
	fid2ex [1], fid2ex [2], fid2mo, file_append [1], file_append [2], file_exist [1]
	file_exist [3], fmt_tim [1], fmt_tim [2], get_logenv [1], get_logenv [2]
	prstr [1], prstr [2], rd_tfile [1], rd_tfile [2], str2cols [1], str2cols [2]
	tbeep [1], tbeep [2], tbeep [3]
   Restrictions:
      mos - refer to the the ISAS MO data base so site specific


tim2dow $SSW/yohkoh/gen/idl/ys_util/tim2dow.pro
[Previous] [Next]
   Name: tim2dow

   Purpose: convert from any yohkoh time to day of week

   Calling Sequence
      dows=tim2dow(times [,/abbreviate])

 CALLS: ***
	gt_day [1], gt_day [2]
 CALLED BY:
	show_contacts
   History:
      10-apr-1995 (SLF) - I am sure this has been done before...


tim2file [2] $SSW/yohkoh/gen/idl/util/tim2file.pro
[Previous] [Next]
Name:
       tim2file
Purpose:
       Given a time (or array of times) return the file that
	the data should be in.
Input:
       tim_in - Can be a structure with the .TIME and .DAY
                fields
                       (OR)
                The "standard" 7 element external representation
                of time (HH,MM,SS,MSEC,DD,MM,YY)
Optional Input:
	keyfile	- The file prefix to use for the directory search
		  If not present, it uses ADA.
	dirs	- An array of the directories to search.  If not
		  present, it calls "DATA_PATH".
		  The path does NOT include a trailing '/'
	qstop	- Stop at the bottom of the program for debuggin
		  purposes.
Output:
       Returns the whole data path to the file in question

	dir_out	- An array of the directory path.  The path
		  DOES include a trailing '/'
	fileid	- An array of only the fileIDs
Method:
	Perform a directory listing (with FINDFILE) on all of
	the directories, sort, and find where the input time
	falls.

	TODO - Later?
	What it should do is look at the observing log and
	get a list of FileIDs

       day_str - Optional) just the date part of the string
       time_str - (Optional) just the time part of the string
 CALLS: ***
	BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], DATA_PATHS, Int2Ex [1], Int2Ex [2]
	break_file [4]
 CALLED BY:
	chk_flares [1], chk_flares [2]
History:
       19-Oct-91 by M.Morrison


tim2intstr [2] $SSW/yohkoh/gen/idl/util/tim2intstr.pro
[Previous] [Next]
   Name: tim2intstr 

   Purpose: convert ext/int to standard yohkoh structure
				         {xx,Time:0l,Day:0} 

   Input Parameters:
      time0 - external time if one parameter, msod if two parameters
      time1 - days since 1/1/79

 CALLS: ***
	Ex2Int [1], Ex2Int [2], MAKE_STR [1], MAKE_STR [2]
   History: slf, 17-Apr-1992


tim2match [3] $SSW/yohkoh/gen/idl/util/tim2match.pro
[Previous] [Next]
NAME:
	tim2match
PURPOSE:
	Give an array of reference times, determine if the input times fall
	within any of the time ranges
SAMPLE CALLING SEQUENCE:
	out = tim2match(evn, gev)			;uses GOES start
	out = tim2match(evn, gev, /entim_dur)		;uses GOES time span
	out = tim2match(evn, gev, /peak)		;uses GOES peak time
	ii = where(tim2match(sttim, gev, entim_ref=entim) gt 0)	;subscript of GEV where match
INPUT:
	sttim_ref	- 



sttim_ref/entim_ref:    ...........xxxxxxxxxxxxx...........
sttim_input:            ......x............................  0000 = 0
			 ..................x................  0001 = 1
sttim_input/entim_input:...xxx.............................  0000 = 0
			 ................xxxx...............  0011 = 3
			 ...............xxxxxxxxxxxxxxx.....  0001 = 1
			 ......xxxxxxxxxxxxx................  0010 = 2
			 ......xxxxxxxxxxxxxxxxxxxxxxxx.....  0100 = 4

Special cases:
 CALLS:
 CALLED BY
	gtt_orbit, obs_summary, soon_search [1], soon_search [3]


tim2orbit [2] $SSW/yohkoh/gen/idl/util/tim2orbit.pro
[Previous] [Next]
NAME:
	tim2orbit
PURPOSE:
	Given a time, find the orbit for which that time falls within.
CALLING SEQUENCE:
	tim2orbit, roadmap, fid=fid
	tim2orbit, roadmap, wid=wid
	tim2orbit, '1-apr-92 2:22', fid=fid, wid=wid, tim2fms=tim2fms, orbit=orbit
	tim2orbit, index, fem=fem
INPUT:
	tim_in	- The reference time to search the orbit for.
		  Form can be (1) structure with a .time and .day
		  field, (2) the standard 7-element external representation
		  or (3) a string of the format "hh:mm dd-mmm-yy"
 CALLS: ***
	CHECK_TIME, anytim2ints [1], anytim2ints [2], fmt_tim [1], fmt_tim [2]
	gt_time [1], gt_time [2], int2secarr [1], int2secarr [2], rd_fem, tim2dset [1]
	tim2dset [2]
 CALLED BY:
	BCS_CAT, GET_SUBARR2, GET_TRACUBE, HXAXY2SXT, HXT_AUTOIMG, MK_SSX, SXT2HXAXY
	ads_into_att, ads_into_pnt, adsdirs [1], adsdirs [2], atr2hxa_dbase, att_exst
	chk_pointing, daily_forecast [2], dark_orbit, delete_week [1], delete_week [2]
	find_dbo_dir, gen_file_id [1], gen_file_id [2], get_afile_size [1]
	get_afile_size [2], get_atr, get_att, get_info [3], get_pnt, get_sfc_info
	get_suncenter2, get_sxa, getwid, lastsfd [1], lastsfd [2], mk_att [1], mk_att [2]
	mk_orbit [1], mk_orbit [2], mk_pnt, mk_sdmi, mk_sdp, mk_sfc [1], mk_sfc [2]
	mk_sfd [1], mk_sfd [2], mk_sfd [3], mk_sfd [4], mk_sff_pair [1], mk_sff_pair [2]
	mk_sfs, mk_sft [1], mk_sft [2], mk_sfw, mk_sl [1], mk_sl [2], mk_sot, mk_spd
	mk_week_file [1], mk_week_file [2], mo_check, op_term_score, op_terminator [1]
	op_terminator [2], pnt_exst, pr_evn [2], pr_sxt_term, rd_week_file [2], saa_in [1]
	saa_in [2], sxt_clean [1], sxt_clean [2], sxt_uvf_info [1], sxt_uvf_info [3]
	term_obs, tim2tfss, trace_goodobs, weekid [2], wl_process, ydb_exist [1]
	ydb_exist [2], ydb_exist [3], ydb_exist [4], yoyo_man2
OPTIONAL KEYWORD INPUT:
	print	- If set, print out a summary of the conditions to the screen
	simple	- If set, just calculate the "tim2fms" and "tim2night"
	nowid	- If set, calculate everything except the WID (takes a while)
KEYWORD OUTPUT:
	fid	- a string array with the file ID for the input times
	wid	- a string array with the week ID for the input times
	tim2fms	- a floating point array with the number of minutes from
		  the first minute of sun (FMS) that the dataset exists for
	tim2night- a floating point array with the number of minutes before
		  S/C night starts
	orbit	- an integer array with the orbit number (approximately the
		  revolution number)
	scday	- a boolean array set true if the input time happens during
		  S/C day
	saa	- a boolean array set true if the input time happens in the
		  middle of a SAA passage.
	fem	- The FEM structures for the time range covered by the input
		  times (It is NOT the full FEM structure for the orbit for 
		  EACH INPUT TIME as it was originally)
HISTORY:
	Written 25-May-92 by M.Morrison
	30-May-92 (MDM) - Added "scday" and "saa"
	 8-Jun-92 (MDM) - Added "print" option
	 9-Jun-92 (MDM) - Added "tim2night" option
	17-Jul-92 (MDM) - Corrected an error in weekID generation 
			  (string formats)
	19-Aug-92 (MDM) - Fixed a problem with WeekID generation.  IDL trunactes
			  at 256 (or 128) lines when using command "string(array)"
	15-Sep-92 (MDM) - Fixed problem with WeekID generation.  Since the user
			  might only specify HH:MM, and the FEM resolution is 
			  better than 1 second, the WeekID (and FileID for that
			  matter) might be off.  The fix is to add 59 seconds to
			  the input time when the seconds/milliseconds is zero.
			  (User could ask for 1-SEP-91 03:03 (FID 910901.0303) and
			  it would give FID 910901.0126 because the true orbit
			  start time is 03:03:45).  The 59 seconds is only added
			  if ALL input times have seconds and milliseconds = 0.
	23-Feb-93 (MDM) - Added case where the information of the SAA time is in
			  the prior orbit record.  For example:
				   SSSSSSSS
				NNNNNNNDDDDDDDD
				        ^	- time of interest
	 9-Apr-93 (MDM) - Changed call to RD_FEM to use /FULL_WEEKS
	29-Apr-93 (MDM) - Modification to handle bad input times
	24-May-93 (MDM) - Modified to make the for loop variable integer*4
	20-Jun-93 (MDM) - Changed the definition of the FEM output.  It used to be
			  a FEM structure for each input time, now it is only a
			  single FEM structure for each orbit for the range of 
			  input times.
	20-Jul-93 (MDM) - Changed logic considerably (removed for loops) 
			  which sped things up
			- Added /SIMPLE and /NOWID options
	18-Feb-94 (MDM) - Corrected header information


tim2pass $SSW/yohkoh/gen/idl/ys_util/tim2pass.pro
[Previous] [Next]
   Name: tim2pass

   Purpose: indicate time 2 next visible KSC contact

   Calling Sequence:
      tim2pass [,warnmin=warnmin]

 CALLED BY:
	FIRST_LIGHT [1], FIRST_LIGHT [2], show_contacts
   History:
      6-apr-1995 (SLF)
      9-apr-1995 (slf) make sure jst visibles are used
     11-may-1995 (SLF) call JST.pro (so this works anywhere)

 CALLS: ***
	anytim2weekid [1], anytim2weekid [2], get_visible, int2secarr [1]
	int2secarr [2], jst, prstr [1], prstr [2], strjustify, tbeep [1], tbeep [2], tbeep [3]
   Restrictions: for now, assumes that you are in Japan...


tim2tfss $SSW/yohkoh/gen/idl/ys_util/tim2tfss.pro
[Previous] [Next]
   Name: tim2tfss

   Purpose: find time of tfss night or day; optionally display timeline

   Input Parameters:
      times - time or time array (any Yohkoh format) -  for example, SFT
              roadmap records...

   Optional Keyword Parameters:
      plotit   - if set, display timeline
      logit    - if set, log results
      loud     - if set, echo results to terminal
      femdelta - (output) predicted deltaT from FEM files

   Calling Sequence:
      delta=tim2tfss(times [,/plotit, /logit, femdelta=femdelta] )	

   History:
      12-dec-1994 (SLF) written to filter SFT (terminators)
      13-dec-1994 (SLF) protect when no ATR data in window, added level check
      14-dec-1994 (SLF) add LOUD keyword / add X and Y keywords

   Method:
      look at atr files for window around times - determine where
         state change occurs (via max derivitive)

 CALLS: ***
	ADDTIME [1], ADDTIME [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
	OUTPLOT [1], OUTPLOT [2], OUTPLOT [3], UTPLOT [1], UTPLOT [2], UTPLOT [3]
	UTPLOT [4], UTPLOT [5], UTPLOT [6], concat_dir [4], deriv_arr [1], deriv_arr [2]
	evt_grid, file_append [1], file_append [2], get_info [1], get_info [2]
	get_info [3], get_info [4], get_logenv [1], get_logenv [2], gt_time [1]
	gt_time [2], input [1], input [2], int2secarr [1], int2secarr [2], linecolors [1]
	linecolors [2], prstr [1], prstr [2], rd_atr, str_is [1], str_is [2], tim2dset [1]
	tim2dset [2], tim2orbit [1], tim2orbit [2], timegrid
   Restrictions:
      night detection for now (some hooks for day, but not implemented yet)
      no checks for missing ATR data in region of 'real' night
      Currently time window is set up for sxt terminators, but should be
      made more generic.


TIM2UPOS $SSW/yohkoh/ucon/idl/slater/tim2upos.pro
[Previous] [Next]
NAME:
    TIM2UPOS
PURPOSE
    Returns the heliographic latitude and longitude of the Ulysses
    spacecraft at a specified time or array of times.
INPUT
    TIME - Scalar or vector of times in any standard format
 CALLS: ***
	INTERPOL, TIM2CARR, ULYSSES_FEM, anytim2ints [1], anytim2ints [2], conv_c2h
	doy2ex [1], doy2ex [2], int2secarr [1], int2secarr [2], rd_guf, tim2dset [1]
	tim2dset [2]
 CALLED BY:
	PLOT_CLON
OPTIONAL KEYWORD INPUT:
    RADIUS - if set, return radius as well as lat and lon
    NOFIT - if set, do not interpolate, but instead select the nearest
	      entry from the ephemeris
OUTPUT
    2 x n array containing lat and lon for each time specified OR
    3 x n array containing radius, lat and lon for each time specified.
CALLING SEQUENCE
    CARR = TIM2CARR('16-Feb-1994 10:46:27')
HISTORY
    Feb 15, 1994 - GLS - Written using CARR2EX as starting point


tim2weekid $SSW/yohkoh/gen/idl/dbase/tim2weekid.pro
[Previous] [Next]
   Name: tim2weekid

   Purpose: return weekly file id 'root' from input time

   Input Parameter: time (any standard yohkoh format - arrays ok) 

   Output: function returns string or string array of form yy_ww 
		(as in obsyy_wwa.xx, femyy_wwa.xx, etc.)

 CALLS:
 CALLED BY
	copy_visible, dark_sub [1], dark_sub [2], dark_sub [3], get_dc_image [2]
	get_dc_image [3], go_comp_sfr_arch, go_lasdisk golaserdisk
	go_lasdisk2 golaserdisk, sft_files, weekfiles


tim_bin $SSW/yohkoh/ucon/idl/lemen/tim_bin.pro
[Previous] [Next]
 NAME:
   tim_bin
 PURPOSE:
   Given a vector of times in any Yohkoh format and time interval,
   return a vector of indices corresponds to the bin intervals.

 CALLING SEQUENCE:
   indices = tim_bin(time_vec, bin_interval)
   indices = tim_bin(time_vec, bin_interval, start_time='15:52 9-nov')
   indices = tim_bin(time_vec, bin_interval, start_time='15:52 9-nov',times=times)

 INPUTS:
   time_vec	- A vector of times in any Yohkoh format
   bin_interval- Length of the time bin (sec)

 OPTIONAL INPUT KEYWORDS:
   start_time	- Start time -- default is the first time in time_vec
   stop_time	- Last time  -- default is the last time in time_vec.  This is
				always inclusive.  That is, enough bins are returned
				to include this time.
 OPTIONAL OUTPUT KEYWORDS:
   times	- Times of the beginning of each time bin

 CALLS: ***
	ADDTIME [1], ADDTIME [2], anytim2ints [1], anytim2ints [2], int2secarr [1]
	int2secarr [2]
 HISTORY:
    9-Nov-94, J. R. Lemen LPARL, Written.


Time2Dset $SSW/yohkoh/gen/idl/dbase/time2dset.pro
[Previous] [Next]
	Name:
		Time2Dset
	Purpose: 
		Given start time (stTime) and end time (enTime)
		search (idx) and return a list of indices (idxList)
		which occur between those times.
	CALLING SEQUENCE:
		err = Time2Dset( idx, stTime, enTime, idxList)
	Input:
		idx	data vector to be search containning time
			fields
		stTime	start time of search
		enTime	end time of search

		Input start and end times are assumed to be in internal
		format and are structured vars. with fields time and 
		day.  For example,
			stTime = {Low , time = LONG(0), day = FIX(0)}

		        stTime.time  is milliseconds of day 
			stTime.day   is days since 1-1-79
	Output:
		idxList	list of data vector indices which occur 
			between the input times.
	Returned:
		Time2Dset = 1 	indicates Success
		Time2Dset = 0	indicates failure to find any elements
				which satisfy the input constraints.

	SCOPE:  The following structures are legal search parameters:
		From the SDA file: SXT_RoadMap_Rec, SXT_Index_Rec, and
		From the Observing Log File: Obs_FileID_Rec, 
		Obs_3Instr_Rec, Obs_***_Status_Rec, and Obs_SXT_Rec.
 CALLS: ***
	BinarySea
 CALLED BY:
	trace_scale
	History:
		written 18-Apr-1991 by GAL
		modified with name change from BiSeaTime.pro 24/6/91.


TIME2MSEC $SSW/yohkoh/ucon/idl/wuelser/time2msec.pro
[Previous] [Next]
 NAME:
        TIME2MSEC
 PURPOSE:
        Converts time string ('hh:mm:ss') into a longword
        variable (milliseconds since beginning of the day)
 CATEGORY:
        Misc.
 CALLING SEQUENCE:
        out = time2msec(in)
 INPUTS:
        in = string representing time information in hours, minutes,
             seconds. Format: 'hh:mm:ss'
 OUTPUTS:
        out = longword.  Time in milliseconds since 00:00:00
 CALLED BY
	PLOTCAL_ATT


time_2_fileid $SSW/yohkoh/ucon/idl/mctiernan/time_2_fileid.pro
[Previous] [Next]
NAME:
 time_2_fileid
PURPOSE:
 Takes a time and creates a fileid, note that this is not
 the same as ANYTIM2FID, which finds fileids which already
 exist for given times...
CALLING SEQUENCE:
 fileid = time_2_fileid(time)
INPUT:
 time= time in Yohkoh format
OUTPUT:
 fileid= a fileid, eg. '11-dec-95 09:20:33' is returned as 951211.0920
KEYWORDS:
 sec= add seconds to the fileid
 msec = add msec to the fileid, this will not work unless /sec is also set
 CALLS: ***
	anytim2ex [1], anytim2ex [2]
 CALLED BY:
	Sxt_goes_teem, hxt_multimg
HISTORY:
 13-feb-96, jmm


time_add1s $SSW/yohkoh/ucon/idl/suga/time_add1s.pro
[Previous] [Next]
  NAME:
       time_add1s
  PURPOSE:
       To plot with Universal time label.
        ( under only grs_plot )
 CALLS: ***
	Int2Ex [1], Int2Ex [2], gt_day [1], gt_day [2], gt_time [1], gt_time [2]
 CALLED BY:
	dataget_grs, pc_tplot_grs, pc_tplot_rbm
  HISTORY:
       Written 20-jun-93 by T.Hiraoka
       Updated  8-jul-93 by T.Hiraoka: Added the case of less than 3 minutes 
       Updated 12-jul-93 by T.Hiraoka


time_addxa $SSW/yohkoh/ucon/idl/hiraoka/time_addxa.pro
[Previous] [Next]

  NAME:
       time_addxa
  PURPOSE:
       To plot with Universal time labels on bottom X axis. X axis range
       can be as small as 10 msec or as large as 7 days.
  CALLING SEQURNCE:
       time_addxa,st_msod,st_ds79,ntime
  INPUT:
       st_msod = start time for plot. : the MSOD variable.
       st_ds79 = dates on start time. : the DS79 variable.
       ntime   = time range.          : milliseconds.
        -- for example --
       IDL> time_addxa,20373694,4683,120000
         20373694 --> 05:39:33.694
         4683     --> 27-OCT-91
         120000   --> time range for 120.000 seconds
  OUTPUT:
       Structure !AXIS
           ( !X.TICKS, !X.RANGE, !X.MINOR, !X.TICKV, !X.TICKNAME, !X.TYPE )
       !X.RANGE = [ 0, ntime/1000. ]
       !X.TYPE  = 0
 CALLS: ***
	Int2Ex [1], Int2Ex [2], gt_day [1], gt_day [2], gt_time [1], gt_time [2]
 CALLED BY:
	DATAGET3_GRS, DATAGET3_HXS
  HISTORY:
       Written 16-jul-93 by T.Hiraoka ( Rikkyo Univ.)
       Updated 31-aug-93 by T.Hiraoka  ; added the case of less than 1 sec.


time_bda $SSW/yohkoh/ucon/idl/fludra/time_bda.pro
[Previous] [Next]
  Gives the time coresponding to a BDA file data record

  Use: 
          test_rd must have been run first.
          idl> .run time_bda


   AF  Dec 91  (based on various other routines)


TIME_INFO $SSW/yohkoh/ucon/idl/sakao/time_info.pro
[Previous] [Next]
 NAME:
	TIME_INFO
 PURPOSE:
	Returns an array of strings which contains time tags and image numbers.
 CALLING SEQUENCE:
	times = TIME_INFO(index)
 INPUT:
	index	- An index structure variable with .TIME tag inside.
 CALLS: ***
	gt_time [1], gt_time [2]
 OPTIONAL KEYWORD INPUT:
	msec		- Just the same as the one for GT_TIME.
	nonumber	- If set, then the image number ID is omitted.
 OUTPUT:
	times	- An array of image ID and time strings.
 NOTE:
	This program can be used as follows:
	IDL> STEPPER, ... , INFO=TIME_INFO(index)
 CATEGORY:
	Yohkoh HXT data analysis.
 HISTORY:
	version 1.0	98.03.23 (Mon)	T.Sakao written @ GSFC.
		1.1	98.03.25 (Wed)	Option nonumber added @ GSFC.


time_interp $SSW/yohkoh/ucon/idl/mctiernan/time_interp.pro
[Previous] [Next]
NAME:
 time_interp
PURPOSE:
 Interpolates an array in time
CALLING SEQUENCE:
 y1 = time_interp(y, tim_arr, new_tim_arr)
INPUT:
 y=an array
 tim_arr= a time array, any yohkoh format, can be an array of seconds
          from 1970
 new_tim_arr= a new tim array, to be interpolated to
OUTPUT:
 y1= an interpolated array, defined on new_tim_arr
 CALLS: ***
	ADDTIME [1], ADDTIME [2], INTERPU_1D, anytim2ints [1], anytim2ints [2]
	int2secarr [1], int2secarr [2]
HISTORY:
 2-apr-1996, jmm


time_smooth $SSW/yohkoh/ucon/idl/mctiernan/time_smooth.pro
[Previous] [Next]
NAME:
 time_smooth
PURPOSE:
 Interpolates an array in time, smooths, and reinterpolates
CALLING SEQUENCE:
 y1 = time_smooth(y, tim_arr, width=width, npts=npts)
INPUT:
 y=an array
 tim_arr= a time array, any yohkoh format, can be an array of seconds
OUTPUT:
 y1= an interpolated, smoothed array, defined on tim_arr
KEYWORDS:
 width= smoothing width, an odd number, please, this is defined on
        an array with higher time resolution than tim_arr. The default is
        31.
 npts= the number of points for the high time resolution array,
       the default is 10*n_elements(y)
 CALLS: ***
	INTERPU_1D, anytim2ints [1], anytim2ints [2], int2secarr [1], int2secarr [2]
HISTORY:
 29-feb-96, jmm
 23-oct-1997, jmm, added some error checking


time_vec [2] $SSW/yohkoh/gen/idl/util/time_vec.pro
[Previous] [Next]
NAME:
	time_vec
PURPOSE:
	Given a time vector (in the form of "days since
	1979" and "millisec of day" and a rate, and a
	number of repeats within a major frame, return
	a single time vector (in units of minutes from
	the first time)
	
	It is used to plot parameters where there is
	more than value in a major frame (since there
	is only one time returned for each major frame)
INPUT:
	time	- millisec of day
	day	- days since 1979
	rate	- DP telemetry rate
	nrep_mf	- Number of repeats for this entry
		  per major frame
OUTPUT:
	Returns	- Number of minuts since first entry
 CALLS:


timidx $SSW/yohkoh/gen/idl/dbase/timidx.pro
[Previous] [Next]
	NAME:
		timidx
	PURPOSE:
		Compute the start indices within the data-vector
		for every valid fileID (fid).
	CALLING SEQUENCE:
		stlist = TimIdx(fid, timlst)
	Input:
		fid	list of times associated with each fileID
		timlst	list of times from a data vector.
	Returned:
		List of start indices for the data-vector which
		correspondes closest, in time, to the fileID-time.
 CALLS: ***
	BinarySea
	History:
		written 19-June-91 by GAL
		15-Oct-91 MDM	Modified to return a -1 for fileids
				that do not have any datasets in them


TimToOff $SSW/yohkoh/gen/idl/dbase/timtooff.pro
[Previous] [Next]
	Name:
		TimToOff
	Purpose:
		Convert requested times to 32-byte offset for 
		direct access to observing log.
	CALLING SEQUENCE:
		TimToOff, iNewOrb, NewOrb_p, len, recPtr1, recPtr2
	Input:
		iNewOrb		list of NewOrb_p-indices corresponding
				to input times
		NewOrb_p	list of NewOrbit times and pointers
		len		number of 32-byte logical records
				following the last requested neworb_p
	Output:
		recPtr1         starting logical (32-byte) record #
		recPtr2         ending logical (32-byte) record #
 CALLED BY:
	GetObsDat
	History:
		written 20-May-91 by GAL


Tmstothms $SSW/yohkoh/ucon/idl/mctiernan/tmstothms.pro
[Previous] [Next]
 NAME:
	Tmstothms
 CALLING SEQUENCE:
	tmstothms,t,thr,tmn,tsec
 PURPOSE:
	Converts time milliseconds from the start of the day, 
 	to hours, minutes and seconds
 INPUT:
	t=index.gen.time, a long integer, ms from the start of the day. 
 OUTPUT:
	thr= hours
	tmn= minutes
	tsec=seconds
 HISTORY:
	Spring '92 by JMcT


to add 5 minutes to the data file extension to try and $SSW/yohkoh/ucon/idl/pike/add_5mins.pro
[Previous] [Next]
    FUNCTION: to add 5 minutes to the data file extension to try and
    cope with the new files names

  Use:   new_ext = add_5mins(ext)

                                    where ext is the old extension eg '.0023'


   CDP Jan 93
 CALLS:


to display test_rds DATA array as a grey scale image $SSW/yohkoh/bcs/idl/bda/gs.pro
[Previous] [Next]
  ROUTINE: to display test_rd's DATA array as a grey scale image.
  The DATA array is trimmed in case any long records exist and plotted
  to give reasonable representation of channel 4 (and hopefully the others)
  The data can be decompressed before plotting if requested.

  The maximum number of test_rd read datasets that it is sensible to try
  and display in one go is 900.  The greyscale image is displayed within
  a window having a 10 pixel wide border.

  By-products    GSA  2-d array containing only valid spectral area of 
                      original DATA array.
                 GSA_TEMP a 2-d array internally scaled for each channel's
                      data - for display only, not to be used for data
                      analysis
            
                This array is displayed such that the value which is 
                GS_CUT times the mean of the channel's data is scaled to
                white. The scaling can be changed by changing this variable
                or by the usual look-up table manipulations.

  Use:
        IDL>  .run gs

                
   CDP   Oct 91
         Feb 92   Include gs_decomp flag
         Mar 92   Allow individual scaling of channels and allow cutoff
                  set by GS_CUT
         Mar 92   Variable bins/channel
         Mar 92   Major readjustment to cater for test_rd, set max display
                  size of 900.
         May 92   Fix scaling bug    CDP


to do simple numerical ie nontransform cross correlation $SSW/yohkoh/ucon/idl/pike/cross.pro
[Previous] [Next]
     ROUTINE: to do simple numerical (ie non-transform) cross correlation 
     of a set of spectra relative to one of the spectra within the set.

  Input:
          arr     - 2-d array containing the set of spectra (eg DATA from
                    test_rd)  arr(bins,spectra)

  Output:
         rel_pos      - position of each spectrum relative to template (bins)


  Use:
          IDL> cross, array, posn

  Prompts:
             Which is template? >   give spectrum number which is to be used
                                    as the template ie against which others
                                    matched

             What range of spectra to use? >  give the start and end numbers
                                              for the spectra to be used

             Which bins? >          give the range of bins to be used in
                                    the correlation

             Number of correlation steps? >   give number of shifts to be
                                              used in match. The spectra are
                                              shifted by +/- half this value
                                        

   CDP     March 92

 CALLS:


to interactively define the continuum $SSW/yohkoh/bcs/idl/bda/gs_cont.pro
[Previous] [Next]
  ROUTINE: to interactively define the continuum


  Input:
          xval     array of x-values at which continuum will be calculated
          order    order of polynomial to fit (optional - prompted for)

  Output:
          cont     output array - the calculated continuum at the x-values
                                  specified by xval

  Use:
       Plot a spectrum and then..
       IDL> gs_cont,xval, cont [,order]


  CDP   Feb 92
 CALLS:


to load named spectral arrays with the relevant bits of DATA $SSW/yohkoh/ucon/idl/pike/get_sp.pro
[Previous] [Next]
  ROUTINE: to load named spectral arrays with the relevant bits of DATA 
  array returned by test_rd.

  Arrays created:
                   CAL  has 2-d CaXIX  array
                   SUL  has 2-d SXV    array
                   FE25 has 2-d FeXXV  array
                   FE26 has 2-d FeXXVI array

 all arrays omit the bad end bins and may be decompressed if requested.

  USE:   IDL> .run test_rd 
         IDL> .run get_sp


  See related routines GET_SULPHUR & GET_CALCIUM which may be appropriate
  if the DATA array created by test_rd is ridiculously large.

  Assumes a 256/256/128/128 binning.

  CDP Dec 91


to load only the Calcium array with the relevant bits of DATA $SSW/yohkoh/ucon/idl/pike/get_calcium.pro
[Previous] [Next]
  ROUTINE: to load only the Calcium array with the relevant bits of DATA 
  array read in by test_rd and thence to avoid end effects of spectrum. 
  User is asked whether decompression of the data is required or not.
  Assumes 256/256/128/128 binning of spectra

  Calling: 
             IDL> .run get_calcium

  Output product:
                    CAL - a 2d (127,*) array containing extracted Calcium 
                                       spectra.

  Related routines:   get_sp      (load all 4-channels into separate arrays)
                      get_sulphur (load just SXV)

  CDP Dec 91


to load only the Sulphur array with the relevant bits of DATA $SSW/yohkoh/ucon/idl/pike/get_sulphur.pro
[Previous] [Next]
  ROUTINE: to load only the Sulphur array with the relevant bits of DATA 
  array read in by test_rd and thence to avoid end effects of spectrum. 
  User is asked whether decompression of the data is required or not.

  Calling: 
            IDL> .run test_rd
            IDL> .run get_sulphur

  Output product:
                    SUL - 2d (127,*) array containing extracted Sulphur 
                                     spectra.

  Related routines:   get_sp      (load all 4-channels into separate arrays)
                      get_calcium (load just CaXIX)


  Note:  Assumes 256/256/128/128 binning

  CDP Dec 91


to plot the light curve integrated intensity v time [1] $SSW/yohkoh/bcs/idl/bda/gs_lc.pro
[Previous] [Next]
    ROUTINE: to plot the light curve (integrated intensity v time)
    of specific spectral features.  The wavelength region of interest is
    selected using the cursor together with an appropriate continuum window.
    The continuum window may straddle the feature window, the continuum will
    only be taken from those bins outside the feature window.
    The integrated counts/sec within the feature window are displayed
    together with the matching continuum counts.  The continuum subtracted
    intensity is displayed on a companion plot. 

    Forms part of the GS_ routines and therefore
    expects GS and GS_CUR to have been run first to specify the data window.

    Use:   IDL> .run gs_lc        (follow prompts)

    Note:
           The continuum data are often noisy and detract (in a
           non-statistical way) from the data. If this is the case the
           continuum data can be smoothed (in time) by setting the variable
           GS_LC_SM to the size of the box to be used in the IDL smooth
           routine and the continuum data are then smoothed by that amount.


    If hardcopy of the window selection and results is required, use the
    program interactively first to set up the variables, change the plot
    device to 'PS' and rerun the program.  The selections already made will
    be reused.  Use PLTDV2 as usual to send the plot to the laser and then
    return to your graphics device.

    Deadtime corrections are applied if the deadtime correction array dt_fac
    is available. cf the routine DT_FACTOR.


    CDP    Feb  92
   
   Vers 1.1     Put in variable bins/channel      March 92
        1.2     Further updates following test_rd update  March 92
        1.3     Change so continuum can straddle spectral feature.  Aug 92



to plot the light curve integrated intensity v time [2] $SSW/yohkoh/ucon/idl/sterling/bsd_lc.pro
[Previous] [Next]
    ROUTINE: to plot the light curve (integrated intensity v time)
    of specific spectral features from BSD file spectra.  This code is
    conceptually the same as GS_LC, except it uses BSD data instead of raw
    reformatted data.  The wavelength region of interest is
    selected using the cursor together with an appropriate continuum window.
    The integrated counts/sec within the feature window are displayed
    together with the matching continuum counts.  The continuum subtracted
    intensity is displayed on a companion plot.

    Must first create BSD file of event of interest.  Then extract those data
    using GET_BSD routine.  If deadtime corrections are required, they must be
    included when creating the BSD file in MKBSD.


    Usage:
      i) Run MKBSD code to create BSD file of feature of interest (if it does
	  not already exist).

      ii) in idl, input 
            IDL> .run GET_BSD
  	   and select data set of interest, along with channel number.

      III) run this code via
         IDL> .run BSD_LC        (follow prompts)

    Note:
           The continuum data are often noisy and detract (in a
           non-statistical way) from the data. If this is the case the
           continuum data can be smoothed (in time) by setting the variable
           GS_LC_SMTH to the size of the box to be used in the IDL smooth
           routine and the continuum data are then smoothed by that amount.


    If hardcopy of the window selection and results is required, use the
    program interactively first to set up the variables, change the plot
    device to 'PS' and rerun the program.  The selections already made will
    be reused.  Use PLTDV2 as usual to send the plot to the laser and then
    return to your graphics device.


  Warning:  Deadtime corrections are not incorporated into this code. They
            may be significant for some event data.  Dead time corrections 
	     can be included in BSD code by setting parameters when creating
	     the file with MKBSD.

 HISTORY

      ACS    28 Apr  92    An even more blatant ripoff of GS_LC and GET_BSD


to restore the spectrum array created by the GS_ routines from $SSW/yohkoh/bcs/idl/bda/gs_getsp.pro
[Previous] [Next]
  ROUTINE: to restore the spectrum array created by the GS_ routines from
  storage in a file. The file must have been written by GS_PUTSP (qv)

  The file name to be read is prompted for

  Use:
       IDL>  .run gs_getsp


   CDP    Feb  92


to store the spectrum array created by the GS_ routines $SSW/yohkoh/bcs/idl/bda/gs_putsp.pro
[Previous] [Next]
  ROUTINE: to store the spectrum array created by the GS_ routines.

  The file name to be created is prompted for

  Use:
       IDL>  .run gs_sp          to create array gsp
       IDL>  .run gs_putsp       to store gsp array (file name prompted for)


   CDP    Feb  92


TOBAN_BOXES $SSW/yohkoh/ucon/idl/hudson/toban_boxes.pro
[Previous] [Next]
 NAME:
 	TOBAN_BOXES
 PURPOSE:
       put boxes on an image to help tobans plan PFI observations
 CALLING SEQUENCE:
	toban_boxes, y, x, (xsize, ysize)
   The user is supposed to have displayed an image at half resolution
   (512 x 512). TOBAN_BOXES then shows on this image where the ROI 
   is located, based upon the reduced (256 x 256) coordinates read 
   from SXTQLCC. A copy of this program has been incorporated into
   FFIQL as run on the GREEN workstation, at Maki Akioka's suggestion.
 INPUT PARAMETERS:
   x and y are in reduced (256x256) and inverted (W to the left) 
   coordinates. The program draws boxes representing the ROI 
   on the 512x512 image in the correct orientation. The dotted lines
   show the ROI. An option shows (in solid lines) show the two options 
   for ARS2 search areas. Parameters xsize and ysize are the ROI 
   dimensions, default (4,2), and are optional. The search region is
   plotted with keyword SEARCH.
 CALLS: ***
	draw_boxcorn [1], draw_boxcorn [2]
 HISTORY:
   April 22, 1992, written by HSH.
   April 24, 1992. HSH modified to put the search boxes on keyword.
   May 13, 1992, HSH reversed order of coordinate inputs


TODAY $SSW/yohkoh/ucon/idl/bruner/today.pro
[Previous] [Next]
 NAME:			TODAY
 PURPOSE:		Easy to remember date function.
 CATEGORY:			Utility
 CALLING SEQUENCE:		string_var=today()

 CALLED BY:
	GOES_TF, GOES_TF_COEFF, make_goes_chianti_response [1]
	make_goes_chianti_response [2], make_goes_chianti_response [3]
	make_goes_chianti_response [4]
		example:	print,today()

 INPUTS:			none
 OPTIONAL INPUT PARAMETERS:	none
 KEYWORD PARAMETERS:		none
 OUTPUTS:			string containing today's date
 OPTIONAL OUTPUT PARAMETERS:	none
 COMMON BLOCKS:		none
 SIDE EFFECTS:			I/O performed
 RESTRICTIONS:			none
 PROCEDURE:			get time with IDL systime function;
				return string in format dd-mon-yr
 MODIFICATION HISTORY:	Written 14-Nov-1994  M. Bruner; Original name: Chkdate
			21-Nov-1994 - renamed, added header  M.B.
			


total_100 $SSW/yohkoh/ucon/idl/lemen/total_100.pro
[Previous] [Next]
  Name:
    total_100

  Purpose:
    Compute the total of the vector A.  Very similar to the IDL TOTAL
    function, except that total_100 first rounds all the elements in the
    array off to 100ths's first.  This routine is specifically designed to
    total up vectors of $ amounts, rounding off appropriately to the nearest
    penny.

  Modification History:
  Written, J. R. Lemen,  24-feb-92


tprofiles $SSW/yohkoh/sxt/idl/util/tprofiles.pro
[Previous] [Next]
NAME:
	tprofiles
PURPOSE:
	Interactively draw time profiles along third dimension of a
	data cube.
CALLING SEQUENCE:
	tprofiles, index, data
	tprofiles, index, data, frame = 10
	tprofiles, index, data, disp_data=bdata
INPUTS:
	data = data cube
OPITONAL KEYWORD INPUT:
	frame	- The frame number in the data cube to display
	factor	- The rebin factor for displaying the images
	disp_data- If the input data has been normalized for exposures
		   for time profiles, then the contrast for displaying the
		   image is not very good.  It is possible to pass in the
		   original compressed byte type data to be used for the
		   display using "disp_data"
	psym	- plotting symbol.  It must be less than or equal to 7
		  (cannot use histogram symbol 10).  If not passed, -7 is used
 CALLS: ***
	UTPLOT [1], UTPLOT [2], UTPLOT [3], UTPLOT [4], UTPLOT [5], UTPLOT [6], fmt_tim [1]
	fmt_tim [2], int2secarr [1], int2secarr [2]
HISTORY:
	Written 13-Jul-92 by M.Morrison


track_h2a [3] $SSW/yohkoh/gen/idl/util/track_h2a.pro
[Previous] [Next]
NAME:
	track_h2a
PURPOSE:
	Given a heliocentric coordinate and a set of dates, track the 
	angular position on the sun as it moves with differential rotation.
SAMPLE CALLING SEQUENCE:
	ang = track_h2a(times, helio, date_helio)
INPUTS:
	times	- An array of times in any of the 3 standard formats
	helio	- The heliocentric coordinates in a 2 element array
                       (0) = longitude (degrees) W positive
                       (1) = latitude (degrees) N positive
                 They can also be strings in the form 'N30W23'.
	date_helio - The date for the heliocentric coordinates
OUTPUTS:
	ang	- Returns the angle as seen from the earth
                       (0,*) = angle in E/W direction (arcseconds) W positive
                       (1,*) = angle in N/S direction (arcseconds) N positive
 CALLS: ***
	CONV_H2A [1], CONV_H2A [2], CONV_HS2H [1], CONV_HS2H [2], DIFF_ROT [1]
	DIFF_ROT [2], anytim2ints [1], anytim2ints [2], int2secarr [1], int2secarr [2]
 CALLED BY:
	align_prep [1], align_prep [2], align_prep [3], get_gbo_pfi, in_fov, mk_coal_movie
	rest_low8_cube [1], rest_low8_cube [2], sxt_obs_coord [1], sxt_obs_coord [2]
HISTORY:
	Written 20-Jun-93 by M.Morrison using Metcalf ALIGN_AR as starting point


TRANSLATE_SETUP_DIRS $SSW/yohkoh/bcs/idl/util/translate_setup_dirs.pro
[Previous] [Next]
 NAME:
	TRANSLATE_SETUP_DIRS
 PURPOSE:
	Translates the UNIX script file "setup_dirs" into the equivalent 
	command file for VMS 
 CALLING SEQUENCE:  
	.run translate_setup_dirs
 INPUTS:
	Reads from file "setup_dirs." on $DIR_GEN_SETUP
 OUTPUTS:
	Writes file "setup_dirs.com" to current directory
	Echoes the translations, etc. to the screen
 RESTRICTIONS:
	Not tested under UNIX, but probably works
 PROCEDURE:

 MODIFICATION HISTORY:
	RDB, 22-Oct-92, Written
	RDB  18-Feb-94	Do full translation of "disk" name if there is a
			trailing "/"  (needed for logicals like $dir_gen_tbb)
       DMZ  15-Mar-95  Removed . from setup_dirs.
	RDB  27-Mar-94	Some modifications to / trasnlations...
	RDB  20-May-94  Temp. fix to problem of showpix definition


TrimDvec $SSW/yohkoh/gen/idl/dbase/trimdvec.pro
[Previous] [Next]
	Name:
		TrimDvec
	Purpose:
		Return the 'trimed' input vector for the selected file,
		and corresponding start and end index of the input data 
		vector.
	CALLING SEQUENCE:
		newVec = TrimDvec([fileNa=fileNa, idx=idx, fnMap=fnMap, 
			vec=vec, star=start, en=en])
	Input/Keyword:
		fileNa	selected file via fileName.
		idx	selected file via file-index (0 thru n-1).
		fnMap	record of data extraction w/map of start and
			end indices for data vectors.
		vec	input times/data-indices vector
	Returned: 
		'trimed' data-set vector for the selected file.
	Output/Keyword:	
		star	computed start index of vec
		en	computed end index of vec
 CALLS: ***
	STR2ARR [1], STR2ARR [2], StrMap
	History:
		written 8 July 91. by GAL


TrimOVec $SSW/yohkoh/gen/idl/dbase/trimovec.pro
[Previous] [Next]
	Name:
		TrimOVec
	PURPOSE:
		Trim the observing log data-vectors according to the 
		users entered start and stop times.
	CALLING SEQUENCE:
		newVec = TrimOVec( ntimes, usertime, oVec)
	INPUT:
		ntimes	number of times the user specified, generally 2.
		userTim	user specified times in internal format
		oVec 	observing log data vector to be trimed
	RETURNED:
		newOvec	the trimed observing log data-vector.
 CALLS: ***
	BinarySea
 CALLED BY:
	TrimTim
	History:
		written 21-Aug-91, by GAL


TrimTim $SSW/yohkoh/gen/idl/dbase/trimtim.pro
[Previous] [Next]
	Name:
		TrimTim
	Purpose: 
		Trim the observing log data vectors to the exact
		start and stop times specified by the user (userTim).
	CALLING SEQUENCE:
		TrimTim, ntimes, usertim, ukey, [fid=fid, sxtp=sxtp,
				sxtf=sxtf, bcs=bcs, hxt=hxt, wbs=wbs]
	Input:
		ntimes	number of times the user specified (generally 2)
		userTim	the user specified times.
		ukey	logical flag-true for key searches
	Output/input Keywords:
		fid	file ident. record
		sxtp	SXT partial frame data record
		sxtf	SXT full frame data record
		bcs 	bcs instrument data record 
		hxt	hxt instrument data record 
		wbs	wbs instrument data record 
 CALLS: ***
	AdjUsrTim, TrimOVec
	History:
		written 20-May-1991 by GAL
		modified for key searches 21-June-91
		simplfied 21-Aug-91: added TrimOvec


Tstothms $SSW/yohkoh/ucon/idl/mctiernan/tstothms.pro
[Previous] [Next]
 NAME:
	Tstothms
 CALLING SEQUENCE:
	tstothms,t,thr,tmn,tsec,tmsec
 PURPOSE:
	Converts time seconds from the start of the day, 
 	to hours, minutes and seconds, as integers.
 INPUT:
	t= sec from the start of the day. 
 OUTPUT:
	thr= hours
	tmn= minutes
	tsec=seconds
       tmsec=milliseconds
 HISTORY:
	Spring '92 by JMcT


ttim2ex $SSW/yohkoh/gen/idl/reformat/ttim2ex.pro
[Previous] [Next]
NAME:
	ttim2ex
PURPOSE:
	Convert from the telemetry time block to the external representation
INPUT:
	rec1	- raw telemetry block (bytarr(144,64))
OUTPUT:
	daytim	- 7-element array time vector 
OPTIONAL INPUT:
	year0	- the year (since the telemetry does not have the year in it!)
 CALLS: ***
	doy2date [1], doy2date [2]
 CALLED BY:
	dp_clock_ref, table_dump
HISTORY:
	Written Fall '91 by M.Morrison
	 6-Jan-92 (SLF) - empirically derived mask for temparr(0) 
			  since 1992 data led to DOY = (1600 + temparr(1) stuff) 
	 8-Mar-92 (MDM) - Changed S/W to derive year from the "leap year nibble"
			  Assume that year is 1991 + "leap year nibble"
			  Need to have ISAS redefine that nibble so there is
			  no problem next year.


turn $SSW/yohkoh/sxt/idl/register/turn.pro
[Previous] [Next]
 NAME:
      turn
 PURPOSE:
      This function makes the appropriate transformation for a solar
      rotation of rot radians with the solar rotation axis inclined b
      radians out of the plane-of-the-sky (at the north pole).
 CALLING SEQUENCE:
      rotdg = turn(dgram, x0, y0, r, tim [,asec_per_pix=asec_per_pix,
                   b = b, xmn = xmn, ymn = ymn])
 INPUTS:
      dgram        = the original(unrotated) dopplergram array
      x0,y0        = the e/w and n/s solar coordinates(in pixels) of
                     the lower-left (south-ease) corner of the 
                     original dopplergram
      r            = the solar radius (in arcsec)
      tim          = the projection time, pos. or neg. (in hours)
 OPTIONAL INPUTS:
      asec_per_pix = arcsec per pixel, default value is 1.
      b            = the solar b-angle (in degrees), default value is 0
      xmn, ymn     = the x/y - coordinate of the south-east corner of
                     the projected image (in pixels)
                     if not present, the field-of-vies is not to be
                     prescribed
 OUTPUTS:
      rotdg        = the rotated dopplergram array
 COMMON BLOCKS:
      none
 RESTRICTIONS:

 PROCEDURE:

 PROCEDURE CALLED:
      none
 MODIFICATION HISTORY:
      Convert Jim Klimchuk's FORTRAN subroutine TURN into IDL function
      by Fei-Mei Lee Chou on NOV. 5, 1991


tv2_howto $SSW/yohkoh/ucon/idl/lemen/tv2_howto.pro
[Previous] [Next]
 NAME:
   tv2_howto
 PURPOSE:
   Demonstrate how to use tv2
 CALLING SEQUENCE:
   .run tv2_howto

   This crude routine demonstrates how to use tv2 and related 
   functions:  xyouts2, draw_grid, ocontour, plots2 and arrow2.

 HISTORY:
  26-Jan-96, J. R. Lemen (LPARL), Written.


tv2_msu $SSW/yohkoh/ucon/idl/acton/tv2_msu.pro
[Previous] [Next]
NAME:
	tv2_msu
PURPOSE:
	To allow a user to output an image to the MSU Tektronix Phaser II
	and to specify the location (and size) in pixels.
SAMPLE CALLING SEQUENCE:
	tv2_msu, image, x0, y0
	tv2_msu, xsiz_pix, ysiz_pix, /init
	tv2_msu, xsiz_pix, ysiz_pix, /init, window=0
INPUTS:
	image	- The byte scaled image to display 
		  (except when /INIT is used -- in that case it is 
		  the X size of the window in pixels)
	x00	- The left corner pixel coordinate of the image
		  (except when /INIT is used -- in that case it is
		  the Y size of the window in pixels)
	y00	- The lower corner pixel coordinate of the image
 CALLS: ***
	WDEF [1], WDEF [2]
OPTIONAL KEYWORD INPUT:
	landscape - If set, output in postscript mode
		  Has no effect when the output device is "X"
	window	- The window number to create 
		  Has no effect when the output device is "PS"
	already	- Do not create the window if it already exists
		  and is the proper size
		  Has no effect when the output device is "PS"
	ppinch	- Force the size of the output to be a fixed number
		  of "pixels per inch".
	color	- If set, issue the device commands for color
		  Has no effect when the output device is "X"
	hwfont	- If set, use hardware fonts
		  Has no effect when the output device is "X"
	revcolor - If set, set !color to 0 for device PS so that
		  writing will be in black on white paper.  Set
		  !color to 255 for device X so that writing is
		  white on a black background.
METHOD:
	Since the output size of the window is defined in pixels,
	TV2, TV2_MSU XYOUTS2, and PLOTS2 can convert the pixel coordinates
	into inches when sending the output to the postscript device.
	The aspect ratios are all figured out to maintain proper
	proportions
HISTORY:
	Written Feb-94 by M.Morrison
	 9-Jun-94 (MDM) - 
	10-Aug-94 (MDM) - Added ppinch optional input
	 7-Apr-95 (MDM) - Added /COLOR and /HWFONT options
       25-Aug-95 (LWA) - Changed page size to 8.1x8.6 inches to 
                         match MSU Tektronix printer and renamed tv2_msu.
       28-Jan-96 (LWA) - Made ppinch floating.
			  Changed yoffset from 1.188 to 1.2.


tv3_msu $SSW/yohkoh/ucon/idl/acton/tv3_msu.pro
[Previous] [Next]
NAME:
	tv3_msu
PURPOSE:
	To allow a user to output an image to a postscript printer
	and to specify the location (and size) in pixels.
SAMPLE CALLING SEQUENCE:
	tv3_msu, image, x0, y0
	tv3_msu, xsiz_pix, ysiz_pix, /init
INPUTS:
	image	- The byte scaled image to display 
		  (except when /INIT is used -- in that case it is 
		  the X size of the window in pixels)
	x00	- The left corner pixel coordinate of the image
		  (except when /INIT is used -- in that case it is
		  the Y size of the window in pixels)
	y00	- The lower corner pixel coordinate of the image
 CALLED BY:
	isas_ps_print, msu_tekprint2
OPTIONAL KEYWORD INPUT:
	ppinch	- Force the size of the output to be a fixed number
		  of "pixels per inch".
	color	- If set, issue the device commands for color
		  Has no effect when the output device is "X"
	hwfont	- If set, use hardware fonts
		  Has no effect when the output device is "X"
	revcolor - If set, set !color to 0 for device PS so that
		  writing will be in black on white paper.  Set
		  !color to 255 for device X so that writing is
		  white on a black background.
METHOD:
	Since the output size of the window is defined in pixels,
	TV3_MSU, XYOUTS2, and PLOTS2 can convert the pixel coordinates
	into inches when sending the output to the postscript device.
	The aspect ratios are all figured out by msu_tekprint2 to 
	maintain proper proportions.
HISTORY:
	Written Feb-94 by M.Morrison
	 9-Jun-94 (MDM) - 
	10-Aug-94 (MDM) - Added ppinch optional input
	 7-Apr-95 (MDM) - Added /COLOR and /HWFONT options
       25-Aug-95 (LWA) - Changed page size to 8.1x8.6 inches to 
                         match MSU Tektronix printer and renamed tv2_msu.
	13-Sep-95 (LWA) - modified to work with msu_tekprint2.
	 8-Nov-96 (LWA) - Changed some header wording.


tv_coors $SSW/yohkoh/ucon/idl/linford/tv_coors.pro
[Previous] [Next]
	NAME: 
		tv_coors

	PURPOSE:  Display image and Define "DATA" coordinate system 
		cooresponding to the pixels of the displayed image.

	CALLING SEQUENCE:
		tv_coors, data, xpos, ypos, [xs=xs, ys=ys, bigpix=bigpix]
	INPUTS:
		data 	image to define coordinate system for
		xpos	lower-left offset.
		ypos	lower-left offset.
		bigpix	to use pixel repl. instead of bilinear
	KEYWORD:
		xs	desired size of image.
		ys	desired size of image.
 CALLS: ***
	mknumat
 CALLED BY:
	conroi, wconroi
	PROCEDURE:
		This defines a coordinate system for overplot options or
		contours of displayed images.
	HISTORY:
		written 27-July GAL and GLS.
		added bigpix 23-jul-93


TV_SSX $SSW/yohkoh/ucon/idl/morrison/tv_ssx.pro
[Previous] [Next]
 NAME:
	TV_SSX
 PURPOSE:
 CATEGORY:
 CALLING SEQUENCE:
 INPUTS:
   POSITIONAL PARAMETERS:
   KEYWORDS PARAMETERS:
 OUTPUTS:
   POSITIONAL PARAMETERS:
   KEYWORDS PARAMETERS:
 CALLS: ***
	DR, DR_CARR [1], DR_CARR [2], DR_CARR [3], PLOT_INIT, TIM2CLON, UTPLOT [1], UTPLOT [2]
	UTPLOT [3], UTPLOT [4], UTPLOT [5], UTPLOT [6], anytim2ex [1], anytim2ex [2]
	anytim2ints [1], anytim2ints [2], clon2ex [1], clon2ex [2], clon2ex [3]
	get_rb0p [1], get_rb0p [2], int2secarr [1], int2secarr [2]
 CALLED BY:
	synop_movie
 COMMON BLOCKS:
 SIDE EFFECTS:
 RESTRICTIONS:
 PROCEDURE:
 EXAMPLE:
 MODIFICATION HISTORY:
       August, 1992. - Written by GLS, LMSC.


TV_SYNOP $SSW/yohkoh/ucon/idl/slater/tv_synop.pro
[Previous] [Next]
 NAME:
	TV_SYNOP
 PURPOSE:
 EXAMPLE CALLS:
	tv_synop, cr_num, type=type, x_siz=x_siz, lats=lats, lons=lons, $
		  del_lon=del_lon, del_lat=del_lat, qstop=qstop
	tv_synop, 1863	; This plots a synoptic map without any latitude
	  or longitude lines overplotted
	tv_synop, 1872, lats=[-90,-45,0,45,90]	; This plots a synoptic map
	  with latitude lines at -90,-45,0,45,90 overplotted
	tv_synop, 1854, lons=[127,273]	; This plots a synoptic map with
	  longitude lines at 127 and 273 overplotted
 INPUTS:
	cr_num - Carrington rotation number
 KEYWORD INPUTS:
	type - 0,1,2 for east, center, and west map, respectively
	  (only center implemented)
	x_siz - size of displayed map (default is 768)
	lats - vector of latitudes to overlay
	lons - vector of longitudes to overlay
	
 OUTPUTS:
   POSITIONAL PARAMETERS:
   KEYWORDS PARAMETERS:
 CALLS: ***
	CARR2EX, CONGRID [1], CONGRID [2], CONGRID [3], FILE_EXIST [2], OUTPLOT [1]
	OUTPLOT [2], OUTPLOT [3], RD_XDA [1], RD_XDA [2], UTPLOT [1], UTPLOT [2], UTPLOT [3]
	UTPLOT [4], UTPLOT [5], UTPLOT [6], WDEF [1], WDEF [2], anytim [1], anytim [2]
	anytim [3], anytim [4], anytim [5], anytim2ints [1], anytim2ints [2]
	file_exist [1], file_exist [3], get_rb0p [1], get_rb0p [2], gt_pix_size
	int2secarr [1], int2secarr [2], restsys [1], restsys [2], savesys [1], savesys [2]
 MODIFICATION HISTORY:
	April, 1994 - Written by GLS, LMSC.


tv_teem $SSW/yohkoh/ucon/idl/lemen/tv_teem.pro
[Previous] [Next]
  NAME:
    tv_teem
  PURPOSE:
    Plot the results from sxt_teem
  CALLING SEQUENCE:
    tv_teem,te[,dte,valid]
    tv_teem,EM[,dEM,valid]
    tv_teem,te,em,dte,dem,valid	; More than 3 arguments
  OPTIONAL INPUT PARAMETER:
    level = Cutoff value of dTe for plotting Te
  MODIFICATION HISTORY:
     1-mar-93, J. R. Lemen, LPARL (adapted from J. McTiernan's t664_screen)


TVF $SSW/yohkoh/ucon/idl/shimizu/tvf.pro
[Previous] [Next]
 NAME:
       TVF

 PURPOSE:
 	Display an image with the scales 	

 CATEGORY:
	General graphics.

 CALLING SEQUENCE:
       TVF, image
	TVF, image, xtick, ytick

 INPUTS:
	image:	The two-dimensional array to display.
        XTICK: X vector giving the position of each column (X-direction)
        YTICK: Y vector giving the position of each row (Y-direction)
                 These vectors should be an array with the same dimension
                as "image"

 KEYWORD PARAMETERS:
 WINDOW_SCALE:	Set this keyword to scale the window size to the image size.
		Otherwise, the image size is scaled to the window size.
		This keyword is ignored when outputting to devices with 
		scalable pixels (e.g., PostScript).

	ASPECT:	Set this keyword to retain the image's aspect ratio.
		Square pixels are assumed.  If WINDOW_SCALE is set, the 
		aspect ratio is automatically retained.

	INTERP:	If this keyword is set, bilinear interpolation is used if 
		the image is resized.
      NOSCALE: No auto scaling display
        TITLE: TITLE string
 OUTPUTS:
	No explicit outputs.

 COMMON BLOCKS:
	None.

 SIDE EFFECTS:
	The currently selected display is affected.

 RESTRICTIONS:
	None.

 PROCEDURE:
	If the device has scalable pixels, then the image is written over
	the plot window.

 MODIFICATION HISTORY:
 	7 May, 94  T.Shimizu	
	23 Jun, 94 T.Shimizu add /NOSCALE
	25 Jun, 94 T.Shimizu add XTICK, YTICK to change the scaling unit.
        1 Nov, 94 T.Shimizu correct the scale
	21 Aug, 95 T.Shimizu remove a bug showing two title lines


TVF_CONTOUR $SSW/yohkoh/ucon/idl/shimizu/tvf_contour.pro
[Previous] [Next]
 NAME:
       TVF_CONTOUR

 PURPOSE:
 	Display an image with the scales 	

 CATEGORY:
	General graphics.

 CALLING SEQUENCE:
       TVF, image, conour_image
	TVF, image, conour_image, xtick, ytick

 INPUTS:
	image:	The two-dimensional array to display.
	conour_image: The two-dimensional array for a contour plot.
        XTICK: X vector giving the position of each column (X-direction)
        YTICK: Y vector giving the position of each row (Y-direction)
                 These vectors should be an array with the same dimension
                as "image"

 KEYWORD PARAMETERS:
 WINDOW_SCALE:	Set this keyword to scale the window size to the image size.
		Otherwise, the image size is scaled to the window size.
		This keyword is ignored when outputting to devices with 
		scalable pixels (e.g., PostScript).

	ASPECT:	Set this keyword to retain the image's aspect ratio.
		Square pixels are assumed.  If WINDOW_SCALE is set, the 
		aspect ratio is automatically retained.

	INTERP:	If this keyword is set, bilinear interpolation is used if 
		the image is resized.
      NOSCALE: No auto scaling display

 OUTPUTS:
	No explicit outputs.

 COMMON BLOCKS:
	None.

 SIDE EFFECTS:
	The currently selected display is affected.

 RESTRICTIONS:
	None.

 PROCEDURE:
	If the device has scalable pixels, then the image is written over
	the plot window.

 MODIFICATION HISTORY:
 	7 May, 94  T.Shimizu	
	23 Jun, 94 T.Shimizu add /NOSCALE
	25 Jun, 94 T.Shimizu add XTICK, YTICK to change the scaling unit.
        1 Nov, 94 T.Shimizu correct the scale
       21 Aug, 95 T.Shimizu for tvf_contour


TVF_SLICE $SSW/yohkoh/ucon/idl/shimizu/tvf_slice.pro
[Previous] [Next]
 NAME:
       TVF_SLICE

 PURPOSE:
 	Display a time-space slice image with the scales 	

 CATEGORY:
	General graphics.

 CALLING SEQUENCE:
	TVF_SLICE, data, index

 INPUTS:
	image:	The two-dimensional array to display.
	index:  Index structure for X-axis 
        YTICK: Y vector giving the position of each row (Y-direction)
                 These vectors should be an array with the same dimension
                as "image"

 KEYWORD PARAMETERS:
 WINDOW_SCALE:	Set this keyword to scale the window size to the image size.
		Otherwise, the image size is scaled to the window size.
		This keyword is ignored when outputting to devices with 
		scalable pixels (e.g., PostScript).

	ASPECT:	Set this keyword to retain the image's aspect ratio.
		Square pixels are assumed.  If WINDOW_SCALE is set, the 
		aspect ratio is automatically retained.

	INTERP:	If this keyword is set, bilinear interpolation is used if 
		the image is resized.
      NOSCALE: No auto scaling display
     POSITION: Position to display 

 OUTPUTS:
	No explicit outputs.

 CALLS: ***
	CONGRID [1], CONGRID [2], CONGRID [3], DEF_UTPLOT, gt_time [1], gt_time [2]
 COMMON BLOCKS:
	None.

 SIDE EFFECTS:
	The currently selected display is affected.

 RESTRICTIONS:
	None.

 PROCEDURE:
	If the device has scalable pixels, then the image is written over
	the plot window.

 MODIFICATION HISTORY:
	21 Nov 94 written by T.Shimizu


TVF_VELMAP $SSW/yohkoh/ucon/idl/shimizu/tvf_velmap.pro
[Previous] [Next]
 NAME:
       TVF_VELMAP

 PURPOSE:
 	Display an image with the scales, over which velocity map is 
	plotted. 	

 CATEGORY:
	General graphics.

 CALLING SEQUENCE:
       TVFVELMAP, image, vx, vy

 INPUTS:
	image:	The two-dimensional array to display.
	vx: velocity in the X direction.
	vy: velocity in the Y direction.

 KEYWORD PARAMETERS:
 WINDOW_SCALE:	Set this keyword to scale the window size to the image size.
		Otherwise, the image size is scaled to the window size.
		This keyword is ignored when outputting to devices with 
		scalable pixels (e.g., PostScript).

	ASPECT:	Set this keyword to retain the image's aspect ratio.
		Square pixels are assumed.  If WINDOW_SCALE is set, the 
		aspect ratio is automatically retained.

	INTERP:	If this keyword is set, bilinear interpolation is used if 
		the image is resized.
   --- parameters for velocity map ----
	LENGTH: Length factor.  The default of 1.0 makes the 5.0km/s 
	        vector the length of a cell.
      MISSING: Missing data value.  Vectors with a LENGTH greater
	        than MISSING are ignored.
	 TITLE: A string text containing the title
     SUBTITLE: A string text containing the sub title
	 COLOR: Color value for the vectors
      NOSCALE: No auto scaling display

 OUTPUTS:
	No explicit outputs.
 
 OUTPUT KEYWORD PARAMETERS:
     GETSCALE: Return the scale of arrows in unit of device.
	        Returned value is the length of 1km/s arrow in unit of device.

 COMMON BLOCKS:
	None.

 SIDE EFFECTS:
	The currently selected display is affected.

 RESTRICTIONS:
	None.

 PROCEDURE:
	If the device has scalable pixels, then the image is written over
	the plot window.

 MODIFICATION HISTORY:
 	4 June, 94  T.Shimizu   Made based upon TVF.pro	
       23 Aug, 94  T.Shimizu   maxmag= 5000, The default LENGTH of 1.0
		makes the 5.0km/s velocity the length of a cell. 
	 5 Jan, 95  T.Shimizu   GETSCALE, NOSCALE


tvlct_save $SSW/yohkoh/ucon/idl/freeland/tvlct_save.pro
[Previous] [Next]
   Name: tvlct_save

   Purpose: update color common block elements

   Calling Sequence:
      tvlct_save 		(save current from existing window)
      tvlct_save [/cur2orig, /orig2cur, /swap] - shuffle color common block
    
   Common Blocks:
      colors

   History:
      1-Dec-94 (SLF)


two_ftpt $SSW/yohkoh/ucon/idl/mctiernan/two_ftpt.pro
[Previous] [Next]
 NAME:
       two_ftpt
 PURPOSE:
       Make up a two footpoint source, to test imaging programs on
 CALLING SEQUENCE:
       image = two_ftpt(btot, separation, npix=npix, ratio=ratio, $
                        mid_pt=mid_pt, orientation=orientation, $
                        gaussian=gaussian, cyl=cyl, moff=moff, r1=r1, r2=r2, $
                        point_source=point_source)
 INPUT:
       btot= total counts in image
       separation= how many pixels apart are the two foot points
 OUTPUT:
       A two footpoint image
 KEYWORDS:
       npix = Image will be npixXnpix, default = 64
       ratio= ratio of image strengths, default is 1 to 1
       mid_pt = midpoint between the two footpoints, default is
                [(npix-1)/2, (npix-1)/2]
       orientation= angular orientation, default is 0 degrees, the
                    footpoints are in the same row.
       gaussian= gaussian profile for the footpoint, the default
       cyl= if set, the fp is cylindrical.
       moff = if set, use cylindrical moffat fns, f=c/(1+r^2/r0^2)^moff(0)
       r1, r2= radii for each footpoint in pixels, the default is 1
       point_source= the footpoints are point sources
 CALLS: ***
	ROT_INT, cyl_2d, cyl_moff, gauss_2d
 HISTORY:
       11-aug-94, jmm


twod_subs $SSW/yohkoh/ucon/idl/mctiernan/twod_subs.pro
[Previous] [Next]
	Pro twod_subs,ij,ipix,jpix,i,j
 Returns (i,j) the two-d subscripts of position ij in an (ipix,jpix) matrix
 CALLED BY
	HSI_LOCATE_FLARE [2], HSI_LOCATE_FLARE [4], box1_draw, box_lc_array, find_ftpts
	getmax, hsi_flare_position [1], hsi_flare_position [2], hsi_flare_position [3]
	hsi_flare_position [4], hsi_flare_position_image [1]
	hsi_flare_position_image [2], hsi_full_sun_image [1], hsi_full_sun_image [2]
	hsi_locate_flare [1], hsi_locate_flare [3], hsi_xy_test [1], hsi_xy_test [2]
	sat_av_arr, width_2d


TYoshida Lower rainbow color table TVscl $SSW/yohkoh/ucon/idl/tyoshida/tyltv.pro
[Previous] [Next]
NAME: T.Yoshida - Lower (rainbow) color table - TVscl
pro tyltv,image,xpos,ypos,xsize=xsize,ysize=ysize, $
	range=range,validregion=validregion,nullvalue=nullvalue
PURPOSE:
	Extended TVSCL for the T.Yoshida color table.
	This calls TYTV with 'crange=[1,100]'.
	See TYTV for the details.
	See also XTYOSHIDACT.
CALLING SEQUENCE:
	xtyoshidact,/nox
	tyltv,findgen(10,10),xsize=100
 CALLS: ***
	TYLTV, TYTV
HISTORY:
	ver. 1.0 95-11-30 T.Yoshida


TYoshida TV $SSW/yohkoh/ucon/idl/tyoshida/tytv.pro
[Previous] [Next]
NAME: T.Yoshida - TV
pro tytv,image,xpos,ypos,xsize=xsize,ysize=ysize,scale=scale, $
	range=sr,crange=cr,validregion=validregion,nullvalue=nullvalue
KEYWORDS:	Tool, Image Processing
PURPOSE:
	Extended TV ( or TVSCL with the parameter /scale )
	See also tyutv and tyltv.
CALLING SEQUENCE:
	tytv,findgen(10,10),xsize=256,/scale
	tytv,findgen(10,10),xsize=128,range=[20.5,62.5]
	tytv,findgen(10,10),xsize=128,crange=[1,100]
INPUTS:
	image	: A vector or two-dimensional array to be displayed.
	xpos	: The second parameter of 'TV'
	ypos	: The third parameter of 'TV'
INPUTS KEYWORDS:
	xsize	: X-size in device  coordinates
	ysize	: Y-size in device  coordinates
	range	: scale range (two-dimensional array)
	crange	: color table range (two-dimensional array)
	validregion	: Set the valid region on the image.
			(boolean array of the same size as image)
	nullvalue	: fill the invalid region with this color code
			when 'validregion' is set. (default: 0)
OPTIONAL KEYWORDS:
	scale	: Set the INPUT KEYWORDs
			range = [min(image),max(image)]
			crange = [0,!d.table_size-1]
		 This is ignored when range and/or crange are set.
CAUTIONS:
	This works on only the devices of 'X','WIN', and 'PS'.
 CALLS: ***
	MYCONGRID, NORMIMGC, TYTV
HISTORY:
	ver 1.0 95-11-30	T.Yoshida


TYoshida Upper red temperature color table TVscl $SSW/yohkoh/ucon/idl/tyoshida/tyutv.pro
[Previous] [Next]
NAME: T.Yoshida - Upper (red temperature) color table - TVscl
pro tyutv,image,xpos,ypos,xsize=xsize,ysize=ysize, $
	range=range,validregion=validregion,nullvalue=nullvalue
KEYWORDS:	Tool, Image Processing
PURPOSE:
	Extended TVSCL for the T.Yoshida color table.
	This calls TYTV with 'crange=[101,!d.table_size-2]'.
	See TYTV for the details.
	See also XTYOSHIDACT.
CALLING SEQUENCE:
	xtyoshidact,/nox
	tyutv,findgen(10,10),xsize=100
 CALLS: ***
	TYTV, TYUTV
HISTORY:
	ver. 1.0 95-11-30 T.Yoshida