Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

projects/themis/common/

thm_fgm_fit_correlate_tplot.pro


NAME: thm_fgm_fit_correlate_tplot.pro Purpose: Uses ssl_correlation_shift.pro to do a correlation shift analysis on the vector lengths(math not cs vectors) of a selected fgm mnemonic and fit data CATEGORY: THEMIS-SOC CALLING SEQUENCE: pro thm_fgm_fit_correlate_tplot,fit_name, fgm_name, 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: fit_name: the tplot name of the fit data to be compared. RAW LEVEL 1 FIT DATA IS REQUIRED, E.G., 'tha_fit' fgm_name: the tplot name of the fgm_data to be compared 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:0.0) point_number: optional, the minimum number of points of overlap necessary to try correlating a bin(default:10) lag_step_number: optional, checks plus or minus lag_steps * time steps to correlate the vectors (default:5) time_step_size: optional, the size of the time step to use when interpolating and correlating the vectors, in seconds(default:1/8 seconds) bin_size: optional, the size of each bin in seconds (default:60 seconds) OUTPUTS: stores the time and the shift values in the selected 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-06-06 V1.0 KNOWN BUGS: tcs_vector_length doesn't filter NANs so it may output arithmetic warnings

Routines

Routines from thm_fgm_fit_correlate_tplot.pro

result = tcs_vector_length(x)
thm_fgm_fit_correlate_tplot, fit_mnem, fgm_mnem, 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

Routine details

top source tcs_vector_length

result = tcs_vector_length(x)

Parameters

x

top source thm_fgm_fit_correlate_tplot

thm_fgm_fit_correlate_tplot, fit_mnem, fgm_mnem, 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

fit_mnem
fgm_mnem
store_name

Keywords

correlation_floor
point_number
lag_step_number
time_step_size
bin_size

File attributes

Modification date: Thu Feb 13 16:42:33 2014
Lines: 27