Van Allen Probes (RBSP) analysis tools

RBSPICE Particle distribution tools

Note: these routines are automatically called when loading data with pyspedas.projects.rbsp.rbspice, but can also be called directly.

pyspedas.projects.rbsp.rbsp_rbspice_omni(probe='a', datatype='TOFxEH', level='l3')[source]

Calculates the omni-directional flux for all 6 telescopes

Parameters:

  • probe (str or list of str, default 'a') – Spacecraft probe name: ‘a’ or ‘b’

  • datatype (str, default 'TOFxEH') –

    RBSPICE data type:

    'EBR', 'ESRHELT', 'ESRLEHT', 'IBR', 'ISBR', 'ISRHELT',
'TOFxEH', 'TOFxEIon', 'TOFxEnonH', 'TOFxPHHHELT', 'TOFxPHHLEHT'

    Values depends on different data levels.

  • level (str, default 'l3') – data level: ‘l1’,’l2’,’l3’

Returns:

out – Tplot variables created

Return type:

list

Examples

This function is called within pyspedas.projects.rbsp.rbspice

pyspedas.projects.rbsp.rbsp_rbspice_pad(probe='a', datatype='TOFxEH', level='l3', energy=[0, 1000], bin_size=15, scopes=None)[source]

Calculate pitch angle distributions using data from the RBSP Radiation Belt Storm Probes Ion Composition Experiment (RBSPICE)

Parameters:

  • probe (str or list of str, default 'a') – Spacecraft probe name: ‘a’ or ‘b’

  • datatype (str, default 'TOFxEH') – desired data type: ‘TOFxEH’, ‘TOFxEnonH’

  • level (str, default 'l3') – data level: ‘l1’,’l2’,’l3’

  • energy (list, default [0,1000]) – user-defined energy range to include in the calculation in keV

  • bin_size (float, default 15) – desired size of the pitch angle bins in degrees

  • scopes (list, optional) – string array of telescopes to be included in PAD [0-5, default is all]

Returns:

out – Tplot variables created

Return type:

list

Examples

>>> rbspice_vars = pyspedas.projects.rbsp.rbspice(trange=['2018-11-5', '2018-11-6'], datatype='TOFxEH', level='l3')
>>> tplot('rbspa_rbspice_l3_TOFxEH_proton_omni_spin')

>>> # Calculate the pitch angle distributions
>>> from pyspedas.projects.rbsp.rbspice_lib.rbsp_rbspice_pad import rbsp_rbspice_pad
>>> rbsp_rbspice_pad(probe='a', datatype='TOFxEH', level='l3')
>>> tplot('rbspa_rbspice_l3_TOFxEH_proton_omni_0-1000keV_pad')