This page was created by the IDL library routine mk_html_help2.

Last modified: Tue Apr 3 11:50:06 2018.


Directory Listing of Routines


Routine Descriptions

RBSP_EFW_BURST_FA_ROTATE_CRIB

[Next Routine] [List of Routines]
 NAME: rbsp_efw_burst_fa_rotate_crib
 SYNTAX:
 PURPOSE: Rotate RBSP EFW burst data to field-aligned coordinates
 INPUT:
 OUTPUT:
 KEYWORDS:
 HISTORY: Created by Aaron W Breneman, Univ. Minnesota  4/10/2014
 VERSION:
   $LastChangedBy: aaronbreneman $
   $LastChangedDate: 2018-02-02 11:37:33 -0800 (Fri, 02 Feb 2018) $
   $LastChangedRevision: 24633 $
   $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/general/missions/rbsp/efw/examples/rbsp_efw_burst_fa_rotate_crib.pro $

(See general/missions/rbsp/efw/examples/rbsp_efw_burst_fa_rotate_crib.pro)


RBSP_EFW_CONVECTION_EFIELD_CRIB

[Previous Routine] [Next Routine] [List of Routines]
 NAME: rbsp_efw_convection_efield_crib
 SYNTAX:
 PURPOSE: Calculate RBSP convection electric field and velocity
 INPUT:
 OUTPUT:
 KEYWORDS:
 HISTORY:
 VERSION: Written by Aaron W Breneman, July 2016. Based on Scott Thaller's crib

(See general/missions/rbsp/efw/examples/rbsp_efw_convection_efield_crib.pro)


RBSP_EFW_DCFIELD_REMOVAL_CRIB

[Previous Routine] [Next Routine] [List of Routines]
*****************************************************************************************

  FUNCTION :   rbsp_efw_DCfield_removal_crib
  PURPOSE  :   Subtract off DC magnetic field from Bw values. Saves as new tplot files


  REQUIRES:   Need: SSL THEMIS software and IDL Geopack DLM both found at
			   http://themis.ssl.berkeley.edu/software.shtml


  INPUT:
		probe   -> 'a' or 'b'
		model   -> Any of the Tsyganenko models or IGRF. Defaults to 't96'
		ql -> set to load quicklook EMFISIS data
               cadence -> cadence of EMFISIS data. 'hires', '4sec', '1sec'
               nodelete -> don't delete various tplot
               variables upon exit

  EXAMPLES:

				Produces the following variables (ex for magname = 'rbspa_mag_gsm', model='t96')
					rbspa_mag_gsm_t96
					rbspa_mag_gsm_t96_dif

					If the model is not t89 then produces:
					rbspa_mag_gsm_t96_wind
					rbspa_mag_gsm_t96_wind_dif
					rbspa_mag_gsm_t96_ace
					rbspa_mag_gsm_t96_ace_dif
					rbspa_mag_gsm_t96_omni
					rbspa_mag_gsm_t96_omni_dif



   NOTES:    ruthlessly pilfered from THEMIS crib sheets
             Subtracts off Tsyganenko values using input from ACE, Wind and OMNI, as
			  well as user defined input.



   CREATED:  2012/12/12
   CREATED BY:  Aaron W. Breneman
    LAST MODIFIED:  08/26/2012   v1.0.0 - major update. Much simplified
    MODIFIED BY: AWB

*****************************************************************************************

(See general/missions/rbsp/efw/examples/rbsp_efw_dcfield_removal_crib.pro)


RBSP_LOAD_COLLECTION

[Previous Routine] [Next Routine] [List of Routines]
 NAME: rbsp_load_collection
 SYNTAX: 
 PURPOSE: Load collection time <remote_dir>/burst_selection/rbspx_b1_rec.dat.
 INPUT:   
	cts, out, dblarr[n,2], req. Collection times in UT second.
   probe, in, 'a' or 'b', opt. Default is 'a'.
 OUTPUT: 
 KEYWORDS: 
 HISTORY: 2014-04-09, created by Sheng Tian, UMN
 VERSION: 
   $LastChangedBy: aaronbreneman $
   $LastChangedDate: 2014-04-10 08:52:58 -0700 (Thu, 10 Apr 2014) $
   $LastChangedRevision: 14788 $
   $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/general/missions/rbsp/efw/examples/rbsp_load_collection.pro $

(See general/missions/rbsp/efw/examples/rbsp_load_collection.pro)


RBSP_LOAD_CONTACT

[Previous Routine] [Next Routine] [List of Routines]
 Type: procedure.
 Purpose: Load contact time <remote_dir>/MOC_data_products/RBSPX/contact_plan'.
 Parameters:
   cts, out, dblarr[n,2], req. Contact times in UT second.
   probe, in, 'a' or 'b', opt. Default is 'a'.
 Keywords: none.
 Notes: none.
 Dependence: tdas.
 History:
   2014-04-09, Sheng Tian, create.

(See general/missions/rbsp/efw/examples/rbsp_load_contact.pro)


TWAVPOL_MODIFIED

[Previous Routine] [List of Routines]

 NAME:twavpol

PURPOSE:To perform polarisation analysis of three orthogonal component time
         series data, using tplot variables.

EXAMPLE: twavpol,'in_data',prefix='in_data',freqline=fl

INPUTS: tvarname: the name of the tplot variable upon which it will
operate

prefix(optional): the prefix to be assigned to the tplot variables that will be
output, defaults to tvarname


       Subroutine assumes data are in righthanded fieldaligned
	coordinate system with Z pointing the direction
       of the ambient magnetic field.

Keywords:
  nopfft(optional) = Number of points in FFT

  steplength(optional) = The amount of overlap between successive FFT intervals

  bin_freq (optional): No. of bins in frequency domain

OUTPUTS:
          error(optional): named variable in which to return the
          error state of this procedure call. 1 = success, 0 = failure

          freqline(optional): assign a named variable to this keyword
          to store the frequencies of each y-index

         timeline(optional): assign a named variable to this keyword
         to store the times of each x-index

The program outputs five spectral results derived from the
         fourier transform of the covariance matrix (spectral matrix)
This version stores these outputs as tplot variables with the
specified prefix
         These are follows:

         Wave power: On a linear scale, at this stage no units

         Degree of Polarisation:
		This is similar to a measure of coherency between the input
		signals, however unlike coherency it is invariant under
		coordinate transformation and can detect pure state waves
		which may exist in one channel only.100% indicates a pure
		state wave. Less than 70% indicates noise. For more
		information see J. C. Samson and J. V. Olson 'Some comments
		on the description of the polarization states
		of waves' Geophys. J. R. Astr. Soc. (1980) v61 115-130

   Wavenormal Angle:
     The angle between the direction of minimum variance
     calculated from the complex off diagonal elements of the
     spectral matrix and the Z direction of the input ac field data.
     for magnetic field data in field aligned coordinates this is the
     wavenormal angle assuming a plane wave. See:
     Means, J. D. (1972), Use of the three-dimensional covariance
     matrix in analyzing the polarization properties of plane waves,
     J. Geophys. Res., 77(28), 5551-5559,
     doi:10.1029/JA077i028p05551.

   Ellipticity:
     The ratio (minor axis)/(major axis) of the ellipse transcribed
     by the field variations of the components transverse to the
     Z direction (Samson and Olson, 1980). The sign indicates
     the direction of rotation of the field vector in the plane (cf.
     Means, (1972)).
     Negative signs refer to left-handed rotation about the Z
     direction. In the field aligned coordinate system these signs
     refer to plasma waves of left and right handed polarization.

         Helicity:Similar to Ellipticity except defined in terms of the
	direction of minimum variance instead of Z. Stricltly the Helicity
	is defined in terms of the wavenormal direction or k.
	However since from single point observations the
	sense of k cannot be determined,  helicity here is
	simply the ratio of the minor to major axis transverse to the
       minimum variance direction without sign.

NOTES:
1. Although the input is in the form of a tplot variable, the
output is currently in the form of arrays

2. -If one component is an order of magnitude or more  greater than
	the other two then the polarisation results saturate and erroneously
	indicate high degrees of polarisation at all times and
	frequencies.

3. Time series should be eyeballed before running the program.
	 For time series containing very rapid changes or spikes
	 the usual problems with Fourier analysis arise.
	 Care should be taken in evaluating degree of polarisation results.

4. For meaningful results there should be significant wave power at the
	 frequency where the polarisation approaches
	 100%. Remembercomparing two straight lines yields 100% polarisation.



 $LastChangedBy: aaronbreneman $
 $LastChangedDate: 2017-12-05 13:38:09 -0800 (Tue, 05 Dec 2017) $
 $LastChangedRevision: 24398 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/general/missions/rbsp/efw/examples/twavpol_modified.pro $

(See general/missions/rbsp/efw/examples/twavpol_modified.pro)