Directory: projects/themis/spacecraft/fields/

Contents

.pro files

bessel_filter_resp.pro

function bessel_filter_resp(f, fc, N)purpose: Calculates the transfer function of an N-pole Bessel filter with a given cutoff frequency Fc.

butterworth_filter_resp.pro

function butterworth_filter_resp(f, fc, N)purpose: Calculates the transfer function of an N-pole Butterworth filter with a given cutoff frequency Fc.

scm_cleanup_ccc.pro

FUNCTION: SCM_CLEANUP_CCCPURPOSE: cleans 8 hertz and harmonic instrument noise from scm data using superposed epoch analysis.

spin_tones_cleaning_vector_v5.pro

Procedure: spin_tones_cleaning_vec_v5Purpose: compute an averaged signal with a specified averaging window duration and substract this averaged signal to raw signalkeywords: none input :t_vec,VEC,wind_dur,samp_per t_vec is a time array VEC is a time vector wind_dur is the duration of the averaging, samp_per is the sample period of t_vec and VEC output :VEC_AV has the duration of VEC but is obtained by duplicating the average signal over one averaging window along the whole time period the average signal is obtained by summing all averaging windows within the whole time period VEC_CLEANED is equal to VEC-VEC_AV, nbwind is the number of averaging window within the whole time period, nbpts_cl is the number of points within the whole time period i.e.

spinfit.pro

Name: spinfitPurpose: performs a spinfit on B or E field data, results should be equivalent to FGS or EFS datatypesCalling Sqeuence: spinfit,arr_in_t,arr_in_data,arr_in_sunpulse_t,arr_in_sunpulse_data, $ A,B,C, avg_axis, median_axis,Sigma,Npoints,sun_data, $ min_points=min_points,alpha=alpha,beta=beta, $ plane_dim=plane_dim,axis_dim=axis_dim,phase_mask_starts=phase_mask_starts, $ phase_mask_ends=phase_mask_ends,sun2sensor=sun2sensorInput: arr_in_t = time array for the data arr_in_data = the data to be spin fit arr_in_sunpulse_t = time array for sunpulse data arr_in_sunpulse_data = sunpulse dataOutput: A,B,C = fit parameters for spinfit avg_axis = the average over the spin_axis direction median_axis = the median over the spin_axis direction sigma = sigma for each spin period npoints = number of points in fit for each spin period sun_data = midpoint times of spitfit datakeywords: plane_dim = Tells program which dimension to treat as the plane.

temp_scw_degap.pro

thm_adc_resp.pro

thm_cal_efi.pro

Procedure THM_PUT_ELEMENT()Purpose: Put data into a substructure (1 level down) given the structure, the substructure tag name, and the data tag name.

thm_cal_efi_nonTD.pro

Deprecated, 2012-06-08, jmm $LastChangedBy: jimm $ $LastChangedDate: 2012-06-08 14:44:13 -0700 (Fri, 08 Jun 2012) $ $LastChangedRevision: 10523 $ $URL $

thm_cal_fbk.pro

Procedure: THM_CAL_FBKPurpose: Converts raw FBK (Filter Bank) data into physical quantities.

thm_cal_fft.pro

Procedure: THM_CAL_FFTPurpose: Converts raw FFT (on-board FFT spectra) data into physical quantities.

thm_cal_fgm.pro

procedure: thm_cal_fgmPurpose: applies calibration to THEMIS fluxgate magnetometer data searches for the current calibration in ASCII file takes calibration that has time stamp before or at the start of the data converts data to nano Tessla applies the calibration corrects for phase shift from averaging before despinningkeywords: probe = Probe name.

thm_cal_fgm_dac_offset.pro

procedure: thm_cal_fgm_dac_ffsetPurpose: Uses routine provided by Dragos Constanine to correct FGM offset from non-linearity of DAC(Digital Analog Converter) Specific routine from Dragos: thm_fgm_find_shift_1p1c.pro Calibration values from Dragos: thm_fgm_dac_corrections.datInputs: fgmdata: An Nx3 length array of fgm data in digital units.

thm_cal_fgm_spin_harmonics.pro

procedure: thm_cal_fgm_spin_harmonicsPurpose: Uses spin harmonic corrections from calibration files to fix spin harmonic errors in fgm data.

thm_cal_fgm_spintone_removal.pro

Procedure: thm_cal_fgm_spintone_removal Purpose: Tool to remove spintone from spinplane component FGM high resolution data by dynamical adaption and subtraction of bias field offsets Inputs: Time: vector of time values Data_in: corresponding spinplane component data, SSL x or y component Datatype: string 'fgl', 'fge' or 'fgh' Outputs: data_out: corrected data vector offset: removed offset data vector fulloffset: vector of all offset determinations (for validation) Author: Ferdinand Plaschke (2009-10-15) Replace AMOEBA with DFPMIN, Ferdinand Plaschke (2008-10-16) Minor modifications by Patrick Cruce(2009-10-15) for TDAS 1.

thm_cal_fit.pro

Procedure: THM_CAL_FITPurpose: Converts raw FIT parameter data into physical quantities.

thm_cal_scm.pro

NAME: thm_cal_scmPURPOSE: calibrate THEMIS SCM data The processing is done in 6 successive steps (Step 1 is the first) ----------- by default, processing stops after step 5.

thm_collate_intervals.pro

Purpose: Takes a bunch of intervals from different data sources andcollates all intervals of the same source into a single vector(may be multidimensional)keywords: r: an array of data with dimensions [time,samples,sources] s: an array of source s[i] indices should have the source index of [*,*,i] returns: an array with dimensions [time,samples,sources] but all sources will be unique(ie the size of the output sources will be <= the input sources)Notes: --Used by thm_cal_fft,thm_cal_fbk --The returned data will be sorted according to source index in ascending order

thm_comp_eac_response.pro

Procedure: thm_comp_eac_response Purpose: Compute the voltage gain (magnitude only) as a function of frequency for the DFB EAC channels.

thm_comp_efi_response.pro

Procedure: thm_comp_efi_response Purpose: Compute the voltage gain (magnitude only) as a function of frequency for a given THEMIS EFI sensor (SPB or AXB).

thm_comp_scm_response.pro

Procedure: thm_comp_scm_response Purpose: Compute the voltage gain (magnitude only) as a function of frequency for a given THEMIS SCM sensor.

thm_dfb_dig_filter_resp.pro

function thm_dfb_filter(f, fsamp) purpose: Calculates the transfer function for the DFB digital filters at a given sample rate.

thm_eac_filter_resp.pro

function thm_eac_filter_resp(f)purpose: Calculates the transfer function of the DFB EAC anti-aliasing filter.

thm_efi_boom_deployment_time.pro

NAME: thm_efi_boom_deployment_timePURPOSE: Provides the boom_deployment time(s) for EFI on THEMIS probes.

thm_efi_despin.pro

Despin routine for EFI high-res (eff/efp/efw) data.

thm_efi_sdt_test.pro

NAME:thm_efi_sdt_testPURPOSE:Checks houesekeeping data to flag the presence of EFI SDT (SensorDiagnostic Tests).

thm_fbk_decompress.pro

Function: THM_FBK_DECOMPRESSPurpose: Decompresses DFB FBK spectral data.

thm_fft_decompress.pro

Function: THM_FFT_DECOMPRESSPurpose: Decompresses DFB FFT spectral data.

thm_fft_freq_bins.pro

thm_fft_freq_bins Procedure: thm_fft_freq_bins Purpose: Given the sampling rate and number of bins, return the center frequencies of the FFT spectral estimate bins.

thm_fgm_find_shift_1p1c.pro

Function: thm_fgm_find_shift_1p1c Description: Returns the vector to be added to l1 data to correct the '390 nT' jumps for one probe and one component.

thm_fgs_spike_corrections.pro

Name: thm_fgs_spike_corrections Purpose: Routines for searching for and correcting various issues with the FGS data, including: 1) off-by-one spin errors where data points have been skipped 2) jumps in a packet at range changes 3) jumps in a packet at eclipse starts/stops These problems are obvious when plotting FGS dBz/dt when the spacecraft is near perigee, though they can also occur during low fields $LastChangedBy: egrimes $ $LastChangedDate: 2013-12-06 10:12:17 -0800 (Fri, 06 Dec 2013) $ $LastChangedRevision: 13651 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spacecraft/fields/thm_fgs_spike_corrections.pro $

thm_get_efi_cal_pars.pro

Procedure: thm_get_efi_cal_pars Purpose: Given the particular EFI waveform data type, and begin and end of the time interval, return the waveform RAW->PHYS transformation parameters.

thm_get_efi_cal_pars_nonTD.pro

Deprecated, 2012-06-08, jmm $LastChangedBy: jimm $ $LastChangedDate: 2012-06-08 14:44:13 -0700 (Fri, 08 Jun 2012) $ $LastChangedRevision: 10523 $ $URL $

thm_get_fbk_cal_pars.pro

Procedure: thm_get_fbk_cal_pars Purpose: Given the signal source, and begin and end of the time interval, return the filter bank RAW->PHYS transformation parameters.

thm_get_fft_cal_pars.pro

Procedure: thm_get_fft_cal_pars Purpose: Given the signal source, and begin and end of the time interval, return the FFT RAW->PHYS transformation parameters.

thm_get_unique_cp.pro

Purpose:returns a unique list of cp names that corresponds to thesel_strings returned by thm_get_unique_sel.proKeywords: src_idx: an array of source indices sel_str: the sel strings used in sel source selection cp_list: an array of cp's corresponding to those indicesReturns: an array of unique cp's structs the correspond to theselected sel_stringNotes: --used in thm_cal_fft,thm_cal_fbk --any changes here should probably be mirrored in thm_get_unique_sel.pro

thm_get_unique_sel.pro

Purpose:returns a unique list of source names from constructed from a non-unique listof source indicesKeywords: src_idx: an array of source indices sel_str: an array of source stringsReturns: an array of unique source strings, the length of which willbe less than or equal to the length of sNotes: --the sel_string will be returned in ascending sorted order according to their index.

thm_load_efi.pro

Procedure: THM_LOAD_EFIPurpose: Loads THEMIS EFI dataSyntax: THM_LOAD_EFI [, ]keywords: PROBE: Input, string.

thm_load_efi_l2.pro

Procedure: THM_LOAD_EFI_l2Purpose: Loads THEMIS EFI level 2 dataSyntax: THM_LOAD_EFI [, ]keywords: PROBE: Input, string.

thm_load_fbk.pro

Procedure: THM_LOAD_FBKPurpose: Loads THEMIS FilterBank datakeywords: probe = Probe name.

thm_load_fft.pro

Procedure: THM_LOAD_FFTPurpose: Loads THEMIS FFT spectra (ParticleBurst and WaveBurst) datakeywords: probe = Probe name.

thm_load_fgm.pro

Procedure: THM_LOAD_FGMPurpose: Loads THEMIS fluxgate magnetometer datakeywords: probe = Probe name.

thm_load_fit.pro

Procedure: THM_LOAD_FITPurpose: Loads THEMIS FIT datakeywords: probe = Probe name.

thm_load_scm.pro

thm_scm_casinus_vec.pro

thm_scm_deconvo_vec.pro

function thm_scm_fastconvol(a, kernel) purpose: a wrapper that gives a unified interface to convol and blk_con - Unlike convol, it implements convolution in the mathematical sense while centering the kernel over each data point.

thm_scm_gainant_vec.pro

thm_scm_modpha.pro

Broken out of thm_scm_gainant_vec.pro for VM purposes, jmm, 2013-04-23$LastChangedBy: jimm $$LastChangedDate: 2013-04-23 11:43:46 -0700 (Tue, 23 Apr 2013) $$LastChangedRevision: 12137 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spacecraft/fields/thm_scm_modpha.pro $

thm_scm_rate_interpol.pro

thm_spinavg.pro

NAME: thm_spinavgPURPOSE: average data over spin periods, and return a tplot variableCALLING SEQUENCE: thm_spinavg,var_name_in, $ sigma=sigma, npoints=npoints, spinaxis=spinaxis, median=median, $ plane_dim=plane_dim, axis_dim=axis_dim, $ min_points=min_points,alpha=alpha,beta=beta, $ phase_mask_starts=phase_mask_starts,phase_mask_ends=phase_mask_ends, $ sun2sensor=sun2sensorINPUT: var_name_in = tplot variable name containing data to fitkeywords: sigma = If set, will cause program to output tplot variable with sigma for each period.

thm_spinfit.pro

procedure: thm_spinfitPurpose: finds spinfits of field data finds A,B, and C fits for each period of data, over the entire dayrequired parameters: var_name_in = tplot variable name containing data to fitkeywords: sigma = If set, will cause program to output tplot variable with sigma for each period.

thm_unpack_hed.pro

Function: THM_UNPACK_HED thm_unpack_hed, data_type, hed_arrayPurpose: Unpacks data packed into HED data.

time_domain_filter.pro

function time_domain_filterpurpose: filter data in a tplot structure, assuming constant dt between points, returns filtered data in a new tplot structure.