This page was created by the IDL library routine mk_html_help2.

Last modified: Mon Jul 30 20:14:04 2007.

ssl_general/tools/tplot

• ADD_DATA
  Creates a tplot variable that is the difference of two tplot variables.
• ANG_DATA
  Creates a tplot variable that is the angle between two tplot variables.
• AVG_DATA
  Creates a new tplot variable that is the time average of original.
• DERIV_DATA
  Creates a tplot variable that is the derivative of a tplot variable.
• DIF_DATA
  Creates a tplot variable that is the difference of two tplot variables.
• DIV_DATA
  Creates a tplot variable that is the ratio of two other tplot variables.
• INTERP_GAP
• LOAD_WI_ELPD5
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_PDFIT
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• MULT_DATA
  Creates a tplot variable that is the product of two other tplot variables.
• NUL_DATA
  Null out a range of tplot data.
• TPLOT_ASCII
• TSAMPLE
  Returns a vector (or array) of tplot data values.
• TSAMPLE2
  Returns a vector (or array) of tplot data values.
  

Routine Descriptions

PROCEDURE: add_data, n1,n2
PURPOSE:
   Creates a tplot variable that is the difference of two tplot variables.
INPUT: n1,n2  tplot variable names (strings)

(See ssl_general/tools/tplot/add_data.pro)

PROCEDURE: ang_data, n1,n2
PURPOSE:
   Creates a tplot variable that is the angle between two tplot variables.
INPUT: n1,n2  tplot variable names (strings)
   These should each be 3 element vectors

(See ssl_general/tools/tplot/ang_data.pro)

PROCEDURE: avg_data, name, res
PURPOSE:
   Creates a new tplot variable that is the time average of original.
INPUT: name  tplot variable names (strings)

(See ssl_general/tools/tplot/avg_data.pro)

PROCEDURE: deriv_data, n1,n2
PURPOSE:
   Creates a tplot variable that is the derivative of a tplot variable.
INPUT: n1  tplot variable names (strings)

(See ssl_general/tools/tplot/deriv_data.pro)

PROCEDURE: dif_data, n1,n2
PURPOSE:
   Creates a tplot variable that is the difference of two tplot variables.
INPUT: n1,n2  tplot variable names (strings)

(See ssl_general/tools/tplot/dif_data.pro)

PROCEDURE: div_data, n1,n2
PURPOSE:
   Creates a tplot variable that is the ratio of two other tplot variables.
INPUT: n1,n2  tplot variable names (strings)

(See ssl_general/tools/tplot/div_data.pro)

Procedure interp_gap,x,y,index=wb,count=c
replaces NANs with interpolated values.

(See ssl_general/tools/tplot/interp_gap.pro)

PROCEDURE:	load_wi_elpd5
PURPOSE:	
   loads WIND 3D Plasma Experiment key parameter data for "tplot".

INPUTS:
  none, but will call "timespan" if time_range is not already set.
KEYWORDS:
  DATA:        Raw data can be returned through this named variable.
  TIME_RANGE:  2 element vector specifying the time range
RESTRICTIONS:
  This routine expects to find the master file: 'wi_elsp_3dp_files'
  In the directory specified by the environment variable: 'CDF_INDEX_DIR'
  See "make_cdf_index" for more info.
SEE ALSO: 
  "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

CREATED BY:	Davin Larson
FILE:  load_wi_elpd4.pro
LAST MODIFICATION: 99/05/27

(See ssl_general/tools/tplot/load_wi_elpd5.pro)

PROCEDURE:	load_wi_pdfit
PURPOSE:	
   loads WIND 3D Plasma Experiment key parameter data for "tplot".

INPUTS:
  none, but will call "timespan" if time_range is not already set.
KEYWORDS:
  DATA:        Raw data can be returned through this named variable.
  TIME_RANGE:  2 element vector specifying the time range
RESTRICTIONS:
  This routine expects to find the master file: 'wi_elsp_3dp_files'
  In the directory specified by the environment variable: 'CDF_INDEX_DIR'
  See "make_cdf_index" for more info.
SEE ALSO: 
  "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

CREATED BY:	Davin Larson
FILE:  load_wi_elpd4.pro
LAST MODIFICATION: 99/05/27

(See ssl_general/tools/tplot/load_wi_pdfit.pro)

PROCEDURE: mult_data, n1,n2
PURPOSE:
   Creates a tplot variable that is the product of two other tplot variables.
INPUT: n1,n2  tplot variable names (strings)

(See ssl_general/tools/tplot/mult_data.pro)

PROCEDURE: nul_data
PURPOSE:
   Null out a range of tplot data.
INPUT: none yet

(See ssl_general/tools/tplot/nul_data.pro)

Procedure:  tplot_ascii
Purpose:
  Creates an ascii file for selected tplot variables.
Input:
  Names names of tplot variables. May use glob patterns  to specify
        a set of variables.
Keywords:
  Ext:  by default, a separate file will be created in the
        current directory with name tplot_name.txt.  Use this
        keyword to set the .txt extension to a different extension.
  dir:  Put output  in dir as opposed to current working directory.
  precise: increases precision to maximum
trange: array[2] of double  or string. Specify time range for output.

(See ssl_general/tools/tplot/tplot_ascii.pro)

FUNCTION:
  dat = tsample([var,trange],[times=t])
PURPOSE:
  Returns a vector (or array) of tplot data values.
USAGE:
  dat = tsample()               ;Use cursor to select a subset of data.
  dat = tsample('Np',[t0,t1])   ;extract all 'Np' data in the given time range
KEYWORDS:
  AVERAGE:  if set the time average of the variable is returned
  TIMES:  time values returned through this (named) variable keyword.
  VALUES: values returned through this named variable keyword.
  DY :  dy values returned through this named variable keyword.

(See ssl_general/tools/tplot/tsample.pro)

FUNCTION:
  dat = tsample([var,trange],[times=t])
PURPOSE:
  Returns a vector (or array) of tplot data values.
USAGE:
  dat = tsample()               ;Use cursor to select a subset of data.
  dat = tsample('Np',[t0,t1])   ;extract all 'Np' data in the given time range
KEYWORDS:
  times:  time values returned through this keyword.
  values: values returned through this keyword.
  dy :  dy values

(See ssl_general/tools/tplot/tsample2.pro)