Directory: general/missions/rbsp/efw/utils/

Contents

.pro files

expand_tilde.pro

NAME: EXPAND_TILDE() PURPOSE: Expand tilde in UNIX directory names CALLING SEQUENCE: IDL> output=expand_tilde(input) INPUTS: INPUT = input file or directory name, scalar string OUTPUT: Returns expanded filename, scalar string EXAMPLES: output=expand_tilde('~zarro/test.doc') ---> output='/usr/users/zarro' NOTES: This version of EXPAND_TILDE differs from the version in the Solar Library in that it does not call the functions EXIST and IDL_RELEASE.

findpath.pro

NAME: findpath.pro SYNTAX: PURPOSE: Finds the path to a particular file in current IDL paths ARGUMENTS: FILENAME -> Name of the file to find - STRING PATH <- Path to file (without "/") - STRING RETURNS: Status of find 0 - Failure 1 - Success (exact match) 2 - Success (after adding ".pro") KEYWORDS: EXACT / Find exact match only (Don't try to add '.pro') VERBOSE / Print out search pathes CALLING SEQUENCE: found=findpath('filename',pathname) case found of 0 : ERROR 1 : fullpath=pathname+'/'+filename 2 : fullpath=pathname+'/'+filename+'.pro' endcase or if not findpath('filename',path,/exact) then ERROR NOTES: By default, FINDPATH searches for exact match.

jbt_date2jday.pro

NAME: jbt_date2jday (function) PURPOSE: Convert a date string in format 'yyyy-mm-dd', such as '2012-10-16', into a longword integer Julian day number.

jbt_extrema.pro

NAME: jbt_extrema (function) PURPOSE: Find extrema in a numerical array and return their indices.

jbt_fexist.pro

NAME: jbt_fexist (function) CATEGORY: PURPOSE: Check the existence of a local file.

jbt_file_latest.pro

NAME: jbt_file_latest (function) PURPOSE: Return the path of the latest file within a folder.

jbt_fileurls.pro

NAME: PURPOSE: Retrieve a list of files on a remote directory accessible via http.

jbt_get_lines.pro

NAME: jbt_get_lines (function) PURPOSE: Get all lines of a text file.

jbt_iconsec.pro

NAME: jbt_iconsec (function) CATEGORY: PURPOSE: Given an array of indices, find consecutive sections in the array, and return the starting and ending indices of each section.

jbt_jday2date.pro

NAME: jbt_jday2date (function) PURPOSE: Convert a longword integer Julian day number into a date string in format 'yyyy-mm-dd', such as '2012-10-16'.

jbt_tplot_pos.pro

NAME: jbt_tplot_pos (function) PURPOSE: Get the positions of tplot panels.

rbsp_btrange.pro

NAME: rbsp_btrange (procedure) PURPOSE: This routine is to find the starting time and ending time of each continuous segment (burst, usually) of a give tplot variable which essentially is specified by a tplot name such as 'rbspa_efw_eb2'.

rbsp_decimate.pro

NAME: rbsp_decimate (procedure) PURPOSE: Decimate a tplot variable.

rbsp_min_var.pro

FUNCTION: rbsp_min_var.proPURPOSE: Minimum Variance AnalysisARGUMENTS: X_DATA -> X component of original data Y_DATA -> Y component of original data Z_DATA -> Z component of original dataRETURNS: Minimum variance rotation matix (Eigen vectors, min to max) 0 on failure The returned matrix is in the rotation matrix form where N = R * O where N = New matrix (Rotated into Min.

rbsp_min_var_rot.pro

***************************************************************************************** FUNCTION : rbsp_min_var_rot.pro PURPOSE : Calculates the minimum variance matrix of some vector array of a particular input field along with uncertainties and angular rotation from original coordinate system.

rbsp_rotate_field_2_vec.pro

NAME: rotate_field_2_vec.pro SYNTAX: rbsp_rotate_field_2_vec,'waveform','vec' where 'waveform' is a tplot variable and 'vec' is either a tplot variable or an array of [3] PURPOSE: Returns the input waveform or vector rotated to one of the following systems.

rbsp_sample_rate.pro

NAME: rbsp_sample_rate.pro SYNTAX: PURPOSE: Determines the sample rate of an input time series of data with the ability to set gap thresholds to avoid including them in the calculation.

tplot_zoom.pro

NAME: tplot_zoom (procedure) PURPOSE: This is basically a wrapper of some of the functions of tlimit and timebar.

tplot_zoom_com.pro