Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

general/misc/

ssl_correlate_tplot.pro


NAME: ssl_correlate_tplot PURPOSE: Identified the amount of shift required to correlate two time series tplot variables and stores the result in a tplot variable. Only compares 1-d to 1-d data at a time So for example you can, compare the fge x and the fgl_x but can't do all three at a time. Works by binning the timeseries data, then calculating the time shift required to maximally correlate each bin. When too few points overlap bins are rejected. CATEGORY: THEMIS-SOC CALLING SEQUENCE: pro thm_correlate_tplot,var1_name, var1_y_dim, var2_name, var2_y_dim, store_name, correlation_floor = correlation_floor, point_number = point_number, lag_step_number = lag_step_number, time_step_size = time_step_size, bin_size = bin_size INPUTS: var1_name: the tplot name of the first variable to be compared var1_y_dim: the numerical dimension of the first tplot y_var to look at(from 0 to n-1) var2_name: the tplot name of the second variable to be compared var2_y_dim: the numerical dimension of the second tplot y_var to look at(from 0 to n-1) store_name: the name of a tplot variable in which to store the result correlation_floor: optional, if set filters all results where the correlation between functions is too poor(default:.9) point_number: optional, the minimum number of points of overlap necessary to try correlating a bin(default:200) lag_step_number: optional, checks plus or minus lag_steps * time steps to correlate the vectors (default:64) time_step_size: optional, the size of the time step to use when interpolating and correlating the vectors, in seconds(default:1/128 seconds) bin_size: optional, the size of each bin in seconds (default:60 seconds) OUTPUTS: stores the time and the shift values in the select tplot_var KEYWORDS: COMMENTS: This function will probably die horribly if time values are not monotonic. PROCEDURE: EXAMPLE: MODIFICATION HISTORY: Written by: Patrick Cruce(pcruce@gmail.com) 2007-05-24 V1.0 ;$LastChangedBy: lphilpott $ $LastChangedDate: 2012-06-25 15:20:30 -0700 (Mon, 25 Jun 2012) $ $LastChangedRevision: 10638 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/misc/ssl_correlate_tplot.pro $ KNOWN BUGS:

Routines

top source ssl_correlate_tplot

ssl_correlate_tplot, var1_name, var1_y_dim, var2_name, var2_y_dim, store_name, correlation_floor=correlation_floor, point_number=point_number, lag_step_number=lag_step_number, time_step_size=time_step_size, bin_size=bin_size

Parameters

var1_name
var1_y_dim
var2_name
var2_y_dim
store_name

Keywords

correlation_floor
point_number
lag_step_number
time_step_size
bin_size

File attributes

Modification date: Thu Feb 13 16:43:49 2014
Lines: 25