This page was created by the IDL library routine `mk_html_help2`.

Last modified: Wed Sep 24 18:17:42 2025.

# Directory Listing of Routines

# general/missions/rbsp/efw/l1_to_l2

- RBSP_EFW_GET_FLAG_VALUES[2]
- RBSP_EFW_MAKE_L2
  Generate level-2 EFW CDF files
- RBSP_EFW_MAKE_L2_ESVY_DESPUN[2]
- RBSP_EFW_MAKE_L2_ESVY_UVW (PROCEDURE)
  Generate level-2 esvy (sampled at 32 S/s) in UVW coordinate system.
- RBSP_EFW_MAKE_L2_FBK[2]
- RBSP_EFW_MAKE_L2_HSK
- RBSP_EFW_MAKE_L2_SPEC[2]
- RBSP_EFW_MAKE_L2_SPINFIT[2]
  Generate level-2 EFW "spinfit" CDF files
- RBSP_EFW_MAKE_L2_VSVY
- RBSP_EFW_MAKE_L2_VSVY_HIRES[2]
- RBSP_EFW_MAKE_L3[2]
- TPLOT_TIME_TO_EPOCH (FUNCTION)
  Convert tplot time stamps into CDF epoch.

# Routine Descriptions

## RBSP_EFW_GET_FLAG_VALUES[2]

[Next Routine] [List of Routines]

     NAME: rbsp_efw_get_flag_values
     SYNTAX:
     PURPOSE: Returns a structure with flag values at "times" that is
     used to create CDF files
     INPUT:  sc ->  'a' or 'b'
             times -> an array of unix times
             bp -> boom pair. Any combination of two booms. Defaults to '12'
     OUTPUT:

     HISTORY: Created by Aaron W Breneman, Jan 8, 2015
     VERSION:
       $LastChangedBy: aaronbreneman $
       $LastChangedDate: 2020-04-29 08:09:50 -0700 (Wed, 29 Apr 2020) $
       $LastChangedRevision: 28632 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/l1_to_l2/rbsp_efw_get_flag_values.pro $

(See general/missions/rbsp/efw/l1_to_l2/rbsp_efw_get_flag_values.pro)

## RBSP_EFW_MAKE_L2

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

     NAME:
       rbsp_efw_make_l2

     PURPOSE:
       Generate level-2 EFW CDF files

     CALLING SEQUENCE:
       rbsp_efw_make_l2_spinfit, sc, date

     ARGUMENTS:
       sc: IN, REQUIRED
             'a' or 'b'
       date: IN, REQUIRED
             A date string in format like '2013-02-13'

     KEYWORDS:
       folder: IN, OPTIONAL
             Default is something like
               !rbsp_efw.local_data_dir/rbspa/l2/spinfit/2012/

       type: Set to choose which type of L2 file you want to
       create. Options are
               'combo' (OBSOLETE)  (hidden combo files)      (working)
               'combo_efw' (new version of combo files)
               'esvy_despun'  (official L2 product)          (working)
               'spinfit_both_boompairs' (hidden L2 product that
                    calculates spinfit quantities with both V1V2 and V3V4
               'vsvy_hires'   (official L2 product)          (working)
               'spinfit' (default, official L2 product)      (working)
               'combo_wygant' (no hires data)                (working)
               'pfaff_esvy'                                  (working)
               'combo_pfaff' (OBSOLETE)                      (working)

       boom_pair -> specify for the spinfit routine. Defaults to '12' but
       can be set to '34'

     OLD CDF files that are now obsolete are:
          rbspa_efw-l2_e-spinfit-mgse_20130103_v01.cdf
          rbspa_efw-l2_esvy_despun_20130105_v01.cdf
          rbspa_efw-l2_vsvy-hires_20130105_v01.cdf
          rbspa_efw-l2_combo_20130101_v03_hr.cdf
          rbspa_efw-l2_combo_20130101_v03.cdf
          rbspa_efw-l2_combo_pfaff_00000000_v01.cdf
          rbspa_efw-l2_combo_wygant_00000000_v01.cdf

     HISTORY:
       2014-12-02: Created by Aaron W Breneman, U. Minnesota

     VERSION:
     $LastChangedBy: aaronbreneman $
     $LastChangedDate: 2018-06-13 12:37:13 -0700 (Wed, 13 Jun 2018) $
     $LastChangedRevision: 25354 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2.pro $

(See general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2.pro)

## RBSP_EFW_MAKE_L2_ESVY_DESPUN[2]

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

     NAME: rbsp_efw_make_l2_esvy_despun
     SYNTAX:
     PURPOSE: Crib sheet for creating the 32 S/s despun MGSE Efield with vxB subtraction
    			This is stored in a cdf file

     INPUT:
     OUTPUT:
     KEYWORDS:
     HISTORY: Created Aaron Breneman Aug 2013
     VERSION:
       $LastChangedBy: aaronbreneman $
       $LastChangedDate: 2014-06-24 15:22:43 -0700 (Tue, 24 Jun 2014) $
       $LastChangedRevision: 15425 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_esvy_despun.pro $

(See general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_esvy_despun.pro)

## RBSP_EFW_MAKE_L2_ESVY_UVW (PROCEDURE)

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

     NAME:
       rbsp_efw_make_l2_esvy_uvw (procedure)

     PURPOSE:
       Generate level-2 esvy (sampled at 32 S/s) in UVW coordinate system.

     CATEGORIES:

     CALLING SEQUENCE:
       rbsp_efw_make_l2_esvy_uvw, sc, date, folder = folder

     ARGUMENTS:
       sc: IN, REQUIRED
             'a' or 'b'
       date: IN, REQUIRED
             A date string in format like '2013-02-13'

     KEYWORDS:
       folder: IN, OPTIONAL
             Default is something like
               !rbsp_efw.local_data_dir/rbspa/l2/esvy_uvw/2012/

     COMMON BLOCKS:

     EXAMPLES:

     SEE ALSO:

     HISTORY:
       2013-03-19: Created by Jianbao Tao (JBT), SSL, UC Berkley.

     VERSION:
     $LastChangedBy: aaronbreneman $
     $LastChangedDate: 2017-04-05 12:36:48 -0700 (Wed, 05 Apr 2017) $
     $LastChangedRevision: 23118 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_esvy_uvw.pro $

(See general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_esvy_uvw.pro)

## RBSP_EFW_MAKE_L2_FBK[2]

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

    rbsp_efw_make_l2_fbk

    Creates the RBSP (Van Allen probes) L2 CDF file

    note: Source selects for the Filter Bank:
    		0=E12DC
    		1=E34DC
    		2=E56DC
    		3=E12AC
    		4=E34AC
    		5=E56AC
    		6=SCMU
    		7=SCMV
    		8=SCMW
    		9=(V1DC+V2DC+V3DC+V4DC)/4

    KEY: fbk7 bin width (Hz):
    	0.8-1.5, 3-6, 12-25, 50-100, 200-400, 800-1.6k, 3.2-6.5k

    KEY: fbk13 bin width (Hz):
    	0.8-1.5, 1.5-3, 3-6, 6-12, 12-25, 25-50, 50-100, 100-200,
    	200-400, 400-800, 800-1.6k, 1.6k-3.2k, 3.2-6.5k

    Written by:
    	Aaron Breneman, UNN, Feb 2013
    		email: awbrenem@gmail.com

     History:
    	2013-04-25 - mostly written
     2020-Jan - huge efficiency update for Phase F

     VERSION:
    	$LastChangedBy: aaronbreneman $
    	$LastChangedDate: 2020-01-03 11:34:05 -0800 (Fri, 03 Jan 2020) $
    	$LastChangedRevision: 28158 $
    	$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_fbk.pro $

(See general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_fbk.pro)

## RBSP_EFW_MAKE_L2_HSK

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

     NAME: rbsp_efw_make_l2_hsk.pro
     SYNTAX:
     PURPOSE: creates a CDF file of RBSP housekeeping values
     INPUT: sc = 'a' or 'b'
    		 date = 'yyyy-mm-dd'
     OUTPUT:
     KEYWORDS:
     requires the skeleton cdf file rbsp?_hsk_00000000.cdf
     HISTORY: Created by Aaron W Breneman  Nov 2014
     VERSION:
       $LastChangedBy: aaronbreneman $
       $LastChangedDate: 2014-12-10 08:02:17 -0800 (Wed, 10 Dec 2014) $
       $LastChangedRevision: 16442 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_hsk.pro $

(See general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_hsk.pro)

## RBSP_EFW_MAKE_L2_SPEC[2]

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

    rbsp_efw_spec_L2_crib

    Loads and plots RBSP (Van Allen probes) spectral data
    used for the L2 CDF files

     SPEC returns 7 channels, with nominal data selection:
    		SPEC0: E12AC
    		SPEC1: E56AC
    		SPEC2: SCMpar
    		SPEC3: SCMperp
    		SPEC4: SCMW
    		SPEC5: V1AC
    		SPEC6: V2AC

    			Select 7 of: E12dc,E34dc,E56dc
    						 E12ac,E34ac,E56ac
    						 Edcpar,Edcprp
    						 Eacpar,Eacprp
    						 V1ac,V2ac,V3ac,V4ac,V5ac,V6ac
    						 SCMU,SCMV,SCMW
    						 SCMpar,SCMprp,
    						 (V1dc+V2dc+V3dc+V4dc)/4,
    						 Edcprp2, Eacprp2, SCMprp2

    	notes:

    	Aaron Breneman, UMN, Feb 2013
    	email: awbrenem@gmail.com

     VERSION:
    	$LastChangedBy: aaronbreneman $
    	$LastChangedDate: 2016-08-03 13:19:08 -0700 (Wed, 03 Aug 2016) $
    	$LastChangedRevision: 21597 $
    	$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_spec.pro $

(See general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_spec.pro)

## RBSP_EFW_MAKE_L2_SPINFIT[2]

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

     NAME:
       rbsp_efw_make_l2_spinfit

     PURPOSE:
       Generate level-2 EFW "spinfit" CDF files

     CALLING SEQUENCE:
       rbsp_efw_make_l2_spinfit, sc, date

     ARGUMENTS:
       sc: IN, REQUIRED
             'a' or 'b'
       date: IN, REQUIRED
             A date string in format like '2013-02-13'

     KEYWORDS:
       folder: IN, OPTIONAL
             Default is something like
               !rbsp_efw.local_data_dir/rbspa/l2/spinfit/2012/

       boom_pair -> specify for the spinfit routine. E.g. '12', '34', '24', etc.
                    Defaults to '12'

     HISTORY:
       2014-12-02: Created by Aaron W Breneman, U. Minnesota

     VERSION:
     $LastChangedBy: aaronbreneman $
     $LastChangedDate: 2019-11-21 09:02:18 -0800 (Thu, 21 Nov 2019) $
     $LastChangedRevision: 28048 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_spinfit.pro $

(See general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_spinfit.pro)

## RBSP_EFW_MAKE_L2_VSVY

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

     NAME:
       rbsp_efw_make_l2_vsvy

     PURPOSE: Create L2 (level-2) CDF files from the Van Allen Probe EFW
    			Vsvy data product.

     CALLING SEQUENCE:

     ARGUMENTS:	sc -> Which probe? 'a' or 'b'
    				date -> ex, '2013-10-13'

     KEYWORDS:

     EXAMPLES:	rbsp_efw_make_l2_vsvy,'a','2012-10-13'

     NOTES: This program stuffs the following quantities into the skeleton CDF file.
    		V1-V6 -> single-ended potential quantities
    		(Vx+Vy)/2 -> opposing boom averages

    	The flag array to be inserted into CDF has the following 20 fields:
    		global_flag
    		eclipse
    		maneuver
    		efw_sweep
    		efw_deploy
    		v1_saturation
    		v2_saturation
    		v3_saturation
    		v4_saturation
    		v5_saturation
    		v6_saturation
    		Espb_magnitude
    		Eparallel_magnitude
    		magnetic_wake
    		undefined
    		undefined
    		undefined
    		undefined
    		undefined
    		undefined

    	This program only sets the values of the V1-V6_saturation. The other values
    	are set to N/A or to unknown

     HISTORY:
       March 2013: Created by Aaron Breneman, University of Minnesota

     VERSION:
    	$LastChangedBy: kersten $
    	$LastChangedDate: 2013-09-18 13:41:10 -0700 (Wed, 18 Sep 2013) $
    	$LastChangedRevision: 13062 $
     	$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_vsvy.pro $

(See general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_vsvy.pro)

## RBSP_EFW_MAKE_L2_VSVY_HIRES[2]

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

     NAME:
       rbsp_efw_make_l2_vsvy_hires

     PURPOSE: Create L2 (level-2) CDF files from the Van Allen Probe EFW
    			Vsvy data product.

     CALLING SEQUENCE:

     ARGUMENTS:	sc -> Which probe? 'a' or 'b'
    				date -> ex, '2013-10-13'

     KEYWORDS:

     EXAMPLES:	rbsp_efw_make_l2_vsvy_hires,'a','2012-10-13'

     NOTES: This program stuffs the following quantities into the skeleton CDF file.
    		V1-V6 -> single-ended potential quantities
    		(Vx+Vy)/2 -> opposing boom averages

     HISTORY:
       March 2020: Created by Aaron Breneman, University of Minnesota

     VERSION:
    	$LastChangedBy: aaronbreneman $
    	$LastChangedDate: 2020-04-29 07:54:32 -0700 (Wed, 29 Apr 2020) $
    	$LastChangedRevision: 28626 $
     	$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_vsvy_hires.pro $

(See general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l2_vsvy_hires.pro)

## RBSP_EFW_MAKE_L3[2]

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

     NAME: rbsp_efw_make_l3
     SYNTAX:
     PURPOSE: Create the EFW L3 CDF file
     INPUT:
     OUTPUT:
     KEYWORDS: type -> hidden - version for creating hidden file with EMFISIS data
                    -> survey - version for long-duration survey plots
                    -> if not set defaults to standard L3 version
               script -> set if running from script. The date is read in
               differently if so
               version -> 1, 2, 3, etc...Defaults to 1
               boom_pair -> defaults to '12' for spinfit data. Can change
               to '34'

     HISTORY: Created by Aaron W Breneman, May 2014
     VERSION:
       $LastChangedBy: aaronbreneman $
       $LastChangedDate: 2016-09-02 06:56:49 -0700 (Fri, 02 Sep 2016) $
       $LastChangedRevision: 21782 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l3.pro $

(See general/missions/rbsp/efw/l1_to_l2/rbsp_efw_make_l3.pro)

## TPLOT_TIME_TO_EPOCH (FUNCTION)

[Previous Routine] [List of Routines]

     NAME:
       tplot_time_to_epoch (function)

     PURPOSE:
       Convert tplot time stamps into CDF epoch.

     CATEGORIES:

     CALLING SEQUENCE:
       result = tplot_time_to_epoch(, tarr, epoch16 = epoch16)

     ARGUMENTS:

     KEYWORDS:

     COMMON BLOCKS:

     EXAMPLES:

     SEE ALSO:

     HISTORY:
       2013-03-19: Created by Jianbao Tao (JBT), SSL, UC Berkley.

     VERSION:
     $LastChangedBy: jianbao_tao $
     $LastChangedDate: 2013-03-27 14:23:02 -0700 (Wed, 27 Mar 2013) $
     $LastChangedRevision: 11915 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/l1_to_l2/tplot_time_to_epoch.pro $

(See general/missions/rbsp/efw/l1_to_l2/tplot_time_to_epoch.pro)