Directory: projects/themis/spacecraft/particles/slices/

Contents

.pro files

plot_part_slice2d.pro

Purpose: Notify user that old routine was renamed to follow naming conventions.

thm_part_dist_vels.pro

Procedure: thm_part_dist_velsPurpose: Calculate bulk particle velocities from a structure array of particle distrubutions and store in a tplot variable.

thm_part_slice1d.pro

Procedure: thm_part_slice1d.proPurpose: Produce line plots from 2D particle velocity slices along various orientations.

thm_part_slice1d_mult.pro

Important: This is an incomplete helper function and is still in development.

thm_part_slice1d_plot.pro

Procedure: thm_part_slice1d_plot.proPurpose: Draw the plots for thm_part_slice1dCalling Sequence: thm_part_slice1d_plot, x, y [,overplot=overplot] [,xrange=xrange] [,yrange=yrange] [,title=title] [,xtitle=xtitle] [,ytitle=ytitle] [,window=window]Input: x: data's x axis values (km/s, eV, degrees) y: data's y axis values (slice's units) overplot: flag to add the trace to the previous plot xrange: range to force the x axis to yrange: range to force the y axis to window: index of the plotting window to be used title: plot title xtitle: x axis title ytitle: y axis title *IDL graphics keywords passed through _extra were supercede any keywords explicitly set in the calls to plot and oplot.

thm_part_slice1d_r.pro

Procedure: thm_part_slice1d_rPurpose: Return the set of points at which a radial cut will be interpolated and corresponding plot labels.

thm_part_slice1d_xy.pro

Procedure: thm_part_slice1d_xyPurpose: Return the set of points at which a linear cut will be interpolated and corresponding plot labels.

thm_part_slice2d.pro

Procedure: thm_part_slice2dPurpose: Returns a 2-D slice of THEMIS ESA/SST particle distributions.

thm_part_slice2d_2di.pro

Name: thm_part_slice2d_2di.pro Purpose: Helper function for thm_part_slice2d.pro Produces slice using 2D linear interpolation Note: This code is meant to preserve the functionality of thm_esa_slice2d for the new set of slices routines.

thm_part_slice2d_3di.pro

Name: thm_part_slice2d_2di.pro Purpose: Helper function for thm_part_slice2d.pro Produces slice by interpolating the volume in three dimensions then extracting a slice.

thm_part_slice2d_climit.pro

Procedure: thm_part_slice2d_climitPurpose: Helper function for thm_part_slice2d_getxyzInput: dist: 3D particle data structure (UNSANITIZED) datatpoints: final averaged data array from thm_part_slice2d_getxyz units: string specifying units (e.g.

thm_part_slice2d_collate.pro

Procedure: thm_part_slice2d_collatePurpose: Collate data aggregated as thm_part_slice2d_getdata loops over modes and times.

thm_part_slice2d_const.pro

thm_part_slice2d_cotrans.pro

Procedure: thm_part_slice2d_cotransPurpose: Helper function for thm_part_slice2d.

thm_part_slice2d_ebounds.pro

Procedure: thm_part_slice2d_eboundsPurpose: Returns an array of gapless energy boundaries.

thm_part_slice2d_fac.pro

Procedure: thm_part_slice2d_facPurpose: Helper function for thm_part_slice2d.

thm_part_slice2d_geo.pro

Name: thm_part_slice2d_geo.pro Purpose: Helper function for thm_part_slice2d.pro Produces slice using each bin's boundaries.

thm_part_slice2d_getdata.pro

Procedure: thm_part_slice2d_getdataPurpose: Helper function for thm_part_slice2d.pro Returns an array of averaged data along with the corresponding bin centers and widths in spherical coordinates.

thm_part_slice2d_getinfo.pro

Procedure: thm_part_slice2d_getinfoPurpose: Helper function for thm_part_slice2d_plot.

thm_part_slice2d_getmag.pro

Procedure: thm_part_slice2d_getmagPurpose: Helper function for thm_part_slice2d.

thm_part_slice2d_getsphere.pro

Procedure: thm_part_slice2d_getspherePurpose: Helper function for thm_part_slice2d_getdata Calculates the center and width of all bins in spherical coordinates.

thm_part_slice2d_getsun.pro

Procedure: thm_part_slice2d_getsunPurpose: Helper function for thm_part_slice2d.

thm_part_slice2d_getticks.pro

Procedure: thm_part_slice2d_getticksPurpose: Helper function for thm_part_slice2d_plot.

thm_part_slice2d_getticks_rlog.pro

Procedure: thm_part_slice2d_getticks_rlogPurpose: Helper function for thm_part_slice2d_plot.

thm_part_slice2d_getvel.pro

Procedure: thm_part_slice2d_getvelPurpose: Helper function for thm_part_slice2d.

thm_part_slice2d_intrange.pro

Procedure: thm_part_slice2d_intrangePurpose: Helper function for thm_part_slice2d.

thm_part_slice2d_ncount.pro

Procedure: thm_part_slice2d_ncountPurpose: Helper function for thm_part_slice2d_getxyz Converts one count value to requested units and returns converted data array.

thm_part_slice2d_nn.pro

Name: thm_part_slice2d_2di.pro Purpose: Helper function for thm_part_slice2d.pro Produces slice using nearest neighbor interpolation.

thm_part_slice2d_orientslice.pro

Procedure: thm_part_slice2d_orientslicePurpose: Helper function for thm_part_slice2d.

thm_part_slice2d_plot.pro

Procedure: thm_part_slice2d_plotPurpose: Create plots for 2D particle slices.

thm_part_slice2d_regridsphere.pro

Procedure: thm_part_slice2d_regridspherePurpose: Helper function for thm_part_slice2d_getdata Spherically interpolates a structure's data to a specified regular grid and returns the center and width of all bins in spherical coordinates.

thm_part_slice2d_removezeros.pro

Procedure: thm_part_slice2d_removezerosPurpose: Helper routine for thm_part_slice2d_plot.

thm_part_slice2d_rlog.pro

Procedure: thm_part_slice2d_rlogPurpose: Apply radial log scaling to aggregated velocity/energy vectors.

thm_part_slice2d_rotate.pro

Procedure: thm_part_slice2d_rotatePurpose: Helper function for thm_part_slice2d.

thm_part_slice2d_s2c.pro

Procedure: thm_part_slice2d_s2cPurpose: Helper function for thm_part_slice2d_getxyz Converts spherical coordinates to cartesianInput: r: N element array of radial values (can be any dimensions) theta: N element array of theta values ( " ) phi: N element array of phi values ( " )Output: vec: Nx3 array of cartesian values in x,y,z orderNotes: could probably just use sphere_to_cart?$LastChangedBy: aaflores $$LastChangedDate: 2013-11-05 17:44:02 -0800 (Tue, 05 Nov 2013) $$LastChangedRevision: 13496 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spacecraft/particles/slices/thm_part_slice2d_s2c.pro $

thm_part_slice2d_smooth.pro

Procedure: thm_part_slice2d_smoothPurpose: Helper function for thm_part_slice2d.

thm_part_slice2d_subtract.pro

Procedure: thm_part_slice2d_subtractPurpose: Helper function for thm_part_slice2d.

thm_part_slice_extract.pro

Procedure: thm_part_slice_extractPurpose: Returns a 2-D slice of a scattered 3-D distribution along the designated plane.

thm_part_slice_trans.pro

thm_ui_slice2d.pro

NAME: thm_ui_slice2dPURPOSE: Front end window allowing user to create and view "2D" slices of particle distributions.

thm_ui_slice2d_bar__define.pro

NAME: thm_ui_slice2d_bar__define.proPURPOSE: Object created for the 2d slices interface.

thm_ui_slice2d_message.pro