Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

projects/maven/swea/

mvn_swe_pad_resample.pro


Routines

Routines from mvn_swe_pad_resample.pro

result = mvn_swe_pad_resample_map3d(var, prf=prf)

PROCEDURE: MVN_SWE_PAD_RESAMPLEPURPOSE: Resampling the pitch angle ditribution from SWEA PAD or 3D data.

result = mvn_swe_pad_resample_prf(var, type, archive=archive, silent=silent, energy=energy, map3d=map3d, dformat=dformat, nbins=nbins, nene=nene, edx=edx)
result = mvn_swe_pad_resample_swia(var, archive=archive, silent=silent, sc_pot=sc_pot, interpolate=interpolate)
result = mvn_swe_pad_resample_cscale(data, mincol=mincol, maxcol=maxcol, mindat=mindat, maxdat=maxdat)
mvn_swe_pad_resample, var, silent=silent, mask=mask, stow=stow, ddd=ddd, pad=pad, nbins=nbins, abins=abins, dbins=dbins, archive=archive, pans=pans, window=window, result=result, units=units, erange=erange, normal=normal, _extra=_extra, snap=snap, tplot=tplot, map3d=map3d, swia=swia, mbins=mbins, sc_pot=sc_pot, symdir=symdir, interpolate=interpolate, cut=cut, spec=spec, pstyle=pstyle

Routine details

top source mvn_swe_pad_resample_map3d

result = mvn_swe_pad_resample_map3d(var, prf=prf)

PROCEDURE: MVN_SWE_PAD_RESAMPLE PURPOSE: Resampling the pitch angle ditribution from SWEA PAD or 3D data. Results are plotted or created as tplot variable. CALLING SEQUENCE: mvn_swe_pad_resample, nbins=128., erange=[100., 150.] INPUTS: none - PAD or 3D data are obtained from SWEA common block. If you set the time interval, then the snapshot of the pitch angle distribution at the specified time is plotted. (Noted that it might take more than 10 minutes to resample pitch angle distributions if you use PAD data for 1 day, depending on your machine spec and data amount.) KEYWORDS: SILENT: Minimize to show the processing information in the terminal. MASK: Mask the expected angular bins whose field of view is blocked by the spacecraft body and solar paddles. Automatically identifying the mission phases (cruise or science mapping). STOW: (Obsolete). Mask the angular bins whose field of view is blocked before the boom deploy. DDD: Use 3D data to resample pitch angle distribution. PAD: Use PAD data to resample pitch angle distribution. It is the default setting. NBINS: Specify resampling binning numbers. Default = 128. ABINS: Specify which anode bins to include in the analysis: 0 = no, 1 = yes. Default = replicate(1,16) DBINS: Specify which deflection bins to include in the analysis: 0 = no, 1 = yes. Default = replicate(1,6) ARCHIVE: Use the archive data, instead of the survey data. PANS: Named varible to hold the tplot panels created. WINDOW: Set the window number to show the snapshot. Default = 0. RESULT: Return the resampling pitch angle distribution data. UNITS: Set the units to prefer to use. Default = 'EFLUX'. ERANGE: Energy range over which to plot the pitch angle distribution. For tplot case, default = 280 eV, based on the L0 tplot setting. NORMAL: If set, then normalize each pad spectrum to have an average value of unity. SNAP: Explicitly set to plot the snapshot. TPLOT: Explicitly set to make a tplot variable. MAP3D: Take into account the pitch angle width even for 3D data. This keyword only works 3D data. The mapping method is based on 'mvn_swe_padmap'. SWIA: Resampling PAD in the plasma rest frame, assuming to the charge nuetrality. Shifted velocity is taken from the SWIA Course data. So this keyword only works after loading (restoring) the SWIA data into the memory. MBINS: Specify which angular (both anode and deflection) bins to include in the analysis: 0 = no, 1 = yes. Default = replicate(1, 96) SC_POT: Account for the spacecraft potential correction. (Not completely activated yet) SYMDIR: Instead of the observed magnetic field vector, use the symmetry direction of the (strahl) electron distribution. The symmetry direction is calculated via 'swe_3d_strahl_dir'. INTERPOLATE: When you try to resample the pitch angle distribtion in the plasma rest frame, it calculates non-zero value to have the data evaluated (interpolated) at the original energy steps. This keyword is associated with 'convert_vframe'. CUT: Plot the pitch-angle-sorted 1d spectra for each energy step. It is an optional plot. SPEC: Plot the pitch-angle-selected 1d energy spectra. In the default settings, 5 pitch angle bands are selected. - quasi-parallel (0-30 deg), - quasi-perpendicular (75-105 deg), - quasi-antiparallel (150-180 deg), - 2 obliquenesses (30-75, 105-150 deg). It is also an optional plot. PSTYLE: It means "plot style". This keyword allows specification which plots you want to show. Each option is described as follows: - 1: Plots the snapshot(, equivalent to the "snap" keyword.) - 2: Generates the tplot variable(, equivalent to the "tplot" keyword.) - 4: Plots the pitch-angle-sorted 1d spectra(, equivalent to the "cut" keyword.) - 8: Plots the pitch-angle-selected 1d energy spectra(, equivalent to the "spec" keyword.) Note that this keyword is set bitwise, so multiple effects can be achieved by adding values together. For example, to plot the snapshot (value 1) and to generate the tplot variable (value 2), set the PSTYLE keyword to 1+2, or 3. This basic idea is same as that [x][y][z]style keyword included in default PLOT options. CREATED BY: Takuya Hara $LastChangedBy: hara $ $LastChangedDate: 2014-11-18 13:06:38 -0800 (Tue, 18 Nov 2014) $ $LastChangedRevision: 16222 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swea/mvn_swe_pad_resample.pro $

Parameters

var

Keywords

prf

top source mvn_swe_pad_resample_prf

result = mvn_swe_pad_resample_prf(var, type, archive=archive, silent=silent, energy=energy, map3d=map3d, dformat=dformat, nbins=nbins, nene=nene, edx=edx)

Parameters

var
type

Keywords

archive
silent
energy
map3d
dformat
nbins
nene
edx

top source mvn_swe_pad_resample_swia

result = mvn_swe_pad_resample_swia(var, archive=archive, silent=silent, sc_pot=sc_pot, interpolate=interpolate)

Parameters

var

Keywords

archive
silent
sc_pot
interpolate

top source mvn_swe_pad_resample_cscale

result = mvn_swe_pad_resample_cscale(data, mincol=mincol, maxcol=maxcol, mindat=mindat, maxdat=maxdat)

Parameters

data

Keywords

mincol
maxcol
mindat
maxdat

top source mvn_swe_pad_resample

mvn_swe_pad_resample, var, silent=silent, mask=mask, stow=stow, ddd=ddd, pad=pad, nbins=nbins, abins=abins, dbins=dbins, archive=archive, pans=pans, window=window, result=result, units=units, erange=erange, normal=normal, _extra=_extra, snap=snap, tplot=tplot, map3d=map3d, swia=swia, mbins=mbins, sc_pot=sc_pot, symdir=symdir, interpolate=interpolate, cut=cut, spec=spec, pstyle=pstyle

Parameters

var

Keywords

silent
mask
stow
ddd
pad
nbins
abins
dbins
archive
pans
window
result
units
erange
normal
_extra
snap
tplot
map3d
swia
mbins
sc_pot
symdir
interpolate
cut
spec
pstyle

File attributes

Modification date: Fri Nov 21 06:43:11 2014
Lines: 583