Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

general/missions/rbsp/efw/utils/

rbsp_sample_rate.pro


NAME: rbsp_sample_rate.pro SYNTAX: PURPOSE: Determines the sample rate of an input time series of data with the ability to set gap thresholds to avoid including them in the calculation. INPUT: time : [N]-element array of time series times OUTPUT: KEYWORDS: GAP_THRESH : Scalar defining the maximum data gap [s] allowed in the calculation [Default = MAX(TIME) - MIN(TIME)] AVERAGE : If set, routine returns the scalar average sample rate [Default = 0, which returns an array of sample rates] OUT_MED_AVG : Set to a named variable to return the median and average values of the sample rate if the user wants all values as well HISTORY: ; CREATED: 03/28/2012 Lynn B. Wilson III NOTES: 1) The output is the sample rate in [# samples per unit time] 2) If GAP_THRESH is set too small, then the returned result is a VERSION: $LastChangedBy: aaronbreneman $ $LastChangedDate: 2014-10-15 12:38:05 -0700 (Wed, 15 Oct 2014) $ $LastChangedRevision: 15997 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/utils/rbsp_sample_rate.pro $

Routines

top source rbsp_sample_rate

result = rbsp_sample_rate(time, GAP_THRESH=GAP_THRESH, AVERAGE=AVERAGE, OUT_MED_AVG=OUT_MED_AVG)

Parameters

time

Keywords

GAP_THRESH
AVERAGE
OUT_MED_AVG

File attributes

Modification date: Tue Oct 21 13:53:51 2014
Lines: 45