THEMIS SW Help for thmsw_1_0_20070213

This page was created by the IDL library routine mk_html_help2.

Last modified: Tue Feb 13 09:58:54 2007.

Directories Searched:

• ssl_general/CDF
• ssl_general/cotrans
• ssl_general/davin/tools/fitting
• ssl_general/davin/tools/misc
• ssl_general/davin/tools/tplot
• ssl_general/davin/tools/tplot/wvlt
• ssl_general/davin/wind
• ssl_general/key_param
• ssl_general/misc
• ssl_general/misc/system
• ssl_general/science
• ssl_general/tplot
• themis/common
• themis/examples
• themis/ground
• themis/ground/asi_mosaic
• themis/spacecraft/fields
• themis/spacecraft/fields/scm
• themis/spacecraft/particles
• themis/state

Alphabetical List of Routines

• 3D_STRUCTURE
  Documentation for the 3d structure.
• ACCUM_PAD
• ADD_ALL
  adds user defined structure elements to the 3d structures.
• ADD_BDIR
  Adds magnetic field direction [theta,phi] to a 3d structure
• ADD_DATA
  Creates a tplot variable that is the difference of two tplot variables.
• ADD_MAGF
  Adds magnetic field vector [Bx,By,Bz] to a 3d structure.
• ADD_SC_POS
  Adds orbital data to a 3d data structure.
• ANG_DATA
  Creates a tplot variable that is the angle between two tplot variables.
• APPEND_ARRAY
  Append an array to another array. Can also copy an array into a
• AVERAGE
  Returns the average value of an array.
• AVERAGE_HIST
• AVERAGE_STR
  Average data in res second time segments.
• AVG_DATA
  Creates a new tplot variable that is the time average of original.
• BITPLOT
  Plots 'ON' bits for housekeeping type data.
• BKG_FILE
  saves and restores background data files.
• BYTESCALE
• CAL_BSN2
  Function returns a structure that describes the interaction of a B-field
• CART_TO_SPHERE
  transform from cartesian to spherical coordinates
• CDF2TPLOT
• CDF_FILE_NAMES
  Returns an array of filenames within a timerange.
• CDF_INFO
  Returns a structure with useful information about a CDF file.
• CDF_INFO_TO_TPLOT
• CDF_LOAD_VARS
• CDF_SET_CDF27
  Call CDF_SET_CDF27_BACKWARD_COMPATIBLE but don't bomb unnecessarily when
• CDF_VAR_ATTS
  Returns a structure that contains the attributes of a variable within
• CLEAN_SPIKES
• COLORS_COM
• CONVERT_PH_UNITS
  Converts the units of the data array of ph data structures.
• CONVERT_VFRAME
• CONV_UNITS
• COPY_DATA
• COTRANS
• COTRANS_LIB[10]
• COTRANS_LIB[11]
• COTRANS_LIB[12]
• COTRANS_LIB[1]
• COTRANS_LIB[2]
• COTRANS_LIB[2]
• COTRANS_LIB[3]
• COTRANS_LIB[4]
• COTRANS_LIB[5]
• COTRANS_LIB[6]
• COTRANS_LIB[7]
• COTRANS_LIB[8]
• COTRANS_LIB[9]
• CROSSHAIRS
  Display crosshairs on the plot window, display the data coordinates of the
• CTIME
  Interactively uses the cursor to select a time (or times)
• CUTS
• C_3D
  Returns the sum of the counts in temp.data
• DATA_CUT
• DATA_TO_NORMAL
• DATESEC
• DAT_FILE
  saves and restores 3d data files.
• DAY_TO_YEAR_DOY
  determines year and day of year given day since 0000 AD
• DEL_DATA
  obsolete procedure! use "STORE_DATA" instead
• DERIV_DATA
  Creates a tplot variable that is the derivative of a tplot variable.
• DGEN
• DIAG_P
  Returns the temperature: [Tpara,Tperp,Tperp], and
• DIF_DATA
  Creates a tplot variable that is the difference of two tplot variables.
• DIMEN
  Returns the dimensions of an array as an array of integers.
• DIMEN1
• DIMEN2
• DIMEN_SHIFT
  Rotate dimensions of a multidimensional array.
• DISTFUNC
  Interpolates distribution function in a smooth manner.
• DIVIDE_DATA
• DIV_DATA
  Creates a tplot variable that is the ratio of two other tplot variables.
• DOY_TO_MONTH_DATE
  Determines month and date given the year and day of year.
• DRAW_COLOR_SCALE
  Procedure to draw a color scale.
• DSL2GSE
• EDIT3DBINS
• ENCLOSED
  Returns the indices of a set of x,y points that are inside a contour.
• ENLARGE_PERIODIC
• EXPONENTIAL
• EXTRACT_TAGS
• FILE_RETRIEVE
• FIND_CONST_INTERVALS
• FIND_HANDLE
  Returns the index associated with a string name.
• FIND_STR_ELEMENT
• FIT[1]
  Non-linear least squares fit to a user defined function.
• FIT[2]
  Non-linear least squares fit to a user defined function.
• FNAME_TO_TIME
  To translate the name of a standard WIND data file into the starting
• GAUSS
  Evaluates a gaussian function with background.
• GAUSS2
  Evaluates a gaussian function with background.
• GAUSSIAN
  Evaluates a gaussian function with background.
• GETTIME
• GETXY
  Routine that uses the cursor to select points.
• GET_3DT
  To generate time series data for "tplot"
• GET_BSN2
  Generates tplot structures for intersection of Bow Shock and s/c B-field line.
• GET_COLORS
• GET_DATA
  Retrieves the data and or limit structure associated with a name handle.
• GET_FILE_NAMES
  Gets an array of filenames within a time range
• GET_FILE_NAMES_IND
  Gets an array of filenames within a masterfile within a time range
• GET_MOMENT3D
  To generate moment time series data for TPLOT
• GET_PADSPEC
  Creates "TPLOT" variable by summing 3D data over selected angle bins.
• GET_SYMM
• GET_TIMESPAN
• GET_YLIMITS
  Calculates appropriate ylimits for a string array of "TPLOT" variables
• HEATFLUX
• INTERP
  Linearly Interpolates vectors with an irregular grid.
• INTERP_GAP
• ITON
  Convert an index or array of indicies to data names.
• JE_3D
  Returns the energy flux, [Je_x,Je_y,Je_z], ergs/(cm^2-s)
• J_3D
  Returns the flux, [Jx,Jy,Jz], 1/(cm^2-s)
• LIBS
• LOADALLHDF
  Loads selected HDF file variables into a data structure.
• LOADCT2
• LOAD_ACE_CRIS
  loads ACE CRIS Experiment key parameter data for "tplot".
• LOAD_ACE_EPAM
  loads ACE EPAM Experiment key parameter data for "tplot".
• LOAD_ACE_MAG
  loads ACE MAG Experiment key parameter data for "tplot".
• LOAD_ACE_SEPICA
  loads ACE SEPICA Experiment key parameter data for "tplot".
• LOAD_ACE_SIS
  loads ACE SIS Experiment key parameter data for "tplot".
• LOAD_ACE_SWEPAM
  loads ACE SWEPAM (Ion) Experiment key parameter data for "tplot".
• LOAD_ACE_ULEIS
  loads ACE ULEIS Experiment key parameter data for "tplot".
• LOAD_DST
  loads DST data from a DST text file
• LOAD_GE_MGF
  loads GEOTAIL MAGNETOMETER Experiment key parameter data for "tplot".
• LOAD_HKP_MFI
  Creates TPLOT magnetic field variables from 3DP housekeeping data.
• LOAD_I8_MAG
  loads IMP-8 magnetometer key parameter data for "tplot".
• LOAD_I8_PLA
  loads IMP-8 Plasma Experiment key parameter data for "tplot".
• LOAD_IG_PCI
  loads INTERBALL Ground key parameter data for "tplot".
• LOAD_KP
  Loads Kp and ap data from a text file
• LOAD_PO_PWI
  Loads Polar Plasma Wave Instrument key parameter data into "tplot" variables.
• LOAD_SO_CEL
  loads SOHO CEL key parameter data for "tplot".
• LOAD_SO_CST
  loads SOHO CST key parameter data for "tplot".
• LOAD_SO_ERN
  loads SOHO ERN key parameter data for "tplot".
• LOAD_WI_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_EHPD
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_EHSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_ELM2
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_ELPD2
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_ELPD5
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_ELPD_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_ELSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_EM_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_EPA
  loads WIND Energetic Particle Analyser key parameter data for "tplot".
• LOAD_WI_FRM_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_H0_MFI
  loads WIND MAGNETOMETER high resolution data for "tplot".
• LOAD_WI_HKP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_MFI
  loads WIND MAGNETOMETER Experiment key parameter data for "tplot".
• LOAD_WI_OR
  loads WIND 3D Plasma Experiment orbit data for "tplot".
• LOAD_WI_PDFIT
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_PHSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_PLSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_PM_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_SFPD
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_SFSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_SOPD
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_SOSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_SP_MFI
  loads WIND MAGNETOMETER 3 second data for "tplot".
• LOAD_WI_SWE
  loads WIND Solar Wind Experiment key parameter data for "tplot".
• LOAD_WI_WAV
  loads WIND WAVES Experiment key parameter data for "tplot".
• MAKEGAP
  Creates data gaps (by inserting NaN) when the time between data points is
• MAKEGIF
  Creates a GIF file from the currently displayed image.
• MAKEPNG
  Creates a GIF file from the currently displayed image.
• MAKE_3DMAP
  Returns a 3d map using the theta's and phi's of a 3d structure.
• MAKE_CDF_INDEX
  Creates an index file for CDF files.
• MAT_DIAG
  Diagonalize a 3x3 symmetric matrix
• MINMAX
• MK_HTML_HELP2
  Creates a html document from a list of IDL procedures.
• MOMENTS_3D
  Returns all useful moments as a structure
• MPLOT
  General purpose procedure used to make multi-line plots.
• MULT_DATA
  Creates a tplot variable that is the product of two other tplot variables.
• NDIMEN
  Returns the number of dimensions in an array.
• NN
• NORMAL_TO_DATA
• NUL_DATA
  Null out a range of tplot data.
• N_3D
  Returns the density, n, 1/cm^3
• OMNI3D
• OPLOT_ERR
  Plot error bars over a previously drawn plot.
• OPTIONS
  Add (or change) an element of a structure.
• PAD
• PADPLOT
• PANGLE
  Computes pitch angle given two sets of theta and phi
• PB5_TO_TIME
• PCLOSE
• PLOT3D
  Draws a series of 3d color plots, one plot per energy step.
• PLOT3D_COM
• PLOT3D_OPTIONS
• PLOT_MAP
• PLOT_POSITIONS
  Procedure that will compute plot positions for multiple plots per page.
• PMPLOT
• POLYCURVE
  Evaluates a (4th degree) polynomial (can be used with "FIT")
• POPEN
  Change plot device to postscript.
• POPEN_COM
• POWER_LAW
  Evaluates a power law function (with background) (can be used with "FIT")
• PRESTENS
• PRINTDAT
  Displays information and contents of a data variable.
• PRINT_CDF_INFO
• PRINT_OPTIONS
• PRINT_STRUCT
  prints data in an array of structures.
• PTRACE
• PTR_EXTRACT
• P_3D
  Returns the pressure tensor, [Pxx,Pyy,Pzz,Pxy,Pxz,Pyz], eV/cm^3
• READ_ASC
  Reads data from an ascii file and puts data in an array of structures.
• REDUCE_DIMEN
• REDUCE_VAR_DIMENSIONS
• ROTATE_DATA
• SCAT_PLOT
  Produces a scatter plot of selected tplot variables.
• SECDATE
• SECTIME
• SETFILEENV
  Sets up environment variables giving information on the location
• SHARE_COLORS
  Procedure that allows multiple IDL sessions to share the same color table.
• SMOOTH_PERIODIC
• SPEC3D
• SPECPLOT
  Creates a spectrogram plot.
• SPHERE_TO_CART
• SPLFUNC
• SPLIT_VEC
  take a stored vector like 'Vp' and create stored vectors 'Vp_x','Vp_y','Vp_z'
• SSL2DSL
• STORE_DATA
  Store time series structures in static memory for later retrieval
• STRFILTER
  Returns the subset of stringarray that matchs searchstring
• STRIPPATH
• STRPLOT
  Procedure used to print strings in a "TPLOT" style plot.
• STRUCT_VALUE
• STR_ELEMENT
  Find (or add) an element of a structure.
• SUB3D
• SUM3D
• SYMM3D
• SYMMETRY_DIR
• SYNTAX:[1]
  INPUT:
• SYNTAX:[2]
  INPUT:
• SYNTAX:[2]
  INPUT:
• SYNTAX:[3]
  INPUT:
• SYNTAX:[4]
  INPUT:
• SYNTAX:[5]
  INPUT:
• SYNTAX:[6]
  INPUT:
• SYNTAX:[7]
  INPUT:
• SYNTAX:[8]
  INPUT:
• SYNTAX:[9]
  INPUT:
• TCLIP
  wapper for xclip.pro allowing input of tplot variable names
• TDEFLAG
  wapper for xdeflag.pro allowing input of tplot variable names
• THM_ASI_CREATE_MOSAIC
  create mosaic with all THEMIS ASI
• THM_ASI_IMAGER_READFILE
• THM_ASI_STATIONS.PRO
  define quantities for GBO stations
• THM_CAL_EFI
• THM_CAL_FBK
• THM_CAL_FGM
• THM_CAL_FIT
• THM_CHECK_VALID_NAME
  checks a string or array input against another array and 'all' to
• THM_CONFIG
• THM_CRIB_ASI
• THM_CRIB_EFI
• THM_CRIB_FBK
• THM_CRIB_FGM
• THM_CRIB_FIT
• THM_CRIB_GMAG
• THM_CRIB_MOM
• THM_CRIB_SCM
• THM_CRIB_SST
• THM_DATA_CALIBRATED
• THM_FILE_DOWNLOAD
• THM_GET_EFI_CAL_PARS
• THM_GET_FBK_CAL_PARS
• THM_GMAG_STACKPLOT.PRO
  To create 3 PNG files displaying the H,D and Z components of the magnetic field
• THM_GUI
  Widget program for THEMIS data Analysis, to get the infomation in
• THM_INIT
• THM_INTERPOLATE_STATE
• THM_LOAD_ASI
• THM_LOAD_ASI_CAL
  load the ASI calibration parameters into tplot variables
• THM_LOAD_ASK
• THM_LOAD_EFI
• THM_LOAD_FBK
• THM_LOAD_FFT
• THM_LOAD_FGM
• THM_LOAD_FIT
• THM_LOAD_GMAG
• THM_LOAD_MOM
• THM_LOAD_SCM
• THM_LOAD_SST
• THM_LOAD_STATE
• THM_LOAD_XXX
• THM_TPLOT_VAR
• THM_UI_CALL_TPLOT
  A widget interface for calling tplot from the themis_w widget,
• THM_UI_CAL_DATA
  Calls thm_cal_*** routines on input tplot variable names
• THM_UI_HELP
  A widget to display the file 'thm_gui.txt' help
• THM_UI_HISTORY
  A widget to display the string array for the history of programs
• THM_UI_LOAD_DATA_FN
  A widget interface to load CDF data for whatever instrument
• THM_UI_MULTICHOICE_HISTORY
• THM_UI_NPAR
  Simple widget that asks for n parameter
• THM_UI_ONLY_TRANGE
  This program oprerates on the tplot data_quants to strip out data
• THM_UI_PAR
  Simple widget that asks for a parameter
• THM_UI_PLOT_DATA
  This will call instrument-level summary plot routines, such as
• THM_UI_RESET_COMMON_BLOCK
• THM_UI_SCLIST
  creates an array for the different themis spacecraft, to be used in
• THM_UI_SET_ACTIVE_DSET
  sets active datasets in themis GUI to given tplot varnames, used in
• THM_UI_SET_STATE_PTRS
  This program sets the values of the pointers in the themis_w state
• THM_UI_TEMP_ARR2STR
• THM_UI_TSELECT
  A list widget for time selection, this is a blocking widget, it must
• THM_UI_TSELECT_FN
• THM_UI_UPDATE_DATA_DISPLAY
  update the loaded-data display for the themis_w widget
• THM_UI_UPDATE_HISTORY
  Adds the string input to the state structure history array
• THM_UI_VALID_DTYPE
  get valid datatype names from thm_load_* routines, using the
• THM_UNPACK_HED
• TIMEBAR
  plot vertical lines on tplots at specified times
• TIMERANGE
• TIMESPAN
  Define a time span for the "tplot" routine.
• TIME_DOUBLE
  A fast, vectorized routine that returns the number of seconds since 1970.
• TIME_EPOCH
  Returns the EPOCH time required by CDF files.
• TIME_PB5
  Returns the PB5 time required by CDF files.
• TIME_STAMP
  Prints a time stamp along the lower right edge of the current plot box
• TIME_STRING
  Converts time to a date string.
• TIME_STRUCT
  A fast, vectorized routine that returns a time structure.
• TIME_TICKS
  Returns a structure that can be used to create time ticks for a plot.
• TIME_TO_STR
• TLIMIT
• TNAMES
  Returns an array of "TPLOT" names
• TPLOT
  Creates a time series plot of user defined quantities.
• TPLOT_ASCII
• TPLOT_COM
• TPLOT_FILE
  OBSOLETE PROCEDURE! Use "TPLOT_SAVE" and "TPLOT_RESTORE" instead.
• TPLOT_KEYS
  Sets up function keys on user keyboard to perform frequent "tplot"
• TPLOT_NAMES
  Lists current stored data names that can be plotted with the TPLOT routines.
• TPLOT_OPTIONS
  Sets global options for the "tplot" routine.
• TPLOT_PANEL
  Sets the graphics parameters to the specified tplot panel.
• TPLOT_POSITIONS
  Return a set of plot positions for tplot.
• TPLOT_QUANT__DEFINE
• TPLOT_RESTORE
  Restores tplot data, limits, name handles, options, and settings.
• TPLOT_SAVE
  Store tplot data in a file.
• TPLOT_SORT
  Sorts tplot data by time (or x).
• TRANGE_STR
• TRANSFORM_VELOCITY
• TSAMPLE
  Returns a vector (or array) of tplot data values.
• TSAMPLE2
  Returns a vector (or array) of tplot data values.
• TSMOOTH2
  Smooths the tplot data.
• T_3D
  Returns the temperature, [Tx,Ty,Tz,Tavg], eV
• UNITS
• VELOCITY
  Returns the relativistic momentum over mass given the energy and mass
• VTH_3D
  Returns the thermal velocity, [Vthx,Vthy,Vthz,Vthavg], km/s
• V_3D
  Returns the velocity, [Vx,Vy,Vz], km/s
• WAVELET
• WAVETEST
• WAVE_SIGNIF
• WI
• XCLIP
  Replaces with FLAGs the values of the array that are BEYOND
• XDEFLAG
  Replaces FLAGs in arrays with interpolated or other values
• XLIM
  To set plotting limits for plotting routines.
• XYZ_TO_POLAR
• XY_EDIT
  Interactively select data points
• YESNO_WIDGET_FN
  Simple widget that asks for a yes or no
• YLIM
  Sets y-axis limits for plotting routines.
• YLIMIT
• YYMMDD_TO_TIME
  Returns time (seconds since 1970) given date in format: YYMMDD HHMM
• ZLIM
  To set plotting limits for plotting routines.
• _GET_EXAMPLE_DAT
  A procedure that generates sample data for "TPLOT".
• _TPLOT_DEMO
  A sample crib sheet that explains how to use the "TPLOT" procedure.
• _TPLOT_EXAMPLE
  A sample crib sheet that explains how to use the "TPLOT" procedure.