![[attach.png]](../../../idldoc-resources/attach.png)
Directory: projects/themis/common/
Contents
.pro files
- blank_panel.pro
Purpose: Helper routine used by thm_fitgmom_overview and thm_fitmom_overviews Makes a blank panel if proper data quantities are not present $LastChangedBy: lphilpott $ $LastChangedDate: 2012-06-14 10:41:59 -0700 (Thu, 14 Jun 2012) $ $LastChangedRevision: 10558 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/blank_panel.pro $
- num_to_str_pad.pro
Procedure: num_to_str_padPurpose: This is a very basic operation that gets repeated a lot in date file output.
- thm_addslash.pro
NAME: thm_addslashPURPOSE: Adds a trailing slash to a string, (usually a directory name) if it does not already have one.
- thm_blank_panel.pro
Purpose: Helper routine used by thm_fitgmom_overview and thm_fitmom_overviews Makes a blank panel if proper data quantities are not present $LastChangedBy: lphilpott $ $LastChangedDate: 2012-06-15 11:34:58 -0700 (Fri, 15 Jun 2012) $ $LastChangedRevision: 10568 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/thm_blank_panel.pro $
- thm_check_valid_name.pro
NAME:thm_check_valid_namePURPOSE:checks a string or array input against another array and 'all' tofind matches.
- thm_component_to_tplot.pro
FUNCTION: thm_component_to_tplot, plot_type, active_vnamesPURPOSE: Checks the plot type (SPACECRAFT or COMPONENTS) and creates (if necessary) new tplot variablesINPUT: active_vars string array of variable names (these are the active variables that are currently available) cw gui id for history window mw gui id for progress windowOUTPUT: new_vars string array of new active variables, these variables are regrouped by SPACECRAFT or COMPONENTKEYWORDS:SEE ALSO: "STORE_DATA", "GET_DATA", "SPLIT_VEC", "OPTIONS", "TPLOT"CREATED BY: Cindy GoethelMODIFICATION BY:LAST MODIFICATION:
- thm_config.pro
PRO themis_config This procedure serves as the themis configuration file.
- thm_config_filedir.pro
Function: thm_config_filedir.proPurpose: Get the applications user directory for THEMIS data analysis software$LastChangedBy$$LastChangedDate$$LastChangedRevision$$URL$
- thm_data2load.pro
- thm_data_calibrated.pro
Function: THM_DATA_CALIBRATED Purpose: Determine whether the data stored in a particular TPLOT variable has already been calibrated by examining the contents of it's DLIMIT structure.
- thm_esa_overviews.pro
Purpose:Generates esa overview plots for a given datethis includes one day long plot and 4 1/4 day plotsIt stores these plots in the current directoryArguments: date: the date for which the plots will be generated directory(optional): an optional output directory device(optional):switch to 'z' device for cron plottingExample: thm_esa_overviews,'2007-03-23',dir='~/out',device='z' $LastChangedBy: jimm $ $LastChangedDate: 2013-09-21 15:01:46 -0700 (Sat, 21 Sep 2013) $ $LastChangedRevision: 13118 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/thm_esa_overviews.pro $
- thm_ffffbk_composite.pro
NAME: thm_ffffbk_compositePURPOSE: Creates a composite FFF and FBK tplot variable for overview plotsCALLING SEQUENCE: var = thm_ffffbk_composite(fffvar, fbkvar, scale = scale, $ min_gap = min_gap)INPUT: fffvar = the name of the FFF variable fbkvar = the name of the FBS variableOUTPUT: var = the name of the composite variable, will be fbkvar+'_mix'KEYWORDS: scale = scale factor to multiply the FFF data, the default is 1.0 min_gap = the minimum gap size for FFF data, FBK data will not be inserted into gaps smaller than this.
- thm_fftfbk_overplot.pro
NAME: thm_fftfbk_overplotPURPOSE: Creates overview plots of FBK and FFT (in fast-survey FFF mode) for all probes.
- thm_fgm_fit_correlate_tplot.pro
NAME: thm_fgm_fit_correlate_tplot.pro Purpose: Uses ssl_correlation_shift.pro to do a correlation shift analysis on the vector lengths(math not cs vectors) of a selected fgm mnemonic and fit data CATEGORY: THEMIS-SOC CALLING SEQUENCE: pro thm_fgm_fit_correlate_tplot,fit_name, fgm_name, store_name, correlation_floor = correlation_floor, point_number = point_number, lag_step_number = lag_step_number, time_step_size = time_step_size, bin_size = bin_size INPUTS: fit_name: the tplot name of the fit data to be compared.
- thm_fgm_overviews.pro
Purpose:Generates fgm overview plots for a given datethis includes one day long plot and 4 1/4 day plotsIt stores these plots in the current directoryArguments: date: the date for which the plots will be generated directory(optional): an optional output directory device(optional):switch to 'z' device for cron plotting $LastChangedBy: aaflores $ $LastChangedDate: 2012-01-24 11:22:53 -0800 (Tue, 24 Jan 2012) $ $LastChangedRevision: 9600 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/thm_fgm_overviews.pro $
- thm_fgm_shell.pro
Purpose: wrapper for the thm_fgm_overviews procedure Arguments: date(optional): the input date (default: current date) reprocess(optional): set this keyword to reprocess all the plots test_reprocess(optional): set this keyword to perform jimm's reprocessing test directory(optional): the directory into which pngs will be output (default: current working directory) $LastChangedBy: aaflores $ $LastChangedDate: 2012-01-06 12:37:07 -0800 (Fri, 06 Jan 2012) $ $LastChangedRevision: 9507 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/thm_fgm_shell.pro $
- thm_file_cleanup.pro
NAME: thm_file_cleanupPURPOSE: returns a list of old files that may be deleted, optionally deletes filesCALLING SEQUENCE:files= thm_file_cleanup(filespec,print=print, $ sort_atime=sort_atime,sort_mtime=sort_mtime,$ sort_size=sort_size,reverse=reverse, $ delete_files=delete_files, days_to_keep=days_to_keep)INPUT: filespec = what kind of file is to be deleted, the default is '*.cdf'OUTPUT: files = the list of files to be deletedKEYWORDS: print = print the list of files sort_atime = sort files by Atime - last access time sort_mtime = sort files by mtime - last modified time sort_size = sort by size days_to_keep = the number of days old, beyone which we delete the files, the default is to delete files that have not been accessed in the last 30 days Delete_files = if set, delete the files, This must be set for the files to be deleted.
- thm_file_download.pro
PROCEDURE: thm_file_downloadPURPOSE: This is a general purpose routine will download all THEMIS data files within a given time range.
- thm_file_download2.pro
- thm_fitgmom_overviews.pro
Purpose:Generates a set of field and moment plots.
- thm_fitmom_overviews.pro
Purpose:Generates a set of field and moment plots.
- thm_fix_spec_units.pro
Procedure: thm_fix_spec_unitsPurpose: CDF2TPLOT automatically places the units in the y axis subtitle regardless of whether the variable is scpectrographic.
- thm_gen_multipngplot.pro
NAME: thm_gen_multipng_plotPURPOSE: Creates full day, 6 hour and 2 hour png files for data for a given day, Note that the data must have already been plotted for this routine to work properly.
- thm_gen_overplot.pro
NAME: thm_gen_overplotPURPOSE: To make mission overview plots of all instruments This can be called either from SPEDAS GUI or from a server script to create png imagesCALLING SEQUENCE: thm_gen_overplotINPUT: noneKEYWORDS: PROBES: spacecraft ('a','b','c','d','e') DATE: the date string or seconds since 1970 ('2007-03-23') DUR: duration (default units are days) DAYS: redundant keyword to set the units of duration (but its comforting to have) HOURS: keyword to make the duration be in units of hours DEVICE: sets the device (x or z) (default is x) MAKEPNG: keyword to generate 5 png files DIRECTORY: sets the directory where the above pngs are placed (default is './') FEARLESS: keyword that prevents program from quitting when it fears its in an infinite loop (infinite loop is feared when catch statement has been call 1000 times) DONT_DELETE_DATA: keyword to not delete all existing tplot variables before loading data in for the overview plot (sometimes old variables can interfere with overview plot) gui_plot: 1 for gui plot, 0 for server plot no_draw: flag passed to tplot_gui for gui overview plots error: 0 if it run to the endOUTPUT: A set of png files or a set of plots for the GUIEXAMPLES: thm_gen_overplot,probe='a',date='2007-03-23',dur=1 The above example will produce the overview plots for a full day in the X window.
- thm_graphics_config.pro
PRO thm_graphics_config This routine does just the graphics configuration for themis.
- thm_gui.pro
NAME: thm_guiPURPOSE: GUI for THEMIS data analysisCALLING SEQUENCE: thm_guiINPUT: none Keywords: Reset - If set will reset all internal settings.
- thm_gui_new.pro
NAME: thm_gui_newPURPOSE: GUI for THEMIS data analysisCALLING SEQUENCE: thm_gui_newINPUT: none Keywords: Reset - If set will reset all internal settings.
- thm_init.pro
PROCEDURE: thm_initPURPOSE: Initializes system variables for themis.
- thm_load_proc_arg.pro
Procedure: THM_LOAD_PROC_ARGPurpose: Generic argument validation routine for THEMIS Data File Loading routines, meant to be called by instrument-specific thm_load procedures.
- thm_load_xxx.pro
Procedure: THM_LOAD_XXXPurpose: Generic THEMIS Data File Loading routine, meant to be called by type specific thm_load procedures.
- thm_memory_plots.pro
NAME: thm_memeory_plotsPURPOSE: the plots show the number of raw data packets in satellite memoryCALLING SEQUENCE: thm_memory_plots,date=date,dur=durKEYWORDS: date = the start date for the plots dur = duration for the plots nopng = if set, do not create a png file directory = if set, put the answer in this directory, otherwise put it in the local working directory mode = 'survey' or 'burst', only can be used for /nopng, the default is to plot bothHISTORY: 19-dec-2007, from Andreas Kieling 9-jan-2008, jmm, Added directory keyword$LastChangedBy: pcruce $$LastChangedDate: 2010-09-08 14:15:20 -0700 (Wed, 08 Sep 2010) $$LastChangedRevision: 7790 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/thm_memory_plots.pro $
- thm_new_coords.pro
NAME: thm_new_coordsPURPOSE: sets coordinate systems in the dlimits structure of input tplot variables from the CDF attributes, or alternatively, input keywordsCALLING SEQUENCE: thm_new_coords,vars,coords_in=coords_inINPUT: vars = variable namesOUTPUT: none explicit, the dlimits structure of the variables are changedKEYWORDS: coords_in = if set, then the coords for all vars will be set to this value (this is a scalar input)HISTORY: 12-feb-2008, jmm, jimm@ssl.berkeley.edu$LastChangedBy: jimm $$LastChangedDate: 2012-11-14 12:40:40 -0800 (Wed, 14 Nov 2012) $$LastChangedRevision: 11233 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/thm_new_coords.pro $
- thm_new_units.pro
NAME: thm_new_unitsPURPOSE: sets units in the dlimits structure of input tplot variables from the CDF attributes, or alternatively, input keywordsCALLING SEQUENCE: thm_new_units,vars,units_in=units_inINPUT: vars = variable namesOUTPUT: none explicit, the dlimits structure of the variables are changedKEYWORDS: units_in = if set, then the units for all vars will be set to this value (this is a scalar input)HISTORY: 12-feb-2008, jmm, jimm@ssl.berkeley.edu$LastChangedBy: pcruce $$LastChangedDate: 2012-12-07 10:34:23 -0800 (Fri, 07 Dec 2012) $$LastChangedRevision: 11326 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/thm_new_units.pro $
- thm_probe_num.pro
Function: thm_probe_numPurpose: Converts probe letters into probe numbers and vice versa.
- thm_read_config.pro
- thm_roi_bar.pro
NAME: thm_roi_barPURPOSE: creates the roi bar for overview plotsCALLING SEQUENCE: p = thm_roi_bar(in_data) INPUT: in_data: the name of the roi variable to be plotted(generally something like 'thb_state_roi'OUTPUT: p = the variable name of the roi_bar, set to '' if not successfuleHISTORY: 2007-02-28 pcruce@ssl.berkeley.edu $LastChangedBy: pcruce $ $LastChangedDate: 2008-01-25 15:07:47 -0800 (Fri, 25 Jan 2008) $ $LastChangedRevision: 2315 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/common/thm_sample_rate_bar.pro $
- thm_sample_rate_bar.pro
NAME: thm_sample_rate_barPURPOSE: creates the sample rate bar for overview plotsCALLING SEQUENCE: p = thm_sample_rate_bar(date,duration,probe)INPUT: date = the date for the start of the timespan, duration = the duration of your bar in days probe = THEMIS probe IdKEYWORDS: outline: set this to 1 to generate a sample rate panel with a black outline rather than no outlineOUTPUT: p = the variable name of the sample_rate_bar, set to '' if not sccessfulHISTORY: 20-nov-2007, jmm, jimm@ssl.berkeley.edu $LastChangedBy: pcruce $ $LastChangedDate: 2009-08-03 17:09:36 -0700 (Mon, 03 Aug 2009) $ $LastChangedRevision: 6522 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/thm_sample_rate_bar.pro $
- thm_scpot2dens.pro
function THM_SCPOT2DENS.PROPurpose: This stand-alone function calculates the spacecraft potential derived density.
- thm_scpot2dens_opt_n.pro
NAME: thm_scpot2dens_opt_n PURPOSE: Convert the spacecraft potential to the electron density CATEGORY: EFI, ESA CALLING SEQUENCE: thm_scpot2dens_opt_n,sc=sc,datatype_esa=datatype_esa,trange=trange EXAMPLE: thm_scpot2dens_opt_n,sc='d',datatype_esa='peer' ;scpot and vthermal from peer PRE-REQUIREMENTS: Timespan for the calculation like timespan,'2009-01-01/00:00:00',1,/day KEYWORD PARAMETERS: probe spacecraft name: 'a', 'b', 'c', 'd' or 'e'.
- thm_set_lim.pro
Purpose:This is a helper procedure that will set the maximum and minimum for a given mnemonicwithin a specific time range (used by thm_fitmom_overviews and thm_fitgmom_overviews)Example: thm_fitmom_overviews,'2007-03-23','b',dir='~/out',device='z' $LastChangedBy: lphilpott $ $LastChangedDate: 2012-06-15 12:50:32 -0700 (Fri, 15 Jun 2012) $ $LastChangedRevision: 10570 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/thm_set_lim.pro $
- thm_set_verbose.pro
NAME: thm_set_verbosePURPOSE: Sets verbose level in !themis.verbose and in tplot_optionsCALLING SEQUENCE: thm_set_verbose, vlevelINPUT: vlevel = a verbosity level, if not set then !themis.verbose is used (this is how you would propagate the !themis.verbose value into tplot options)HISTORY: 21-aug-2012, jmm, jimm@ssl.berkeley.edu 12-oct-2012, jmm, Added this comment to test SVN 12-oct-2012, jmm, Added this comment to test SVN, again 18-oct-2012, jmm, Another SVN test $LastChangedBy: jimm $ $LastChangedDate: 2012-10-17 12:07:58 -0700 (Wed, 17 Oct 2012) $ $LastChangedRevision: 11030 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/thm_set_verbose.pro $
- thm_spec_lim4overplot.pro
This program takes a variable and sets zero values to the minimumnonzero value -- not NaN's though
- thm_sst_overviews.pro
Purpose:Generates sst overview plots for a given datethis includes one day long plot and 4 1/4 day plotsIt stores these plots in the current directoryArguments: date: the date for which the plots will be generated directory(optional): an optional output directory device(optional):switch to 'z' device for cron plottingExample: thm_sst_overviews,'2007-03-23',dir='~/out',device='z' $LastChangedBy: jimm $ $LastChangedDate: 2014-01-24 16:34:47 -0800 (Fri, 24 Jan 2014) $ $LastChangedRevision: 14018 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/thm_sst_overviews.pro $
- thm_thmsoc_dblog.pro
NAME: thm_thmsoc_dblogPURPOSE: Database logging facility for IDL scripts.
- thm_tplot_to_component.pro
FUNCTION: thm_tplot_to_component, active_vnames, cw, mwPURPOSE: Checks the plot type (SPACECRAFT or COMPONENTS) and creates (if necessary) new tplot variablesINPUT: active_vars string array of variable names (these are the active variables that are currently available) cw gui id for history window mw gui id for progress windowOUTPUT: new_vars string array of new active variables, these variables are regrouped by SPACECRAFT or COMPONENTKEYWORDS:SEE ALSO: "STORE_DATA", "GET_DATA", "SPLIT_VEC", "OPTIONS", "TPLOT"CREATED BY: Cindy GoethelMODIFICATION BY:LAST MODIFICATION:
- thm_tplot_var.pro
Function: THM_TPLOT_VARPurpose: Creates TPLOT variable name from SC id and data qty strings.
- thm_ui_config.pro
- thm_valid_input.pro
function thm_valid_inputpurpose: for thm_load routines to validate the input keyword and set it to a standard format ('l1', 'l2', etc.).
- thm_valid_level.pro
function thm_valid_levelpurpose: for thm_load routines to validate the level keyword and set it to a standard format ('l1', 'l2', etc.).
- thm_write_config.pro
NAME: thm_write_configPURPOSE: Writes the thm_config fileCALLING SEQUENCE: thm_write_config, copy=copyINPUT: none, the filename is hardcoded, 'thm_config.txt',and is s put in a folder given by the routine thm_config_filedir, that uses the IDL routine app_user_dir to create/obtain it: my linux example: /disks/ice/home/jimm/.idl/themis/thm_config-4-linuxOUTPUT: the file is written, and a copy of any old file is generatedKEYWORD: copy = if set, the file is read in and a copy with the !stime appended is written outHISTORY: 17-may-2007, jmm, jimm@ssl.berkeley.edu 18-mar-2009, jmm, fixed problem with writing string representations of byte values 10-aug-2011, lphilpott, modified to write a template path to the config file too.
- thm_write_probe_timing_tables.pro
Procedure: thm_write_probe_timing_tables.pro Purpose: This routine takes two string file names as input arguments, reads all 'phases_???.txt' files present in the WD, determines the primary (statistically significant) apid sampling times in terms on one-second-mark 'ticks' and spin 'sectors', writes 'ticks' and 'sectors' found to probe timing table files, and generates png images of the timelines per apid.