Documentation for /home/davin/idl/socware/

Generated by IDLdoc

Directory: general/science/wind/

Contents

.pro files

accum_df2d.pro
accum_pad.pro

FUNCTION: accum_pad,dat,apadPURPOSE: makes a data pad from a 3d structureINPUT: dat: A 3d data structure such as those gotten from get_el,get_pl,etc.

add_all.pro

PROCEDURE: add_allPURPOSE: adds user defined structure elements to the 3d structures.

add_ddata.pro
add_df2dp.pro
add_magf.pro

PROCEDURE: add_magf,dat,sourcePURPOSE: Adds magnetic field vector [Bx,By,Bz] to a 3d structure.

add_sc_pos.pro

PROCEDURE: add_sc_pos,dat,sourcePURPOSE: Adds orbital data to a 3d data structure.

add_vsw.pro
bkg_file.pro

PROCEDURE: bkg_file,bkg [,filename]PURPOSE: saves and restores background data files.

cal_bs_param.pro
clean_pad_accum.pro
cont2d.pro
cont3d.pro
convert_pad_units.pro
correlate_vect.pro
dat_file.pro

PROCEDURE: dat_file,dat [,filename]PURPOSE: saves and restores 3d data files.

dens_3d.pro
distfunc.pro

NAME: distfuncFUNCTION: distfunc(vpar,vperp,param=dfpar) or distfunc(energy,angle,mass=mass,param=dfpar)PURPOSE: Interpolates distribution function in a smooth manner.

ea_plot.pro
fitdist.pro
fix_pesah_spin_time.pro
fix_pmom_spin_time.pro
fix_spin_time.pro
flux_3d.pro
fs_sum.pro
get_3d.pro
get_burst_times.pro
get_data_time.pro
get_moment3d.pro

PROCEDURE: get_moment3d,dat,ERANGE=erange,BINS=bins,HIGHRANGE=highrangeINPUT: dat:function (string) function that returns 3d data structures function name must be "get_"+"dat" dat = 'pl' for get_pl, dat = 'el' for get_el, etc.

get_pad.pro
get_padspec.pro

PROCEDURE: get_padspecPURPOSE: Creates "TPLOT" variable by summing 3D data over selected angle bins.

get_pmom_lt.pro
make_eh_bkg.pro
make_sf_bkg.pro
make_wi_xx_3dp.pro
moments_3d.pro

FUNCTION: moments_3d,dataINPUT: data: structure, 3d data structure.

moments_3d_omega_weights.pro

FUNCTION: moments_3d_omega_weightsPURPOSE: Helper function used by moments_3d and moments_3duKEYWORDS:CREATED BY: Davin Larson, Jim McTiernan$LastChangedBy: lphilpott $$LastChangedDate: 2012-06-25 14:55:35 -0700 (Mon, 25 Jun 2012) $$LastChangedRevision: 10636 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/science/wind/moments_3d_omega_weights.pro $$Id: moments_3d_omega_weights.pro 10636 2012-06-25 21:55:35Z lphilpott $

moments_3du.pro

FUNCTION: moments_3du,data,ddataINPUT: data: structure, 3d data structure, contains raw data for moment calculation.

normpad.pro
pad2.pro
pl_plot.pro
plot_pos.pro
plot_ring.pro
reduce_var_dimensions.pro

PROCEDURE: reduce_var_dimensions,data,limitsINPUT: data: a structure with elements: x (typically time) y (3 dimensional data array) v1 v2 limits: a structure with elements: v1_range: bin range for dimension 1 (two element array) v2_range: bin range for dimension 2 (two element array) avg_var: 1 or 2.

rotate_data.pro

FUNCTION: rotate_data,x,rotmatrixINPUT: several options exist for x: string: data associated with the string is used.

sc_pot.pro
tsmooth2.pro

PROCEDURE: tsmooth2, name, width, newname=newnamePURPOSE: Smooths the tplot data.

velocity.pro

FUNCTION: velocity(energy,mass)PURPOSE: Returns the relativistic momentum over mass given the energy and mass