Two Wide-Angle Imaging Neutral-Atom Spectrometers (TWINS) Mission

The routines in this module can be used to load data from the Two Wide-Angle Imaging Neutral-Atom Spectrometers (TWINS) Mission mission.

Energetic Neutral Atom (ENA) imager

pyspedas.twins.imager(trange=['2018-11-5', '2018-11-6'], probe='1', datatype='', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads TWINS imager data

Parameters
  • trange (list of str) – time range of interest [starttime, endtime] with the format ‘YYYY-MM-DD’,’YYYY-MM-DD’] or to specify more or less than a day [‘YYYY-MM-DD/hh:mm:ss’,’YYYY-MM-DD/hh:mm:ss’]

  • datatype (str) – Data type; Valid options:

  • suffix (str) – The tplot variable names will be given this suffix. By default, no suffix is added.

  • get_support_data (bool) – Data with an attribute “VAR_TYPE” with a value of “support_data” will be loaded into tplot. By default, only loads in data with a “VAR_TYPE” attribute of “data”.

  • varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. By default, all variables are loaded in.

  • varnames (list of str) – List of variable names to load (if not specified, all data variables are loaded)

  • downloadonly (bool) – Set this flag to download the CDF files, but not load them into tplot variables

  • notplot (bool) – Return the data in hash tables instead of creating tplot variables

  • no_update (bool) – If set, only load data from your local cache

  • time_clip (bool) – Time clip the variables to exactly the range specified in the trange keyword

Return type

List of tplot variables created.

Lyman-alpha Detector (LAD)

pyspedas.twins.lad(trange=['2018-11-5', '2018-11-6'], probe='1', datatype='', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads data from the LAD instrument

Parameters
  • trange (list of str) – time range of interest [starttime, endtime] with the format ‘YYYY-MM-DD’,’YYYY-MM-DD’] or to specify more or less than a day [‘YYYY-MM-DD/hh:mm:ss’,’YYYY-MM-DD/hh:mm:ss’]

  • datatype (str) – Data type; Valid options:

  • suffix (str) – The tplot variable names will be given this suffix. By default, no suffix is added.

  • get_support_data (bool) – Data with an attribute “VAR_TYPE” with a value of “support_data” will be loaded into tplot. By default, only loads in data with a “VAR_TYPE” attribute of “data”.

  • varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. By default, all variables are loaded in.

  • varnames (list of str) – List of variable names to load (if not specified, all data variables are loaded)

  • downloadonly (bool) – Set this flag to download the CDF files, but not load them into tplot variables

  • notplot (bool) – Return the data in hash tables instead of creating tplot variables

  • no_update (bool) – If set, only load data from your local cache

  • time_clip (bool) – Time clip the variables to exactly the range specified in the trange keyword

Return type

List of tplot variables created.

Example

import pyspedas
from pytplot import tplot
lad_vars = pyspedas.twins.lad(trange=['2018-11-5/6:00', '2018-11-5/6:20'], time_clip=True)
tplot(['lad1_data', 'lad2_data'])
_images/twins_lad.png

Ephemeris

pyspedas.twins.ephemeris(trange=['2018-11-5', '2018-11-6'], probe='1', datatype='or', suffix='', get_support_data=False, varformat=None, varnames=[], downloadonly=False, notplot=False, no_update=False, time_clip=False)

This function loads TWINS ephemeris data

Parameters
  • trange (list of str) – time range of interest [starttime, endtime] with the format ‘YYYY-MM-DD’,’YYYY-MM-DD’] or to specify more or less than a day [‘YYYY-MM-DD/hh:mm:ss’,’YYYY-MM-DD/hh:mm:ss’]

  • datatype (str) – Data type; Valid options:

  • suffix (str) – The tplot variable names will be given this suffix. By default, no suffix is added.

  • get_support_data (bool) – Data with an attribute “VAR_TYPE” with a value of “support_data” will be loaded into tplot. By default, only loads in data with a “VAR_TYPE” attribute of “data”.

  • varformat (str) – The file variable formats to load into tplot. Wildcard character “*” is accepted. By default, all variables are loaded in.

  • varnames (list of str) – List of variable names to load (if not specified, all data variables are loaded)

  • downloadonly (bool) – Set this flag to download the CDF files, but not load them into tplot variables

  • notplot (bool) – Return the data in hash tables instead of creating tplot variables

  • no_update (bool) – If set, only load data from your local cache

  • time_clip (bool) – Time clip the variables to exactly the range specified in the trange keyword

Return type

List of tplot variables created.

Example

import pyspedas
from pytplot import tplot
ephem_vars = pyspedas.twins.ephemeris(trange=['2018-11-5', '2018-11-6'])
tplot('FSCGSM')
_images/twins_ephemeris.png