Documentation for /home/davin/idl/socware/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

general/science/

slice2d.pro


PROCEDURE: slice2d PURPOSE: creates a 2-D slice of the 3-D distribution function CALLING SEQUENCE: slice2d, dat INPUTS: dat: standard 3d data structure KEYWORDS: all optional ROTATION: 'xy': the x axis is v_x and the y axis is v_y. (DEFAULT) 'xz': the x axis is v_x and the y axis is v_z. 'yz': the x axis is v_y and the y axis is v_z. rotations shown below require valid MAGF tag in the data structure 'BV': the x axis is v_para (to the magnetic field) and the bulk velocity is in the x-y plane. 'BE': the x axis is v_para (to the magnetic field) and the VxB direction is in the x-y plane. 'perp': the x-y plane is perpendicular to the B field, while the x axis is the velocity projection on the plane. 'perp_xy': the x-y plane is perpendicular to the B field, while the x axis is the x projection on the plane. 'perp_xz': the x-y plane is perpendicular to the B field, while the x axis is the x projection on the plane. 'perp_yz': the x-y plane is perpendicular to the B field, while the x axis is the y projection on the plane. ANGLE: the lower and upper angle limits of the slice selected to plot (DEFAULT [-20,20]). THIRDDIRLIM: the limits of the velocity component perpendicular to the slice plane (Def: inactivated) Once activated, the ANGLE keyword would be invalid. XRANGE: vector specifying the xrange (Def: adjusted to energy range) RANGE: vector specifying the color range (Def: from min to max of the unsmoothed, uninterpolated data) ERANGE: specifies the energy range to be used (Def: all energy) UNITS: specifies the units ('eflux', 'df', etc.) (Def. is 'df') NOZLOG: specifies a linear Z axis POSITION: positions the plot using a 4-vector NOFILL: doesn't fill the contour plot with colors NLINES: says how many lines to use if using NOFILL (DEFAULT 60, MAX 60) NOOLINES: suppresses the black contour lines NUMOLINES: how many black contour lines (DEFAULT 20, MAX 60) REMOVEZERO: removes the data with zero counts for plotting SHOWDATA: plots all the data points over the contour VEL: specifies the bulk velocity in the instrument coordinates used for subtraction & rotation (default is calculated with v_3d) NOGRID: forces no triangulation (no interpolation) NOSMOOTH: suppresses smoothing IF NOT SET, DEFAULT IS SMOOTH (boxcar smoothing w/ width=3) SUNDIR: specifies the sun direction in the instrument coordinates if set, sun direction line is plotted NOVELLINE: suppresses the velocity line SUBTRACT: subtracts the bulk velocity before plot if there are few data points around (0,0), use ThirdDirLim keyword to select data points RESOLUTION: resolution of the mesh (DEFAULT 51) ISOTROPIC: forces the scaling of the X and Y axes to be equal CREATED BY: Yuki Harada on 2014-05-26 Modified from 'thm_esa_slice2d' $LastChangedBy: haraday $ $LastChangedDate: 2014-10-10 08:17:06 -0700 (Fri, 10 Oct 2014) $ $LastChangedRevision: 15972 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/science/slice2d.pro $

Routines

top source slice2d

slice2d, dat, rotation=rotation, angle=angle, thirddirlim=thirddirlim, xrange=xrange, range=range, erange=erange, units=units, nozlog=nozlog, position=position, nofill=nofill, nlines=nlines, noolines=noolines, numolines=numolines, removezero=removezero, showdata=showdata, vel=vel, nogrid=nogrid, nosmooth=nosmooth, sundir=sundir, novelline=novelline, subtract=subtract, resolution=resolution, isotropic=isotropic

Parameters

dat

Keywords

rotation
angle
thirddirlim
xrange
range
erange
units
nozlog
position
nofill
nlines
noolines
numolines
removezero
showdata
vel
nogrid
nosmooth
sundir
novelline
subtract
resolution
isotropic

File attributes

Modification date: Tue Oct 21 13:53:52 2014
Lines: 357