Directory: general/misc/

Contents

.pro files

append_array.pro

PROCEDURE: append_array, a0, a1PURPOSE: Append an array to another array.

array_concat.pro

array_concat_wrapper.pro

FUNCTION: array_concat_wrapperPURPOSE: Wrapper for the array_concat function -- correctly handles the case when the input array is an empty stringInputs: arg: The argument to be concatenated array: The array to which it should be concatenated, or nothingOutput: array + arg$LastChangedBy: egrimes $$LastChangedDate: 2013-10-22 12:49:25 -0700 (Tue, 22 Oct 2013) $$LastChangedRevision: 13372 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/misc/array_concat_wrapper.pro $

array_cross.pro

FUNCTION array_cross(l1,l2) Purpose: returns a 2*n array, where n = n_elements(l1)*n_elements(l2) each pair is a combination of l1 and l2 the total list represents all possible pairings of l1 and l2 Written by Patrick Cruce $LastChangedBy: pcruce $ $LastChangedDate: 2009-03-11 11:10:36 -0700 (Wed, 11 Mar 2009) $ $LastChangedRevision: 5255 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/misc/array_cross.pro $

array_union.pro

average_str.pro

FUNCTION: average_str(data, res)PURPOSE: Average data in res second time segments.

bin1d.pro

Procedure: bin1d Purpose:Uses histogram to bin data according to array binarr.

bin2d.pro

Procedure: bin2d Purpose: A slightly simpler wrapper for vassilis's routine for 2-d binning NOTE: despite the fact that they are keywords either binsize or binnum must be set for the proceedure to function Inputs: x: the x components for the bins.

bin_centers.pro

bin_edges.pro

box.pro

bytescale.pro

FUNCTION: bytescale(array)PURPOSE: Takes an array or image and scales it to bytesINPUT: array of numeric values.

cart2latlong.pro

cart2spc.pro

cart_to_sphere.pro

***************************************************************************************** FUNCTION : cart_to_sphere.pro PURPOSE : Transforms from cartesian to spherical coordinates.

cdf_file_names.pro

FUNCTION: cdf_file_namesPURPOSE: Returns an array of filenames within a timerange.

colors_com.pro

COMMON BLOCK colors_comWARNING! Don't rely on this file to remain stable!USE "get_colors" to get color information.

crossp2.pro

FUNCTION: crossp2(a,b)INPUT: a,b: real(n,3) vector arrays dimension (n,3) or (3)PURPOSE: performs cross product on arraysCREATED BY: J.McFadden 97-3-14Modifications J.McFadden 05-2-7 changed first if to "if ndimen(a) eq 1 and ndimen(b) eq 1"

csvector.pro

Function: csvector Purpose: This procedure implements the create,add, and read methods for a traditional computer science data structure: the vector.The vector list of elements of any type and of any length.

data_avg.pro

dimen.pro

FUNCTION: dimen(x)PURPOSE: Returns the dimensions of an array as an array of integers.

dimen1.pro

FUNCTION: dimen1INPUT: matrixRETURNS: scaler int: size of first dimension (1 if dimension doesn't exist)CREATED BY: Davin LarsonLAST MODIFICATION; @(#)dimen1.pro 1.3 95/08/24

dimen2.pro

FUNCTION: dimen2INPUT: matrixRETURNS: scaler int: size of second dimension (1 if dimension doesn't exist)CREATED BY: Davin LarsonLAST MODIFICATION; @(#)dimen2.pro 1.3 95/08/24

dimen_shift.pro

FUNCTION: dimen_shift(x,shift)NAME: dimen_shiftPURPOSE: Rotate dimensions of a multidimensional array.

divide_data.pro

PROCEDURE: divide_dataPURPOSE: Divides successive channels of SST data by powers of 'factor', to separate the traces.

dpwrspc.pro

NAME: dpwrspcPURPOSE: Called with times time and data quantity, dpwrspc returns a dps spectrum at frequencies fdps.

dydt_spike_test.pro

NAME: dydt_spike_testPURPOSE: This function checks an array for spikes based on its time derivative.

escape_string.pro

function: escape_stringpurpose: adds \ to escape a list of charactersinputs: s: The string to be escaped list=list: an array of characters to be escaped.

euler_ang_rot_matrix.pro

FUNCTION: euler_ang_rot_matrix,eulerang [parameters=par]PURPOSE: returns rotation matrix given the euler angles (This function may be used with the "fit" curve fitting procedure.)KEYWORDS: PARAMETERS: a structure that contain the parameters that define the gaussians If this parameter is not a structure then it will be created.

euler_rot_matrix.pro

extract_tags.pro

PROCEDURE: extract_tags, newstruct, oldstructPURPOSE: takes the named tag elements from oldstruct and puts them into newstruct.

fancompress.pro

NAME: fancompressPURPOSE: Decimates polylines in an aesthetically pleasing fashion.

file_archive.pro

NAME: FILE_ARCHIVE PURPOSE: Archives files by renaming them and optionally moving them to another directory.

file_copy2.pro

Procedure: file_copy2

file_dailynames.pro

Procedure: FILE_DAILYNAMES Author: Davin Larson

file_http_copy.pro

WARNING: the interface to this routine is not yet solidified.

file_mkdir2.pro

PROCEDURE FILE_MKDIR2, dirPURPOSE: Wrapper for FILE_MKDIR that also sets the mode for each newly created directory.

file_open.pro

Procedure FILE_OPEN,type,namePurpose: wrapper for OPENW, OPENU, OPENR, FILE_MKDIRtype must be one of: 'w', 'u', 'r', 'd' (write, update, read, directory) This procedure performs the functions of creating/opening files and creating directories.

file_retrieve.pro

FUNCTION: FILE_RETRIEVE Purpose: FILE_RETRIEVE will download files from a remote web server and copy them into a local (cache) directory maintaining the directory structure.

file_retrieve_v.pro

Procedure: file_retrieve_vPurpose: Wrapper for file_retrieve that searches for highestavailable version first, with no need to retrieve remote-index.

file_source_dirname.pro

Function: file_source_dirnamePurpose: Returns the directory path of the source file which calls this function.

file_touch.pro

FILE_TOUCH Purpose: Wrapper routine for the "touch" program that sets file modification and access times USAGE: file_touch,'foo',systime(1)-300,/mtime ; sets mod time to 5 minutes ago keywords: MTIME set only modification time(UTC) ATIME set only access time(UTC) VERBOSE sets VERBOSITY of messages (0: error messages only, 6: lots) Restrictions: #1 Shell executable "touch" must be in path on local operating system.

find_const_intervals.pro

Procedure: FIND_CONST_INTERVALS Purpose: Find intervals within the input array where the data are constant to some tollerance, and return the begin and end indices into the original array for those intervals.

find_nearest_neighbor.pro

Name: find_nearest_neighbor Purpose: Uses binary search on a time series to find the array element closest to the target time Input: time_series: monotonically increasing time series array (stored as doubles) target_time: time to search for in the time series (double) Keywords: quiet: suppress output of errors sort: sort the input array prior to searching Output: Returns the value in time_series nearest to the target_time (as a double) Returns -1 if there's an error Examples: >> print, find_nearest_neighbor([1,2,3,4,5,6,7,8,9], 4.6) 5 >> print, find_nearest_neighbor([5,4,3,7,8,2,4,6,7], 7.6, /sort) 8 $LastChangedBy: egrimes $ $LastChangedDate: 2014-02-06 12:09:24 -0800 (Thu, 06 Feb 2014) $ $LastChangedRevision: 14176 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/misc/find_nearest_neighbor.pro $

find_str_element.pro

**** OBSOLETE!!! Please use "str_element"instead! ***FUNCTION: find_str_elementPURPOSE: find an element within a structure Input: struct, generic structure name, string (tag name) Purpose: Returns index of structure tag.

fname_to_time.pro

PROCEDURE: fname_to_time, fname, timePURPOSE: To translate the name of a standard WIND data file into the starting time of the data.

get_colors.pro

FUNCTION: get_colorsPURPOSE: returns a structure containing color pixel valuesINPUT: noneKEYWORDS: NOCOLOR: forces all colors to !d.table_size-1.

get_file_names.pro

PROCEDURE: get_file_names, fnamesPURPOSE: Gets an array of filenames within a time rangeINPUT: fnames: named variable in which the output array of filenames is placed.

get_file_names_ind.pro

PROCEDURE: get_file_names_ind, fnamesPURPOSE: Gets an array of filenames within a masterfile within a time rangeINPUT: fnames: named variable in which the output array of filenames is placed.

get_rt_path.pro

NAME: get_rt_pathPURPOSE: gets the directory of the calling routine.

grad.pro

Procedure: GradPurpose: Calculates the gradient of a 2d or 3d grid in one of two ways.

high_pass_filter.pro

NAME: high_pass_filterPURPOSE: subtracts running average from a data arrayCALLING SEQUENCE: y = high_pass_filter(array, time_array, no_time_interp=no_time_interp)INPUT: array = a data array time_array = a time array (in units of seconds) dt = the averaging time (in seconds) no_time_interp = if set, do *not* interpolate the data to the minimum time resolution.

histbins.pro

FUNCTION: H=histbins(R,XBINS)Purpose: Returns the histogram (H) and bin locations (XBINS) for an array of numbers.

histbins2d.pro

Function: h = histbins2d(x,y,xval,yval)Input: x, y, random variables to bin.

interp.pro

FUNCTION: interp(y,x,u)PURPOSE: Linearly Interpolates vectors with an irregular grid.

is_numeric.pro

Name: is_numericPurpose: determines if input string is a validly formatted number.

isdaylightsavingtime.pro

;Function: isdaylightsavingtimepurpose: returns 0 or 1 depending uponLimitations: Current only works for US time zones (-5 though -11) It will return 0 outside of these regions Arizona and Hawaii are unfortunately lumped together with the other 48 states.

makegif.pro

PROCEDURE: makegif, filenameNAME: makegifPURPOSE: Creates a GIF file from the currently displayed image.

makejpg.pro

PROCEDURE: makejpg, filenameNAME: makejpgPURPOSE: Creates a jpg file from the currently displayed image.

makepng.pro

PROCEDURE: makepng, filenameNAME: makepngPURPOSE: Creates a PNG file from the currently displayed image.

makeps.pro

NAME: makeps.proPURPOSE:OBSOLETE: please use tprint or popen and pclose A simple function to reliably and consistently do postscript export Right now it will export whatever your last tplot command was(ie current plot)CALLING SEQUENCE: makeps -or- makeps,'filename'INPUT: a filename or nothingOUTPUT: a postscript file to the specified location errors, grays out all buttons while processingNOTES: Will append a .ps to your filename whether you like it or not TODO: add an argument to accept a list of variables$LastChangedBy: pcruce $$LastChangedDate: 2008-04-14 15:50:24 -0700 (Mon, 14 Apr 2008) $$LastChangedRevision: 2719 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/misc/makeps.pro $

minmax.pro

FUNCTION: minmax,arrayPURPOSE: returns a two element array of min, max valuesINPUT: arrayKEYWORDS: MAX_VALUE: ignore all numbers greater than this value MIN_VALUE: ignore all numbers less than this value POSITIVE: forces MINVALUE to 0CREATED BY: Davin LarsonLAST MODIFICATION: @(#)minmax.pro 1.2 02/04/17

mk_html_help2.pro

NAME: MK_HTML_HELP2 PURPOSE: Creates a html document from a list of IDL procedures.

mso2lt.pro

ndimen.pro

FUNCTION: ndimenPURPOSE: Returns the number of dimensions in an array.

neutral_sheet.pro

NAME: sm_ns_modelPURPOSE: This routine calculates the position along the zaxis at a specific x and y location.

nn.pro

NAME: nnPURPOSE: Find the index of the data point(s) nearest to the specified time(s)CALLING SEQUENCE: ind=nn(data,time)INPUTS: data: a data structure, a tplot variable name/index, or a time array time: (double) seconds from 1970-01-01, scalar or array if not present, "ctime" is called to get time(s)OPTIONAL INPUTS: noneKEYWORD PARAMETERS: x, y, & v: set to named keywords to return the values of the x, y, & v arrays, if applicableOUTPUTS: a long scalar index or long array of indicies on failure, returns: -2 if bad inputs, -1 if nearest neighbor not foundEXAMPLE: ctime,times,npoints=2 inds=nn('Np',times) get_data,'Np',data=dens & get_data,'Tp',data=temp plot,dens.y(inds(0):inds(1)),temp(inds(0):inds(1))LAST MODIFICATION: @(#)nn.pro 1.8 02/04/17CREATED BY: Frank Marcoline

oplot_err.pro

PROCEDURE: oplot_err, x, low, high PURPOSE: Plot error bars over a previously drawn plot.

pclose.pro

PROCEDURE: pcloseINPUT: nonePURPOSE: Close postscript file opened with popen, and change device back to default.

plot_positions.pro

FUNCTION: plot_positionsPURPOSE: Procedure that will compute plot positions for multiple plots per page.

popen.pro

PROCEDURE: popen, filenamePURPOSE: Change plot device to postscript.

popen_com.pro

COMMON BLOCK: popen_comPURPOSE: Common block for print routinesSEE ALSO: "popen","pclose", "print_options"CREATED BY: Davin LarsonLAST MODIFICATION: @(#)popen_com.pro 1.10 97/12/05

print_options.pro

PROCEDURE: print_optionsPURPOSE: controls postscript printing optionsKEYWORDS: PORT: print pages in portrait format (default) LAND: print pages in landscape format BW: Use black and white mode (untested) COLOR: Use Color postscript (default) XSIZE: plot size dimension in the x direction YSIZE: plot size dimension in the y direction UNITS: plot size units (inches or cm)FUTURE OPTIONS: Ecapsulated postscript format changing plotting areaHISOTRY: 4-apr-2008 cg, added optional keywords for postscript file size and file size unitsSEE ALSO: "popen","pclose"CREATED BY: Davin LarsonLAST MODIFICATION: @(#)print_options.pro 1.16 97/05/30

printdat.pro

PROCEDURE: printdat,[x]PURPOSE: Displays information and contents of a data variable.

ptr_extract.pro

NAME: ptr_extractFunction: ptrs = ptr_extract(p,EXCEPT=EXCEPT)Purpose: Recursively searches the input (of any type) and returns an array of all pointers found.

ptrace.pro

FUNCTION: PTRACE()PURPOSE: Returns a string that provides the current program location.

pwrspc.pro

NAME: pwrspcPURPOSE: Called with times time and data quantity, PWRSPC returns a power spectrum power at frequencies freq.

read_ascii_cmdline.pro

NAME: READ_ASCII_CMDLINE PURPOSE: Read data from an ASCII file into IDL.

reduce_timeres.pro

regplot.pro

repath.pro

root_data_dir.pro

FUNCTION: root_data_dirPURPOSE: Returns the root data directory used by numerous file retrieval procedures.

rotate_x.pro

rotate_y.pro

rotate_z.pro

roundsig.pro

scpot_overlay.pro

NAME: scpot_overlayPURPOSE: Overlays a spacecraft potential (or similar line function) over a spectrogramCALLING SEQUENCE: cvar = scpot_overlay(pvar, svar)INPUT: pvar = a tplot variable containing the spacecraft potential svar = a tplot variable containing a spectrogramOUTPUT: cvar = a compound tplot variable name containing the combined spectrum variable with the SC pot overlaid.

set_zeros.pro

setbp.pro

PROCEDURE: setbp, module This procedure will set BREAKPOINTS at all lines within a program module file that contain the string: ";bp" A conditional break point is set with ;bpif condition statementInput: module (string)Purpose: This is a DEBUGGING tool that is used to set breakpoints.

share_colors.pro

PROCEDURE: share_colorsPURPOSE: Procedure that allows multiple IDL sessions to share the same color table.

simple_despike_1d.pro

Simple 1d despike, hacked from SXI_despike CALLING SEQUENCE: result=simple_despike_1d(image) INPUTS: image = 1-D image array (float or integer) to be cleaned OUTPUTS: result = Cleaned 1-D image array (float) KEYWORDS: spike_threshold = Median filter threshold for good pixel map width = width of median filter in each direction, default is 3 points use_nan = if set, instead of using the median value as a replacement for a spike, insert a NaN value jmm, 2013-02-12, testing SVN messaging jmm, 2013-02-12, testing SVN messaging, yet again$LastChangedBy: jimm $$LastChangedDate: 2014-02-12 13:21:15 -0800 (Wed, 12 Feb 2014) $$LastChangedRevision: 14361 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/misc/simple_despike_1d.pro $

smooth_in_time.pro

NAME: smooth_in_timePURPOSE: Runs smooth for irregular grids, after regularising gridCALLING SEQUENCE: ts = smooth_in_time(array, time_array, dt, /backward, /forward, /double, /no_time_interp)INPUT: array = a data array, can be 2-d (ntimes, n_something_else), the first index is smoothed or averaged.

space_bar.pro

Procedure: space_bar Purpose: generates a horizontal bar stored in a tplot variable that is used to adjust the spacing between tplot variables in plots Arguments: n(positional,required): a double representing the height of the space bar newname(keyword,optional): the name you want the bar to have(default: 'space_bar') $LastChangedBy: pcruce $ $LastChangedDate: 2008-01-17 14:37:52 -0800 (Thu, 17 Jan 2008) $ $LastChangedRevision: 2286 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/tplot/tplotxy.pro $

spc2cart.pro

spd_default_local_data_dir.pro

NAME: spd_default_local_data_dirPURPOSE: Returns the default data directory for file downloads for varius projects.

ssl_correlate_tplot.pro

NAME: ssl_correlate_tplot PURPOSE: Identified the amount of shift required to correlate two time series tplot variables and stores the result in a tplot variable.

ssl_correlation_shift.pro

NAME: ssl_correlation_shift PURPOSE: Calculates the shift required to correlate two tme series of data.

ssl_set_complement.pro

Purpose: Calculates the complement of l2 - l1 (ie set difference)Arguments: l1 subset,l2 supersetNotes: empty set is -1L all inputs must be empty set or arrays all outputs will be empty set or arrays Arrays must be of homogenous type

ssl_set_intersection.pro

Purpose: Performs an intersection of two setsParameters: l1,l2 sets(arrays) for which the intersection iscalculatedReturns: -1L on empty set, otherwise intersection of the two setsNotes: empty set is -1L all inputs must be empty set or arrays all outputs will be empty set or arrays Arrays must be of homogenous type

ssl_set_symbol.pro

Procedure: ssl_set_symbolPurpose: 1) Set the user defined plotting symbol to be used with psym=8, or 2) Return a graphics object of the specified symbolCalling Sequence: ssl_set_symbol, index [,fill=fill] [,size=size] [,fail=fail] [,object=object, [,obj_size=obj_size] [,color=color]]Arguments: INDEX: Number of the symbol that is desired: 1: Plus sign 2: Star 3: Circle 4: Diamond 5: Triangle 6: Square 7: X 42: Lemniscate FILL: Flag to fill the symbol (solid) SIZE: Number specifying the size of the symbol (default=1.0) (not valid if used with OBJECT) OBJECT: If called this keyword will return an IDLgrSymbol object of the requested type OBJ_SIZE: Two element array specifying the returned graphics object's x and y size respecively.

ssl_set_union.pro

FUNCTION ssl_set_union(set1,set2)Purpose: returns the union of two setsNotes: empty set is -1L all inputs must be empty set or arrays all outputs will be empty set or arrays Arrays must be of homogenous type

ssl_time_check.pro

PROCEDURE: ssl_time_check.proPURPOSE: prints information about gaps between timestamps in cdf filesINPUT: dir: The directory in which to search for cdfs out: the output directory for the limit files LIM: reassign the limit if you want it is a 2 element array MNEM: optional regex to filter timestamp mnemsKEYWORDS: noneCOMMENTS: Will check all timestamps for all cdfs in the directory andoutput a seperate file for each type of timestamp.

str_element.pro

PROCEDURE: str_element, struct, tagname, valuePURPOSE: Find (or add) an element of a structure.

str_replace.pro

str_sub.pro

strfilter.pro

FUNCTION: res = strfilter(stringarray,searchstring)PURPOSE: Returns the subset of stringarray that matchs searchstring '*' will match all (non-null) strings '' will match only the null string Output can be modified with keywords NOTE: this routine is very similar to the STRMATCH routine introduced in IDL 5.3 it has some enhancements that make it useful.

strippath.pro

FUNCTION: STRIPPATH DESCRIPTION: Function that strips off any directory components from a full file path, and returns the file name and directory components seperately in the structure: {file_cmp_str,file_name:'file',dir_name:'dir'} This is only implemented for UNIX at this time.

struct_value.pro

FUNCTION: struct_value(struc,name,default=default,index=index)PURPOSE: Returns the value of a structure element.

tag_names_r.pro

FUNCTION: TAG_NAMES_R(STRUCTURE, [TYPE=dt] ) PURPOSE: Very similar to the TAG_NAMES function but recursively obtains all structure names within imbedded structures as well.

tclip.pro

NAME: tclipPURPOSE: Wrapper for xclip.pro allowing input of tplot variable names.

tcs_is_array.pro

NAME: tcs_is_array PURPOSE: Helper function: tests if argument is array, 1L on success 0L on failure;$LastChangedBy: lphilpott $$LastChangedDate: 2012-06-25 15:20:30 -0700 (Mon, 25 Jun 2012) $$LastChangedRevision: 10638 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/misc/tcs_is_array.pro $

tdeflag.pro

NAME: tdeflagPURPOSE: wapper for xdeflag.pro allowing input of tplot variable namesCALLING SEQUENCE: tdeflag, varnames, method, newname = newname, $ overwrite = overwrite, _extra = _extraINPUT: varnames = an array (or scalar) of tplot variable names method = set to "remove_nan", this will remove any NaN (or infinite) values from the data (potentially returning shortened or empty arrays) set to "repeat", this will repeat the last good value.

tdegap.pro

NAME: tdegapPURPOSE: wrapper for xdegap.pro allowing input of tplot variable namesCALLING SEQUENCE: tdegap, varnames, dt=dt, margin=margin, maxgap=maxgap,$ newname=newname, overwrite=overwriteINPUT: varnames = an array (or scalar) of tplot variable namesKEYWORDS: dt = the nominal time resolution of the data that will be inserted, the default is to choose the median of the input time array margin = the margin used to determine if a gap is big enough, the default is 0.25 seconds maxgap = the maximum gap size that will be allowed to be filled, in units of dt.

tdespike_ae.pro

Name: TDESPIKE_AE Purpose: This routine removes artificial spikes.

tdpwrspc.pro

NAME: tdpwrspcPURPOSE: wapper for dpwrspc.pro allowing input of a tplot variable nameCALLING SEQUENCE: tdpwrspc, varname, newname=newname,_extra=_extraINPUT: varname = one tplot variable nameKEYWORDS: newname = if set,give this name to the new data, the default is to append '_dpwrspc' to the input name and pass out the name in the newname variable, Unless /overwrite is set.

thigh_pass_filter.pro

PROCEDURE: thigh_pass_filter, varname, dt, newname = newnamePURPOSE: Uses high_pass_filter to calculate a running average of the input data and store the data with the running average subtracted in an output tplot variable.

time_average.pro

Function: time_average Calculates a bin based average over time series data Uses a histogram internally so it should be pretty quick Arguments: time: the time array for the input timeseries data: the data array for the input timeseries newtime(optional): named variable in which to return the times for each bin upon which an average is calculated trange(optional): a time range over which the average is performed resolution(optional): the size of each bin in seconds ret_total(optional): named variable in which totals for each bin are returned ret_min(optional): named variable in which mins for each bin are returned ret_med(optional): named variable in which medians for each bin are returned $LastChangedBy: aaflores $ $LastChangedDate: 2012-01-24 09:39:41 -0800 (Tue, 24 Jan 2012) $ $LastChangedRevision: 9596 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/misc/time_average.pro $

time_clip.pro

Procedure: time_clipPurpose: clips a tplot variable between a start time and an end timeInputs: tplot_var_name: the name of the variable to be clipped start_time: the start time for the clipping(double or string) end_time: the end time for the clipping(double or string)Keywords: newname(optional): the name of the output tplot variable otherwise it will be tplot_var_name+'_tclip' tvar(optional): set this keyword and start_time and end_time will be interpreted as the names of tplot variables The start and end times will then be taken from the first and last component of the tplot variables listed replace(optional): set this to replace the variable, rather than create a new one error(optional): set this to a named variable to return the error status of the function, it will return 0 for no error and 1 to signal an error.

time_stamp.pro

PROCEDURE: time_stamp,charsize=charsizePURPOSE: Prints a time stamp along the lower right edge of the current plot boxKEYWORDS: CHARSIZE: The character size to be used.

time_ticks.pro

FUNCTION: time_tk_str = time_ticks(timerange,offset)NAME: time_ticksPURPOSE: Returns a structure that can be used to create time ticks for a plot.

tinterpol.pro

Function: tinterpolPurpose:Wrapper for tinterpol_mxn.

tkm2re.pro

Procedure: tKm2RePurpose: Converts a variable to RE or KMInputs: name: a string naming the tplot variable to be modified globbing may be usedKeywords: newname: set this keyword to a string to store the output in(only works when globbing is not used) suffix: set this keyword to a string indicating the suffix to be appended to the input variable(s) /replace: set this option to replace the variable being modified /KM : converts to KM from RE rather than to RE from KM examples: tKm2Re,'thb_state_pos' tKm2Re,'thb_state_pos',/replace tKm2Re,'thb_state_pos',/KM tKm2Re,'thb_state_pos',newname='pos_in_re' tKm2Re,'th?_state_pos',suffix='_converted' NOTES: Uses conversion of 6374.4 KM/RE By default output will be called: input_name+'_RE'$LastChangedBy: pcruce $$LastChangedDate: 2008-07-30 17:43:17 -0700 (Wed, 30 Jul 2008) $$LastChangedRevision: 3320 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/misc/tkm2re.pro $

tpwrspc.pro

NAME: tpwrspcPURPOSE: wrapper for pwrspc.pro allowing input of a tplot variable name.

trange_str.pro

FUNCTION: trange_str,t1,t2INPUT: t1,t2 doubles, seconds since 1970OUTPUT: string with the format: 'YYYY-MM-DD/HH:MM:SS - HH:MM:SS'CREATED BY: Davin LarsonLAST MODIFICATION: @(#)trange_str.pro 1.10 97/12/22

tsmooth_in_time.pro

PROCEDURE: tsmooth_in_time, varname, dt, newname = newnamePURPOSE: Calls smooth_in_time function on a plot variableINPUT: varname = variable passed to get_data, example - thg_mag_ccnv dt = the averaging time (in seconds)KEYWORDS: newname = set output variable name display_object = Object reference to be passed to dprint for output.

tsub_average.pro

NAME: tsub_averagePURPOSE: Subtracts average or median values from the data in a tplot variable, returns a new variable, only one at a time for nowCALLING SEQUENCE: tsub_average, varname, out_name, new_name=new_name,median=medianINPUT: varname = a tplot variable nameOUTPUT: out_name = variable name of the output tplot variableKEYWORDS: new_name = can be used to input the new variable name, if not input the default is to add a '-d' to the input name (or '-m' for median subtraction) and the name is passed out in this variable display_object = Object reference to be passed to dprint for output.

tuserdef.pro

NAME: tuserdefPURPOSE: Inputs a string expression that operates on a tplot variable, or an array of tplot variables, and returns the result.

tvectot.pro

Procedure: tvectot(tplot vector total)Purpose: Add or remove the magnitude of a vector to a tplot quantityInputs: name: a string naming the tplot variable to be modified, mayuse regexKeywords: /remove: set this keyword to remove the magnitude from vector newname: set this keyword to a string to store the(this option will not work properly if regex is used) output in a different variable instead of overwriting tot: set this keyword to a named variable to store the magnitude as an array or set it to a string to store the magnitude as a tplot variable(this option will not work properly if regex is used) examples: tvectot,'tha_fgs_dsl' tvectot,'tha_fgs_dsl',/remove tvectot,'tha_fg*_dsl' tvectot,'tha_fgs_dsl',newname='tha_fgs_dsl_mag' tvectot,'tha_fgs_dsl',tot=var tvectot,'tha_fgs_dsl',tot='mag_t_var'$LastChangedBy: pcruce $$LastChangedDate: 2012-01-27 11:23:20 -0800 (Fri, 27 Jan 2012) $$LastChangedRevision: 9637 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/misc/tvectot.pro $

undefined.pro

NAME: undefinedPURPOSE: Tests whether a variable is undefinedCALLING SEQUENCE: if ~undefined(var) then print,'Hooray!' INPUT: var: A variable to be testedOUTPUT: 1 on success, 0 on fail $LastChangedBy: pcruce $ $LastChangedDate: 2008-07-28 11:53:49 -0700 (Mon, 28 Jul 2008) $ $LastChangedRevision: 3311 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/misc/undefined.pro $

wi.pro

PROCEDURE: wi, wnumPURPOSE: Switch or open windows.

write_ascii.pro

write_ascii_cmdline.pro

xclip.pro

xclipPURPOSE: Replaces with FLAGs the values of the array that are BEYOND the limits specified.

xdeflag.pro

xdeflagPURPOSE: Replaces FLAGs in arrays with interpolated or other valuesCALLING SEQUENCE: xdeflag, method, t, y, flag=flag, _extra=_extraINPUT: method = set to "repeat", this will repeat the last good value.

xdegap.pro

NAME: xdegapPURPOSE: Locates gaps in data, and fills in with NaN This subroutine accepts the time array (can be cline time) t and the multi-dimensional array yarr that matches with the time array.