Directory: general/tplot/

Contents

.pro files

_get_example_dat.pro

PROCEDURE: _get_example_datNAME: _get_example_datPURPOSE: A procedure that generates sample data for "TPLOT".

_tplot_demo.pro

DEMONSTRATION OF TPLOT AND RELATED ROUTINESPURPOSE: A sample crib sheet that explains how to use the "TPLOT" procedure.

_tplot_example.pro

CRIB SHEET EXAMPLEPURPOSE: A sample crib sheet that explains how to use the "TPLOT" procedure.

bitplot.pro

NAME: bitplotINPUT: (optional if DATA keyword is set) x: array of x values y: array of y valuesPURPOSE: Plots 'ON' bits for housekeeping type data.

clean_spikes.pro

Procedure: CLEAN_SPIKES, 'name' Purpose: Simple routine to remove spikes from tplot data.

copy_data.pro

PROCEDURE: copy_data, oldname, newnamePURPOSE: to copy a data structureINPUT: oldname: name associated with old data structure newname: name associated with new data structureKEYWORDS: LINK: if set, then the data is not copied but is linked to the old name.

crosshairs.pro

NAME: crosshairsPURPOSE:Display crosshairs on the plot window, display the data coordinates of thecursor position on the plot, and return the coordinates of clicked points.

ctime.pro

PROCEDURE: ctime,time,y,zINPUT: time: Named variable in which to return the selected time (seconds since 1970) y: Named variable in which to return the y value z: Named variable in which to return the z valueKEYWORDS: PROMPT: Optional prompt string NPOINTS: Max number of points to return PSYM: If set to a psym number, the cooresponding psym is plotted at selected points SILENT: Do not print data point information PANEL: Set to a named variable to return an array of tplot panel numbers coresponding to the variables points were chosen from.

cuts.pro

PROCEDURE: cutsPURPOSE: to show x cuts or y cuts of a "tplot" spectrogramINPUT: noneKEYWORDS: name: name of the variable you want cuts forCREATED BY: Peter SchroederLAST MODIFICATION: @(#)cuts.pro 1.6 98/01/29

data_cut.pro

FUNCTION: A = data_cut(name, t)PURPOSE: Interpolates data from a data structure.

data_to_normal.pro

FUNCTION: data_to_normalPURPOSE: convert data coordinates to normal coordinatesINPUT: datav: data coordinates s: !AXIS structureKEYWORDS: noneCREATED BY: Frank Marcoline.

del_data.pro

NAME: del_dataPURPOSE: obsolete procedure! use "STORE_DATA" instead delete tplot variables del_data calls "store_data" with the DELETE keyword set let: input=['a','b','c','d','e','f'] then, del_data,input is the same as store_data,delete=inputCALLING SEQUENCE: del_data,inputINPUTS: input: strarr() or intarr() of tplot variablesLAST MODIFICATION: @(#)del_data.pro 1.4 01/10/08CREATED BY: Frank Marcoline

draw_color_scale.pro

PROCEDURE: draw_color_scaleNAME: draw_color_scalePURPOSE: Procedure to draw a color scale.

find_handle.pro

FUNCTION: find_handle(name)PURPOSE: Returns the index associated with a string name.

get_data.pro

PROCEDURE: get_data , name, time, data, valuesPURPOSE: Retrieves the data and or limit structure associated with a name handle.

get_timespan.pro

PROCEDURE: get_timespanPURPOSE: To get timespan from tplot_com or by using timespan, if tplot time range not set.

get_ylimits.pro

PROCEDURE: get_ylimits, datastr, limits, trgPURPOSE: Calculates appropriate ylimits for a string array of "TPLOT" variables to be plotted in the same panel.

gettime.pro

FUNCTION: gettime(x)INPUTS: x: Null or double or string or integerOUTPUT: double, seconds since Jan 1, 1970Examples: t = gettime('95-7-4/12:34') t = gettime('12:34:56') (get time on reference date) t = gettime(t+300.) (assumes t is a double) t = gettime(10) (t = 10 am on reference date) t = gettime(/key) (prompts user for time on reference date) t = gettime(key='Enter time: ') t = gettime(/curs) (select time using cursor in tplot routine)KEYWORDS: KEYBOARD: If non-zero then user is prompted to enter a time.

iton.pro

NAME: itonPURPOSE: Convert an index or array of indicies to data names.

join_vec.pro

NAME: join_vec.proPURPOSE: Take a series of similar variables and store as a single vector; e.g.

makegap.pro

PROCEDURE makegap,dg,x,yPURPOSE: Creates data gaps (by inserting NaN) when the time between data points is larger than a value either passed in by the user or calculated to a default.

mplot.pro

PROCEDURE: mplot, x, y, [,dy]INPUT: x: 1 or 2 dimensional array of x values.

normal_to_data.pro

FUNCTION: normal_to_dataPURPOSE: convert normal coordinates to data coordinatesINPUT: normv: normal coordinates s: !AXIS structureKEYWORDS: noneCREATED BY: Davin LarsonLAST MODIFICATION: @(#)normal_to_data.pro 1.5 98/08/02NOTE: I think this procedure is superceded by convert_coord.

options.pro

PROCEDURE: options, str, tag_name, valuePURPOSE: Add (or change) an element of a structure.

plotxy.pro

Procedure: plotxy Purpose: Takes an array of 3-d(Nx3) vectors or tplot variable and plots them using 2-d plots to help visualize them.

plotxylib.pro

Procedure: plotxylibPurpose: A library of helper functions for plotxy, plotxyz, and plotxyvec.

plotxyvec.pro

Procedure: plotxyvec Purpose: Plots a set of arrows on an image generated with plotxy,tplotxy or, plotxyz this is a pretty simple wrapper for the idl arrow routine.

plotxyz.pro

Procedure: plotxyz Purpose: Generates an isotropic spectrographic plot.

pmplot.pro

PROCECURE: pmplot PURPOSE: Used for making log y-axis plots.

scat_plot.pro

PROCEDURE: scat_plot, xname, ynamePURPOSE: Produces a scatter plot of selected tplot variables.

specplot.pro

PROCEDURE specplot,x,y,zNAME: specplotPURPOSE: Creates a spectrogram plot.

split_vec.pro

NAME: split_vecPURPOSE: take a stored vector like 'Vp' and create stored vectors 'Vp_x','Vp_y','Vp_z'CALLING SEQUENCE: split_vec,namesINPUTS: names: string or strarr, elements are data handle namesOPTIONAL INPUTS: inset: a string to be inserted in the new variable names before the suffixKEYWORD PARAMETERS: polar: Use '_mag', '_th', and '_phi' titles = an array of titles to use instead of the default or polar sufficies (NOT USED) names_out = The variable names of the new variables display_object = Object reference to be passed to dprint for output.

store_data.pro

PROCEDURE: store_data,name,DATA=data,LIMITS=limits,DLIMITS=dlimits, NEWNAME=newname,DELETE=deletePURPOSE: Store time series structures in static memory for later retrieval by the tplot routine.

strplot.pro

PROCEDURE: strplot, x, yINPUT: x: array of x values.

timebar.pro

NAME: timebarPURPOSE: plot vertical (or horizontal) lines on TPLOTs at specified times (or values)CALLING SEQUENCE: timebar,tINPUTS: t: dblarr of times at which to draw vertical lines, seconds since Jan, 1, 1970.

timerange.pro

FUNCTION: timerangePURPOSE: To get timespan from tplot_com or by using timespan, if tplot time range not set.

timespan.pro

PROCEDURE: timespan, t1, dtPURPOSE: Define a time span for the "tplot" routine.

tlimit.pro

PROCEDURE: tlimit,t1,t2PURPOSE: defines time range for "tplot" (tplot must be called first)INPUTS: Starting and Ending times.

tnames.pro

FUNCTION: names=tnames(s [,n])PURPOSE: Returns an array of "TPLOT" names This routine accepts wildcard characters.

tplot.pro

PROCEDURE: tplot [,datanames]PURPOSE: Creates a time series plot of user defined quantities.

tplot3d.pro

Procedure: tplot3d Purpose: Takes an array of 3-d(Nx3 or MxNx3) vectors or tplot variable holding these vectors and generates a 3d plot of themExample: tplotxy,'thb_state_pos' tplotxy,'thb_state_pos',/overplot Inputs: vectors: an Nx3 or MxNx3 list of vectors or the name of a tplot variable that stores an Nx3 or MxNx3 list of vectors Keywords: overplot(optional): overplot on an already existing 3d plot noreset(optional): iplot changes some internal settings, this procedure resets them to themis defaults, if you do not want this done then set this option.

tplot_com.pro

tplot_cut.pro

tplot_file.pro

PROCEDURE: tplot_file , name [,filename]PURPOSE: OBSOLETE PROCEDURE! Use "TPLOT_SAVE" and "TPLOT_RESTORE" instead.

tplot_force_monotonic.pro

Procedure: tplot_force_monotonic Purpose: This routine checks tplot variables for sample time (abscissa: data.x) monotonicity and forces them so through removal or replacement of non-monotonic segments, if requested; the corresponding elements of data.y and data.v are also repaired.

tplot_keys.pro

PROCEDURE: tplot_keysPURPOSE: Sets up function keys on user keyboard to perform frequent "tplot" functions and procedures.

tplot_names.pro

PROCEDURE: tplot_names [, datanames ]PURPOSE: Lists current stored data names that can be plotted with the TPLOT routines.

tplot_options.pro

PROCEDURE: tplot_options [,string,value]NAME: tplot_optionsPURPOSE: Sets global options for the "tplot" routine.

tplot_panel.pro

PROCEDURE: tplot_panel [,time,y]INPUTS: (optional) time: dblarr of time values associated with a variable to overplot in a designated "tplot" panel.

tplot_positions.pro

NAME: tplot_positionsPURPOSE: Return a set of plot positions for tplot.

tplot_quant__define.pro

PROCEDURE: tplot_quant__define This procedure defines the tplot_quant structure.

tplot_quaternion_rotate.pro

Procedure: tplot_quaternion_rotate, vectorname, quatname, name=namePURPOSE: Rotates a tplot vector using the tplot quaternion.

tplot_rename.pro

PROCEDURE: tplot_renamePURPOSE: Simple procedure to perform a rename of tplot variable without copy.

tplot_restore.pro

PROCEDURE: tplot_restore ,filenames=filenames, all=all, sort=sortPURPOSE: Restores tplot data, limits, name handles, options, and settings.

tplot_save.pro

PROCEDURE: tplot_save , name ,filename=filename, limits=limitsPURPOSE: Store tplot data in a file.

tplot_sort.pro

PROCEDURE: tplot_sort,namePURPOSE: Sorts tplot data by time (or x).

tplot_var_labels.pro

PROCEDURE: tplot_var_labelsPURPOSE: Helper routine for tplot.

tplotxy.pro

Procedure: tplotxy Purpose: Takes a tplot variable containing an array of 3-d(Nx3) vectors or and plots them using 2-d plots to help visualize them.

tzoom.pro

xlim.pro

PROCEDURE: xlim,lim, [min,max, [log]]PURPOSE: To set plotting limits for plotting routines.

ylim.pro

PROCEDURE: ylim [, str [ , min, max, [ LOG=log ] ] ]PURPOSE: Sets y-axis limits for plotting routines.

ylimit.pro

PROCEDURE: ylimitPURPOSE: Interactive setting of y-limits for the "TPLOT" procedure.

zlim.pro

PROCEDURE: zlim,lim, [min,max, [log]]PURPOSE: To set plotting limits for plotting routines.