This page was created by the IDL library routine mk_html_help2.

Last modified: Thu Apr 22 10:32:07 1999.

Directory Listing of Routines

/disks/aeolus/disk1/wind/source/idl/general/obsolete/

ADD_STR_ELEMENT
Obsolete.
CLIM
GET_3DP
GET_DATA_TIMES
GET_DENS_CORR
GET_GEO_MAG
GET_I8_MAG
GET_I8_PLA
Gets key parameter data from the IMP-8 plasma experiment.
GET_MFI
GET_MFI_3S
GET_MFI_ST
GET_ORBIT
GET_SUM
GET_SWE
Gets key parameter data from the WIND SWE experiment.
GET_WAV
Loads WAV key parameter data.
GET_WAV_LT
MAKE_ANY_PLOT
MOVIE_3D
SMOOTH_DATA_SPIKES
SMOOTHSPIKES
STORE_SUM
STR_TO_TIME
Obsolete. Use "time_double" instead.
TIME_TO_STR
Obsolete. Use "time_string" instead.

Routine Descriptions

ADD_STR_ELEMENT

PROCEDURE:   add_str_element, struct, tag_name, value
PURPOSE:
  Obsolete.
Replacement procedure:
  str_element,/add, struct,tag_name,value 
PURPOSE:   add an element to a structure (or change an element)
SEE ALSO:
  "STR_ELEMENT"
Warning:
  This procedure is slow when adding elements to large structures.

CREATED BY:	Davin Larson
LAST MODIFICATION:	@(#)add_str_element.pro	1.19 97/05/30

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/add_str_element.pro)

CLIM

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE:  clim , struct, min, max, type
PURPOSE:    adds the tag 'zrange' to the structure "struct"
	     this can then be used by "BYTESCALE"
	     to scale colors
INPUTS: 
   struct:  structure to be added to.  (Created if non-existent)
      If struct is a string then the limits structure associated with that
      string is used instead.
   min:     min value of yrange
   max:     max value of yrange
   type:    type of color scale, 1 = log, 0 = linear
Typical usage:
   clim,lim,-20,100

CREATED BY:	Jasper Halekas
LAST MODIFICATION:	@(#)clim.pro	1.3 95/10/06

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/clim.pro)

GET_3DP

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE:	get_3dp
PURPOSE:	Gets key parameter data for the 3DPlasma experiment from cdf
		files where it's stored.
INPUTS:	
	none, but calls "TPLOT/help.html#TIMESPAN">TIMESPAN" and asks for input if
	not already set
KEYWORDS:
       TRANGE: 2 element vector specifying the time range desired.

CREATED BY:	Davin Larson
LAST MODIFICATION:	@(#)get_3dp.pro	1.15 96/08/05

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/get_3dp.pro)

GET_DATA_TIMES

[Previous Routine] [Next Routine] [List of Routines]

 FUNCTION:	get_data_times

 PURPOSE: 	To get an array of all the times loaded in memory for a
		given data type.
 
 INPUTS:	STRING data type.

 OUTPUTS:	array of time tags if successful, else 0D

 MODIFICATION HISTORY: Written 1995/09/22 By J. M. Loran

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/get_data_times.pro)

GET_DENS_CORR

[Previous Routine] [Next Routine] [List of Routines]

NAME:                  get_dens_corr
PURPOSE:               get the ratio of 3DP proton density to WAVES electron density
                       
CALLING SEQUENCE:      get_dens_corr
INPUTS:                trange: dblarr(2), start and stop time in seconds from
			1970-01-01
KEYWORD PARAMETERS:    index:  lonarr(2), indices of first and last time sample
			        an index of 0 refers to the first file record
			name: specifies a tplot name, default is 'ratio'
OUTPUTS:               stores 'ratio', 3DP H+ Dens/WAVES e- Dens
LAST MODIFICATION:     @(#)get_dens_corr.pro	1.2 96/08/21
CREATED BY:            Frank V. Marcoline, from Davin's get_*_lt procedures. 
FUTURE MODS NEEDED:    Check input index for proper range.  Optimize search
			through file. 
			(Something like point_lun,lun,index(0)*rec_len)

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/get_dens_corr.pro)

GET_GEO_MAG

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE:	get_geo_mag
PURPOSE:	Gets key parameter data from the Geotail magnetic field
		experiment
INPUT:	
	none but will call "TPLOT/help.html#TIMESPAN">TIMESPAN" and ask for input if
	time range not already set
KEYWORDS:
	none
LEGENDS:
	ge_pos: position of S/C in Re
	B: 3 componenets of B in gammas
	ge_B_mag:	 Magnitude of B
	ge_B_lamda: Angle between B vector and y-z plane
	ge_B_phi:   Angle between B vector in y-z plane and the z axis
	ge_B_th: Davin's theta angle (see cart_to_sphere.pro)
	ge_B_ph: Davin's phi angle


CREATED BY:	Tai Phan (modified from Davin Larson's get_mfi)
LAST MODIFICATION:	@(#)get_mfi.pro	1.8 95/09/07 (Mcfadden 95/1/8)

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/get_geo_mag.pro)

GET_I8_MAG

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE:	get_i8_mag
PURPOSE:	Gets key parameter data from the IMP-8 magnetic field
		experiment, such as Sc_pos_i8_mag, B_i8 (Bx, By, Bz),
		Bmag_i8,Bph_i8, Bth_i8, and Brms_i8
INPUT:	
	none but will call "TPLOT/help.html#TIMESPAN">TIMESPAN" and ask for input if
	time range not already set
KEYWORDS:
	none

CREATED BY:	Tai Phan (modified from Davin Larson's get_mfi)
LAST MODIFICATION:	@(#)get_mfi.pro	1.8 95/09/07

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/get_i8_mag.pro)

GET_I8_PLA

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE:	get_i8_pla
PURPOSE:
	Gets key parameter data from the IMP-8 plasma experiment.
	Gets , such as Sc_pos_i8_pla, Np, Vgse_i8, Vth
	
INPUT:	
	none but will call "TPLOT/help.html#TIMESPAN">TIMESPAN" and ask for input if
	time range not already set
KEYWORDS:
	none

CREATED BY:	Tai Phan and mods by J.McFadden (modified from Davin Larson's get_swe)
LAST MODIFICATION:	@(#)get_mfi.pro	1.8 95/09/07

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/get_i8_pla.pro)

GET_MFI

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE:	get_mfi
PURPOSE:	Gets key parameter data from the MFI experiment, such as Bexp,
		Bmag,Bph, and Bth.
INPUT:	
	none but will call "TPLOT/help.html#TIMESPAN">TIMESPAN" and ask for input if
	time range not already set
KEYWORDS:
	none

CREATED BY:	Davin Larson
LAST MODIFICATION:	@(#)get_mfi.pro	1.14 96/08/05

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/get_mfi.pro)

GET_MFI_3S

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE:	get_mfi_3s
PURPOSE:	Gets key parameter data from the WIND MFI magnetic field
		experiment
INPUT:	
	none but will call "TPLOT/help.html#TIMESPAN">TIMESPAN" and ask for input if
	time range not already set
KEYWORDS:
	none
LEGENDS:
	B3_gse: 3 componenets of B in GSE and nT
	B3_gsm: 3 componenets of B in GSM and nT
	B3_rms_gse: 3 componenets of Brms in GSE and nT
	B3_rms_gsm: 3 componenets of Brms in GSM and nT
	B3_mag:	 Magnitude of B
	B3_rms_mag: Magnitude of Brms
	B3_lamda_gse: Angle between B vector and y-z plane, in GSE
	B3_phi_gse:   Angle between B vector in y-z plane and the z axis
	B3_lamda_gsm: Angle between B vector and y-z plane, in GSM
	B3_phi_gsm:   Angle between B vector in y-z plane and the z axis

	B3_th_gse: Davin's theta angle (see cart_to_sphere.pro)
	B3_ph_gse: Davin's phi angle  
	B3_th_gsm: Davin's theta angle
	B3_ph_gsm: Davin's phi angle



CREATED BY:	Tai Phan (modified from Davin Larson's get_mfi)
LAST MODIFICATION:	@(#)get_mfi.pro	1.8 95/09/07

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/get_mfi_3s.pro)

GET_MFI_ST

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE:	get_mfi_st
PURPOSE:	Gets 3 second resolution data from the WIND MFI magnetic field
		experiment
INPUT:	
	none but will call "TPLOT/help.html#TIMESPAN">TIMESPAN" and ask for input if
	time range not already set
KEYWORDS:
	none
LEGENDS:
	B3: 3 componenets of B in GSE and nT

CREATED BY: Davin Larson  (modified from version by: Tai Phan)
FILE:  get_mfi_st.pro  
VERSION  1.3
LAST MODIFICATION: 96/08/05

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/get_mfi_st.pro)

GET_ORBIT

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE:	get_orbit
PURPOSE:	Gets orbital data and creates the plot quantity:
                      'GSE_pos_def'  (or 'GSE_pos_pre' if PREDICTED is set)
INPUT:		none, but will call "TPLOT/help.html#TIMESPAN">TIMESPAN" and get
		time if time trange not set.
KEYWORDS:
   TRANGE:  2 element vector specifying the time range desired.
   PREDICTED:  Uses predicted files instead of definitive files if set

CREATED BY:	Jasper Halekas
VERSION: get_orbit.pro  1.17
LAST MODIFICATION: 95/11/29

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/get_orbit.pro)

GET_SUM

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE:	get_sum
PURPOSE:	to read in summary data stored in cdf format.
INPUTS:	none, but will prompt for type of data desired if all keyword
		is not set.
KEYWORDS:	
	all:	load all the data

SEE ALSO:	"STORE_SUM", the procedure that creates
		the files this procedure reads.

CREATED BY:	Jasper Halekas
LAST MODIFICATION:	@(#)get_sum.pro	1.5 95/10/06

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/get_sum.pro)

GET_SWE

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE: get_swe
PURPOSE:
  Gets key parameter data from the WIND SWE experiment.
  This routine will produce the following "TPLOT" quantities:
  Np_swe, Vth_swe,  Vgse_swe
KEYWORDS:
  TIME_RANGE:  Optional two element double array specifying time range 
     to be loaded. See "TPLOT/help.html#GET_TIMESPAN">GET_TIMESPAN" for more default info.
RESTRICTIONS:
  This routine expects to find the master file: 'wi_k0_swe_files'
  In the directory specified by the environment variable: 'CDF_DATA_DIR'
  See "GET_FILE_NAMES" for more info.

CREATED BY:	Davin Larson
FILE:  get_swe.pro
LAST MODIFICATION: 96/06/26

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/get_swe.pro)

GET_WAV

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE:	get_wav
PURPOSE:	
  Loads WAV key parameter data.

INPUTS:	none, but will call "TPLOT/help.html#TIMESPAN">TIMESPAN" if time
		range is not already set.
KEYWORDS:	MOON:  Set to get Moon position data.

CREATED BY:    Davin Larson
FILE:  get_wav.pro
LAST MODIFICATION: 96/08/05

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/get_wav.pro)

GET_WAV_LT

[Previous Routine] [Next Routine] [List of Routines]

NAME:                  get_wav_lt
PURPOSE:               get 1/2 hour averages of WAVES data
                       
CALLING SEQUENCE:      get_wav_lt
INPUTS:                trange: dblarr(2), start and stop time in seconds from
			1970-01-01
KEYWORD PARAMETERS:    index:  lonarr(2), indices of first and last time sample
			        an index of 0 refers to the first file record
OUTPUTS:               stores 'wi_wav_lt' and 'wi_wav_Ne_lt'
LAST MODIFICATION:     @(#)get_wav_lt.pro	1.1 96/08/12
CREATED BY:            Frank V. Marcoline, from Davin's get_*_lt procedures. 
FUTURE MODS NEEDED:    Check input index for proper range.  Optimize search
			through file. 
			(Something like point_lun,lun,index(0)*rec_len)

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/get_wav_lt.pro)

MAKE_ANY_PLOT

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE:	make_any_plot
PURPOSE:	make summary plots in gif format
INPUT:		none
KEYWORDS:	dates:  array of date strings
		ps:	if set makes postscript instead of gif file

CREATED BY:	Jasper Halekas
LAST MODIFICATION:	@(#)make_any_plot.pro	1.4 95/11/20

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/make_any_plot.pro)

MOVIE_3D

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE: 	movie_3d
PURPOSE:	to store and animate 3dplots of data
INPUT:		
	data_name:	A string such as 'el' or 'so' that tells what kind
			of data to animate
			It is assumed that 
			"LOAD_3DP_DATA" has already 
			been called to load WIND data.	
KEYWORDS
	starttime:	time to start at, otherwise at first sample in data
	frames:		number of frames to animate, default is 10
	smooth:		smoothing parameter for plot3d
	bins:		array of which bins plot3d is to plot
	start,stop:	arrays of starting and ending energy steps for each plot

SEE ALSO:	"PLOT3D", which is the procedure that plots
		each frame of movie_3d's movies.

CREATED BY:	Jasper Halekas
LAST MODIFICATION:	@(#)movie_3d.pro	1.6 95/10/06

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/movie_3d.pro)

SMOOTHSPIKES

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE:	smoothspikes, data
PURPOSE:	To smooth out annoying time spikes from bad data
INPUT:		data array of times
KEYWORDS:	none yet

SEE ALSO:	"SMOOTH_DATA_SPIKES"

CREATED BY:	Jasper Halekas
LAST MODIFICATION:	@(#)smoothspikes.pro	1.16 95/10/06

NOTE:	This is now done automatically in "GET_SPEC"

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/smoothspikes.pro)

SMOOTH_DATA_SPIKES

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE:	smooth_data_spikes, data_name
PURPOSE:	to smooth out spikes in data, using 
		"SMOOTHSPIKES"
INPUT:		data_name: TPLOT handle  see "TPLOT"
KEYWORDS:	all
CREATED BY:	Jasper Halekas
LAST MODIFICATION:	@(#)smooth_data_spikes.pro	1.5 96/02/21

NOTE:	This is now done automatically in "GET_SPEC"

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/smooth_data_spikes.pro)

STORE_SUM

[Previous Routine] [Next Routine] [List of Routines]

PROCEDURE:	store_sum
PURPOSE:	to store summary information in CDF format
INPUTS:	none
KEYWORDS
	dates:	array of dates for which to create summary files

SEE ALSO:	"GET_SUM" which gets the files that 
		this procedure stores

CREATED BY:	Jasper Halekas
LAST MODIFICATION:	@(#)store_sum.pro	1.8 95/10/06

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/store_sum.pro)

STR_TO_TIME

[Previous Routine] [Next Routine] [List of Routines]

NAME:
   str_to_time
PURPOSE:
   Obsolete. Use "TIME_DOUBLE" instead.

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/str_to_time.pro)

TIME_TO_STR

[Previous Routine] [List of Routines]

NAME:
   time_to_str
PURPOSE:
   Obsolete. Use "TIME_STRING" instead.

(See /disks/aeolus/disk1/wind/source/idl/general/obsolete/time_to_str.pro)