THEMIS cribs: Difference between revisions

From SPEDAS Wiki
Jump to navigation Jump to search
(→‎basic/introductory cribs: adding esa crib to list, cleanup)
(→‎advanced/experimental cribs: updates & cleanup)
 
Line 34: Line 34:
* '''thm_crib_efi_cal.pro''' -- Calibrate EFI data from L1, comments from PI John Bonnell.
* '''thm_crib_efi_cal.pro''' -- Calibrate EFI data from L1, comments from PI John Bonnell.
* '''thm_crib_esa_bgnd_remove.pro''' -- Remove background from ESA data.
* '''thm_crib_esa_bgnd_remove.pro''' -- Remove background from ESA data.
* '''thm_crib_esa_da.pro''' -- View ESA data in various ways. Comments from PI Jim Mcfadden.
* '''thm_crib_esa_moments.pro''' -- Generate ESA moments. (Deprecated, use thm_crib_part_products.pro)
* '''thm_crib_fac.pro''' -- Transform data into field aligned coordinates.
* '''thm_crib_fac.pro''' -- Transform data into field aligned coordinates.
* '''thm_crib_gmag_locations.pro''' -- Plot locations of various ground magnetometer stations.
* '''thm_crib_gmag_wavelet.pro''' -- Demonstration of wavelet analysis of ground magnetometer data.
* '''thm_crib_greenland_gmag.pro''' -- Load greenland gmag data.
* '''thm_crib_greenland_gmag.pro''' -- Load greenland gmag data.
* '''thm_crib_maccs_gmag.pro''' -- Load MACCS gmag data.
* '''thm_crib_maccs_gmag.pro''' -- Load MACCS gmag data.
* '''thm_crib_make_ae.pro''' -- Generate AE-style index from custom gmag data.
* '''thm_crib_make_ae.pro''' -- Generate AE-style index from custom gmag data.
* '''thm_crib_map.pro''' -- Generate map & mosaic plots. (TODO: needs more comments/documentation/header)
* '''thm_crib_map.pro''' -- Generate map & mosaic plots.
* '''thm_crib_mom_dead_time_correct.pro''' -- Perform dead time correction on ESA on-board moments data
* '''thm_crib_mom_dead_time_correct.pro''' -- Perform dead time correction on ESA on-board moments data
* '''thm_crib_mva.pro''' -- Transform data into minimum variance coordinate system, generate MVA transform matrix.
* '''thm_crib_mva.pro''' -- Transform data into minimum variance coordinate system, generate MVA transform matrix.
Line 56: Line 56:
* '''thm_crib_spinfit.pro''' -- Generate spinfits for arbitrary data.  Manual despin.
* '''thm_crib_spinfit.pro''' -- Generate spinfits for arbitrary data.  Manual despin.
* '''thm_crib_sse.pro''' -- Generate SSE coordinate transform matrix from SLP data and transform into SSE coordinates. (The hard way)
* '''thm_crib_sse.pro''' -- Generate SSE coordinate transform matrix from SLP data and transform into SSE coordinates. (The hard way)
* '''thm_crib_sst_ion_decontaminate.pro''' -- Removal of electron contamination from SST ion moments.
* '''thm_crib_sst_load_calibrate.pro''' -- Use thm_sst_load_calibrate to calibrate SST and interpolate to ESA, filling the gap between the particle instruments.
* '''thm_crib_sst_load_calibrate.pro''' -- Use thm_sst_load_calibrate to calibrate SST and interpolate to ESA, filling the gap between the particle instruments.
* '''thm_crib_sst_set_calibrations.pro''' -- Override SST calibration parameters with user-specified defaults.
* '''thm_crib_sst_set_calibrations.pro''' -- Override SST calibration parameters with user-specified defaults.
* '''thm_crib_superpo_interpol_histo.pro''' -- Crib from Andreas Keiling showing how to use the superpo_histo.pro & superpo_interpol routines.  These routines calculate AE/AU/AL style indexes from arbitrary time series. ( Min / Max envelopes, I think, pat)
* '''thm_crib_superpo_interpol_histo.pro''' -- Crib from Andreas Keiling showing how to use the superpo_histo.pro & superpo_interpol routines.  These routines calculate AE/AU/AL style indexes from arbitrary time series. ( Min / Max envelopes, I think, pat)
* '''thm_crib_tplot_overlay.pro''' -- Overlay multiple spectra on the same spectral plot.  (E.G. burst mode particle data on reduced mode particle data)
* '''thm_crib_twavpol.pro''' -- Shortish crib showing wave polarization analysis routines.
* '''thm_crib_twavpol.pro''' -- Shortish crib showing wave polarization analysis routines.
* '''thm_crib_twavpol_scm.pro''' -- Longer crib based on Olivier Le Contel's crib showing wave polarization analysis on SCM data.
* '''thm_crib_twavpol_scm.pro''' -- Longer crib based on Olivier Le Contel's crib showing wave polarization analysis on SCM data.
* '''thm_crib_validate_high_freq_using_phase.pro''' -- Verify the relative phase between EFI & SCM data.

Latest revision as of 22:34, 5 June 2015

This page describes THEMIS cribs. These detail THEMIS specific features. See also SPEDAS cribs for general purpose crib sheets and crib sheets for an index of all our crib sheet pages.

basic/introductory cribs

Basic cribs located at themis/examples/basic

  • thm_crib_asi.pro -- Load, calibrate, and view data from the THEMIS All Sky Imager(ASI) network.
  • thm_crib_cotrans.pro -- Perform coordinate transforms of THEMIS data from spacecraft coordinate to geophysical coordinates.
  • thm_crib_efi.pro -- Load, calibrate, and view data from the THEMIS Electric Field Instrument(EFI)
  • thm_crib_esa.pro -- Load and view data from the THEMIS Electrostatic Analyzer (ESA)
  • thm_crib_export.pro -- How to export THEMIS data from tplot variables. (Very similar to the crib_tplot_export_print.pro in SPEDAS_cribs)
  • thm_crib_fbk.pro -- Load, calibrate, and view data from the THEMIS on-board Filter Bank Processor.(FBK)
  • thm_crib_fft.pro -- Load, calibrate, and view data from the THEMIS on-board Fast Fourier Transform Processor. (FFT)
  • thm_crib_fgm.pro -- Load, calibrate, and view data from the THEMIS Fluxgate Magnetometer. (FGM)
  • thm_crib_fit.pro -- Load, calibrate, and view data from the THEMIS on-board Spin Fit data set. (FIT)
  • thm_crib_gmag.pro -- Load, calibrate, and view data from the THEMIS Ground Magnetometer network.(GMAG)
  • thm_crib_mom.pro -- Load, calibrate, and view data from the THEMIS on-board Moments data set. (MOM)
  • thm_crib_overplot.pro -- Generate overview plots in the style of the THEMIS website overview plots.
  • thm_crib_part_products.pro -- Ground based generation of particle moments, angular spectra, and energy spectra.
  • thm_crib_part_slice2d.pro -- Basic examples of ground based particle distribution slices.
  • thm_crib_scm.pro -- Load, calibrate, and plot THEMIS Search Coil Magnetometer. (SCM)
  • thm_crib_sst.pro -- Load, calibrate, and plot THEMIS Solid State Telescope Data (SST)
  • thm_crib_state.pro -- Load, calibrate, and plot THEMIS ephemeris data. (STATE)
  • thm_crib_trace.pro -- Generate tsyganenko model field line traces, footpoints, and projections.

advanced/experimental cribs

Advanced cribs located at themis/examples/advanced

  • thm_crib_cleanefp.pro -- Use thm_efi_clean_efp to perform various cleanup and decontamination options on EFI:EFP data.
  • thm_crib_cleanefw.pro -- Use thm_efi_clean_efw to perform various cleanup and decontamination options on EFI:EFW data.
  • thm_crib_cotrans_lmn.pro -- Coordinate transform data into LMN coordinates.
  • thm_crib_eclean_subsolar.pro -- Experimental, subsolar cleanup and smoothing of EFI:EFP data.
  • thm_crib_efi_cal.pro -- Calibrate EFI data from L1, comments from PI John Bonnell.
  • thm_crib_esa_bgnd_remove.pro -- Remove background from ESA data.
  • thm_crib_fac.pro -- Transform data into field aligned coordinates.
  • thm_crib_gmag_locations.pro -- Plot locations of various ground magnetometer stations.
  • thm_crib_gmag_wavelet.pro -- Demonstration of wavelet analysis of ground magnetometer data.
  • thm_crib_greenland_gmag.pro -- Load greenland gmag data.
  • thm_crib_maccs_gmag.pro -- Load MACCS gmag data.
  • thm_crib_make_ae.pro -- Generate AE-style index from custom gmag data.
  • thm_crib_map.pro -- Generate map & mosaic plots.
  • thm_crib_mom_dead_time_correct.pro -- Perform dead time correction on ESA on-board moments data
  • thm_crib_mva.pro -- Transform data into minimum variance coordinate system, generate MVA transform matrix.
  • thm_crib_neutral_sheet.pro -- Generate plots using neutral sheet routines and field line traces.
  • thm_crib_part_combine.pro -- Generate combined ESA & SST particle views. (Energy Spectra, Angular Spectra, Moments) (Beta)
  • thm_crib_part_slice1d.pro -- 1-d particle velocity distribution slices
  • thm_crib_part_slice2d_adv.pro -- Advanced examples for 2-d particle velocity distribution slices.
  • thm_crib_part_slice2d_multi.pro -- Extended examples for 2-d particle velocity distribution slices.(Primary exporting examples)
  • thm_crib_poynting_flux.pro -- How to correct the THEMIS-EFI high-frequency data to compensate for the transfer function, and calculate Poynting flux from the EFI and SCM data
  • thm_crib_read_write_ascii_cmdline.pro -- Examples for alternate routine for ascii import/export read_ascii_cmdline.pro/write_ascii_cmdline.pro
  • thm_crib_recovery_Vxy_mom_early_2007.pro -- Crib from Larry Kepko showing how to recover ESA particle data from early 2007. (Working around incorrect table load)
  • thm_crib_rxy.pro -- Transform data into position radial coordinate system (radial-x-y coordinates)
  • thm_crib_scpot2dens.pro -- Estimate particle density from spacecraft potential.
  • thm_crib_slp_sse.pro -- Transform in Selenocentric(sse) coordinates using thm_cotrans & Solar Lunar Planetary(SLP) support data. (The easy way)
  • thm_crib_spinfit.pro -- Generate spinfits for arbitrary data. Manual despin.
  • thm_crib_sse.pro -- Generate SSE coordinate transform matrix from SLP data and transform into SSE coordinates. (The hard way)
  • thm_crib_sst_ion_decontaminate.pro -- Removal of electron contamination from SST ion moments.
  • thm_crib_sst_load_calibrate.pro -- Use thm_sst_load_calibrate to calibrate SST and interpolate to ESA, filling the gap between the particle instruments.
  • thm_crib_sst_set_calibrations.pro -- Override SST calibration parameters with user-specified defaults.
  • thm_crib_superpo_interpol_histo.pro -- Crib from Andreas Keiling showing how to use the superpo_histo.pro & superpo_interpol routines. These routines calculate AE/AU/AL style indexes from arbitrary time series. ( Min / Max envelopes, I think, pat)
  • thm_crib_twavpol.pro -- Shortish crib showing wave polarization analysis routines.
  • thm_crib_twavpol_scm.pro -- Longer crib based on Olivier Le Contel's crib showing wave polarization analysis on SCM data.