Documentation for /home/davin/idl/socware/

Generated by IDLdoc

Directory: projects/themis/spacecraft/fields/LASP/

Contents

.pro files

fft_convolution.pro

NAME: FFT_CONVOLUTION PURPOSE: Computes the convolution of two or many 1D to 3D arrays by using the FFT.

ree_set_gsm.pro

PRO: REE_SET_GSM, sc PURPOSE: LOADS STATE AD SETS UP PLOTS FOR GSM INPUT: SC - REQUIRED.

thm_check_tvar.pro

NAME: THM_CHECK_TVAR (FUNCTION) PURPOSE: This routine check whether the given tplot variable TVAR exists in the memory.

thm_efi_clean_efp.pro

PRO: THM_EFI_CLEAN_EFP PURPOSE: FIXES AXIAL, REMOVES SPIKES, SPINTONE, SC POTENTIAL, AND OTHER EFP ERRORS.

thm_efi_clean_efw.pro

PRO: THM_EFI_CLEAN_EFW PURPOSE: FIXES HF, REMOVES SPIKES, AND LOW FREQUENCY.

thm_efi_derive_ez.pro

PRO: THM_EFI_DERIVE_EZ, Edsl, Bdsl, new_name=new_name PURPOSE: DERIVES EZ ASSUMING EdotB = 0 INPUT: Edsl - REQUIRED.

thm_efi_exb.pro

PRO: THM_EFI_ExB, Ename, Bname, Sname=Sname, Vname=Vname, $ EdotB=EdotB, Btot=Btot PURPOSE: Calculate Poynting Flux and Flow Velocity INPUT: Eanme - REQUIRED.

thm_efi_fix_freq_and_phase.pro

FUNCTION: THM_EFI_FIX_FREQ_AND_PAHSE, E, freq=freq, ghf=ghf, dt=dt, axial=axial PURPOSE: A routine which integrates data to fix the gain and remove the phase shift due to resistive to capacitive crossover of the THEMIS preamps.

thm_efi_get_potential.pro

FUNCTION: THM_EFI_GET_POTENTIAL, Vname NOT FOR GENERAL USE.

thm_efi_sin_fit.pro

PROCEEDURE: THM_EFI_SIN_FIT, e, t, es=es, ec=ec, per=per Called by THM_EFI_REMOVE_OFFSET_AND_SPIN, name, ask=ask PURPOSE: DOES A QUICK SIN AND COS FIT INPUT: E - REQUIRED (Electric Field) T - REQUIRED WARNING: USE SHORT SEGMENTS OUTPUT: AMP - AMPLITUDE PHS - PHASE Per - PERIOD (Sypply and save a lot of time!) INITIAL VERSION: REE 08-10-31 University of Colorado MODIFICATION HISTORY:

thm_jbt_get_btrange.pro

NAME: THM_JBT_GET_BTRANGE (FUNCTION) PURPOSE: This routine is to find the starting time and ending time of each continuous section of a give tplot variable which essentially is specified by a tplot name such as 'tha_efp'.

thm_lsp_clean_timestamp.pro

NAME: thm_lsp_clean_timestamp (PROCEDURE) PURPOSE: Clean a given tplot variable so that its time stamp is exactly monotonic.

thm_lsp_derive_ez.pro

FUNCTION: THM_EFI_DERIVE_EZ, E, B, minBz=minBz, minRat=minRat, ratio=ratio PURPOSE: DERIVES EZ ASSUMING EdotB = 0 INPUT: E - REQUIRED.

thm_lsp_filter.pro

FUNCTION: THM_LSP_FILTER, x, dt, flow, fhigh, db=dbPURPOSE: Filters the data COMP*.

thm_lsp_filter_highpass.pro

NAME: THM_LSP_FILTER_HIGHPASS (FUNCTION) PURPOSE: CAUTION: THIS ROUTINE ONLY WORKS FOR DATA SAMPLED AT EITHER 8192 HZ OR 16384 HZ.

thm_lsp_find_burst.pro

PRO: THM_LSP_FIND_BURST NOT FOR GENERAL USE.

thm_lsp_find_spikes.pro

FUNCTION: THM_LSP_FIND_SPIKES NOT FOR GENERAL USE.

thm_lsp_fix_axial.pro
thm_lsp_get_spec.pro

NAME: THM_LSP_GET_SPEC (PROCEDURE) PURPOSE: Get the power spectrum density (PSD) of a given tplot variable.

thm_lsp_median_smooth.pro

FUNCTION: THM_LSP_MEDIAN_SMOOTH, x, nsmooth NOT FOR GENERAL USE.

thm_lsp_notch_spikes.pro

FUNCTION: THM_LSP_NOTCH_SPIKES NOT FOR GENERAL USE.

thm_lsp_remove_potential.pro
thm_lsp_remove_spikes.pro

PRO: THM_LSP_REMOVE_SPIKES NOT FOR GENERAL USE.

thm_lsp_remove_spin_epoch.pro

FUNCTION: THM_LSP_REMOVE_SPIN_EPOCH, t, x, per, talk=talk NOT FOR GENERAL USE.

thm_lsp_remove_spintone.pro

FUNCTION: THM_LSP_REMOVE_SPINTONE, t, x, per, SpinPoly=SpinPoly, $ nsmooth=nsmooth, talk=talk NOT FOR GENERAL USE.

thm_qfit.pro

FUNCTION: THM_QFIT, data, phs, phsf=phsf, es=es, ec=ec, zero=zero, do_sigma=do_sigma, sigma=sigma, period=period, slide=slide, n_fitpts=n_fitpts, out=out, max_err=max_err, bad_pts=bad_pts PURPOSE: User unfriendly fit routine.

trange_clip.pro

NAME: TRANGE_CLIP (PROCEDURE) PURPOSE: Utility to trim the time range of a tplot variable and remove excess data.

vh.pro

NAME: VH (short for ViewHelp) PURPOSE: Make a shortcut to the IDL procedure DOC_LIBRARY CALLING SEQUENCE vh, pro_name ARGUMENTS: pro_name: (INPUT, REQUIRED) The name of the routine whose help document is to be shown.