Specific MMS Datasets.
MMS1IonDistLabeled(dataset, path='./datasets', data_root=None, transform=None, cache=True, return_epoch=False)
Bases: ExternalMMSData
This dataset contains two versions samled from labels created by Olshevsky, et. al. (2021)1. The data samples in this dataset have one of the following labels:
| Value | Label |
|---|---|
| 0 | Solar Wind (SW) |
| 1 | Ion foreshock (IF) |
| 2 | Magnetosheath (MSH) |
| 3 | Magnetosphere (MSP) |
There are 10,000 samples for each label, for a total of 40,000 samples in each version of the dataset.
-
Olshevsky, V., et al. (2021). Automated classification of plasma regions using 3D particle energy distributions. Journal of Geophysical Research: Space Physics, https://doi.org/10.1029/2021JA029620 ↩
Examples:
>>> from spacephyml.datasets.mms import MMS1IonDistLabeled
>>> dataset = MMS1IonDistLabeled('SCDec017')
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dataset
|
string
|
The dataset, either SCNov2017 or SCDec2017. |
required |
path
|
string
|
The path for storing the dataset (not the actuall data). |
'./datasets'
|
data_root
|
string
|
The override the default root directory to for the MMS data storage. |
None
|
transform
|
callable
|
Optional transform to be applied on each sample. |
None
|
cache
|
bool
|
If data should be cached. |
True
|
return_epoch
|
bool
|
If the label epoch should be returned. |
False
|