imap-processing 0.6.0__py3-none-any.whl

imap_processing/lo/l0/decompression_tables/8_to_12_bit.csv

@@ -0,0 +1,257 @@
+compressed,raw
+0,0
+1,1
+2,2
+3,3
+4,4
+5,5
+6,6
+7,7
+8,8
+9,9
+10,10
+11,11
+12,12
+13,13
+14,14
+15,15
+16,16
+17,17
+18,18
+19,19
+20,20
+21,21
+22,22
+23,23
+24,24
+25,25
+26,26
+27,27
+28,28
+29,29
+30,30
+31,31
+32,32
+33,33
+34,34
+35,35
+36,36
+37,37
+38,38
+39,39
+40,40
+41,41
+42,42
+43,43
+44,44
+45,45
+46,46
+47,47
+48,48
+49,49
+50,50
+51,51
+52,52
+53,53
+54,54
+55,55
+56,56
+57,57
+58,58
+59,59
+60,60
+61,61
+62,62
+63,63
+64,64
+65,65
+66,66
+67,67
+68,68
+69,69
+70,70
+71,71
+72,72
+73,73
+74,74
+75,75
+76,76
+77,77
+78,78
+79,79
+80,80
+81,81
+82,82
+83,83
+84,84
+85,85
+86,86
+87,87
+88,88
+89,89
+90,90
+91,91
+92,92
+93,93
+94,94
+95,95
+96,96
+97,97
+98,98
+99,99
+100,100
+101,102
+102,105
+103,107
+104,110
+105,112
+106,115
+107,118
+108,121
+109,124
+110,127
+111,130
+112,133
+113,136
+114,139
+115,143
+116,146
+117,150
+118,153
+119,157
+120,161
+121,165
+122,169
+123,173
+124,177
+125,181
+126,186
+127,190
+128,195
+129,199
+130,204
+131,209
+132,214
+133,219
+134,225
+135,230
+136,236
+137,241
+138,247
+139,253
+140,259
+141,266
+142,272
+143,279
+144,285
+145,292
+146,299
+147,307
+148,314
+149,322
+150,330
+151,337
+152,346
+153,354
+154,363
+155,371
+156,380
+157,390
+158,399
+159,409
+160,419
+161,429
+162,439
+163,450
+164,461
+165,472
+166,483
+167,495
+168,507
+169,519
+170,532
+171,545
+172,558
+173,571
+174,585
+175,599
+176,614
+177,629
+178,644
+179,659
+180,675
+181,692
+182,709
+183,726
+184,743
+185,761
+186,780
+187,799
+188,818
+189,838
+190,858
+191,879
+192,900
+193,922
+194,944
+195,967
+196,991
+197,1015
+198,1039
+199,1064
+200,1090
+201,1117
+202,1144
+203,1171
+204,1200
+205,1229
+206,1259
+207,1289
+208,1320
+209,1352
+210,1385
+211,1419
+212,1453
+213,1488
+214,1524
+215,1561
+216,1599
+217,1638
+218,1677
+219,1718
+220,1760
+221,1802
+222,1846
+223,1891
+224,1937
+225,1983
+226,2032
+227,2081
+228,2131
+229,2183
+230,2236
+231,2290
+232,2345
+233,2402
+234,2460
+235,2520
+236,2581
+237,2644
+238,2708
+239,2773
+240,2841
+241,2910
+242,2980
+243,3052
+244,3126
+245,3202
+246,3280
+247,3359
+248,3440
+249,3524
+250,3609
+251,3697
+252,3786
+253,3878
+254,3972
+255,4068

imap_processing/lo/l0/decompression_tables/8_to_16_bit.csv

@@ -0,0 +1,257 @@
+compressed,raw
+0,0
+1,1
+2,2
+3,3
+4,4
+5,5
+6,6
+7,7
+8,8
+9,9
+10,10
+11,11
+12,12
+13,13
+14,14
+15,15
+16,16
+17,17
+18,18
+19,19
+20,20
+21,21
+22,22
+23,23
+24,24
+25,25
+26,26
+27,27
+28,28
+29,29
+30,30
+31,31
+32,32
+33,33
+34,34
+35,35
+36,36
+37,37
+38,38
+39,39
+40,40
+41,41
+42,42
+43,43
+44,44
+45,45
+46,46
+47,47
+48,48
+49,49
+50,50
+51,51
+52,52
+53,53
+54,54
+55,55
+56,56
+57,57
+58,58
+59,59
+60,60
+61,61
+62,62
+63,63
+64,64
+65,65
+66,66
+67,67
+68,68
+69,69
+70,70
+71,71
+72,72
+73,73
+74,74
+75,75
+76,76
+77,77
+78,78
+79,79
+80,80
+81,81
+82,82
+83,83
+84,84
+85,85
+86,86
+87,87
+88,88
+89,89
+90,90
+91,91
+92,92
+93,93
+94,94
+95,95
+96,96
+97,97
+98,98
+99,99
+100,100
+101,104
+102,109
+103,114
+104,118
+105,123
+106,129
+107,134
+108,140
+109,146
+110,152
+111,159
+112,165
+113,172
+114,180
+115,187
+116,195
+117,204
+118,212
+119,221
+120,231
+121,241
+122,251
+123,262
+124,273
+125,284
+126,296
+127,309
+128,322
+129,336
+130,350
+131,365
+132,381
+133,397
+134,414
+135,432
+136,450
+137,469
+138,489
+139,510
+140,532
+141,555
+142,579
+143,603
+144,629
+145,656
+146,684
+147,713
+148,743
+149,775
+150,808
+151,843
+152,879
+153,916
+154,956
+155,996
+156,1039
+157,1083
+158,1129
+159,1178
+160,1228
+161,1280
+162,1335
+163,1392
+164,1452
+165,1514
+166,1578
+167,1646
+168,1716
+169,1789
+170,1866
+171,1945
+172,2029
+173,2115
+174,2206
+175,2300
+176,2398
+177,2500
+178,2607
+179,2719
+180,2835
+181,2956
+182,3082
+183,3214
+184,3351
+185,3494
+186,3644
+187,3799
+188,3962
+189,4131
+190,4307
+191,4491
+192,4683
+193,4883
+194,5092
+195,5310
+196,5536
+197,5773
+198,6020
+199,6277
+200,6545
+201,6824
+202,7116
+203,7420
+204,7737
+205,8068
+206,8412
+207,8772
+208,9147
+209,9537
+210,9945
+211,10370
+212,10813
+213,11275
+214,11756
+215,12259
+216,12783
+217,13329
+218,13898
+219,14492
+220,15111
+221,15757
+222,16430
+223,17132
+224,17864
+225,18627
+226,19423
+227,20253
+228,21118
+229,22021
+230,22962
+231,23943
+232,24966
+233,26032
+234,27145
+235,28304
+236,29514
+237,30775
+238,32090
+239,33461
+240,34890
+241,36381
+242,37936
+243,39556
+244,41247
+245,43009
+246,44846
+247,46763
+248,48761
+249,50844
+250,53016
+251,55282
+252,57644
+253,60107
+254,62675
+255,65353

imap_processing/lo/l0/decompression_tables/decompression_tables.py

@@ -0,0 +1,75 @@
+"""Compression tables for decompompressing Lo L0 data."""
+
+from collections import namedtuple
+
+# All TOFs and Checksum values that exist for a case
+# must be shifted by 1 bit to the left
+DE_BIT_SHIFT = 1
+
+# This named tupled will be used to store the bit length
+# of each TOF field. This length will be used for unpacking
+# the TOF data.
+DataFields = namedtuple(
+    "DataFields",
+    [
+        "DE_TIME",
+        "ESA_STEP",
+        "MODE",
+        "TOF0",
+        "TOF1",
+        "TOF2",
+        "TOF3",
+        "CKSM",
+        "POS",
+    ],
+)
+# the bit length for each field
+DATA_BITS = DataFields(12, 3, 1, 10, 9, 9, 6, 3, 1)
+
+# This named tuple will be used to store which
+# TOF fields are transmitted for each case / mode.
+# TIME, ENERGY, MODE are always transmitted and
+# therefore omitted from the tuple.
+TOFFields = namedtuple(
+    "TOFFields",
+    [
+        "TOF0",
+        "TOF1",
+        "TOF2",
+        "TOF3",
+        "CKSM",
+        "POS",
+    ],
+)
+
+# TODO:
+# For case 0 if mode = 1 TOF1 is not transmitted and is calculated using the checksum
+# For case 0 if mode = 0 TOF1 is transmitted
+# For cases 4, 6, 10, 12 if mode = 1 TOF3 is not transmitted, but can be calculated
+# from the position which is transmitted
+# For cases 4, 6, 8, 10, 12 if mode = 0 TOF3 is transmitted, position is not
+# No mode = 1 for case 13? Green highlight?
+# No mode = 1 for cases 2, 3, 5, 7, 9, 11
+
+# (case, mode): the TOF fields that are transmitted that case/mode.
+CASE_DECODER = {
+    (0, 1): TOFFields(True, False, True, True, True, False),
+    (0, 0): TOFFields(True, True, True, True, False, False),
+    (1, 0): TOFFields(True, True, True, False, False, False),
+    (2, 0): TOFFields(True, True, False, False, False, True),
+    (3, 0): TOFFields(True, False, False, False, False, False),
+    (4, 1): TOFFields(True, False, False, False, False, True),
+    (4, 0): TOFFields(True, False, False, True, False, False),
+    (5, 0): TOFFields(True, False, True, False, False, False),
+    (6, 1): TOFFields(True, False, False, True, False, False),
+    (6, 0): TOFFields(True, False, False, True, False, False),
+    (7, 0): TOFFields(True, False, False, False, False, False),
+    (8, 0): TOFFields(False, True, True, False, False, True),
+    (9, 0): TOFFields(False, True, True, False, False, False),
+    (10, 1): TOFFields(False, True, False, False, False, True),
+    (10, 0): TOFFields(False, True, False, True, False, False),
+    (11, 0): TOFFields(False, True, False, False, False, False),
+    (12, 1): TOFFields(False, False, True, False, False, True),
+    (12, 0): TOFFields(False, False, True, True, False, False),
+    (13, 0): TOFFields(False, False, True, False, False, False),
+}

imap_processing/lo/l0/lo_apid.py

@@ -0,0 +1,15 @@
+"""IMAP-Lo APIDs ENUM."""
+
+from enum import IntEnum
+
+
+class LoAPID(IntEnum):
+    """IMAP-Lo APIDs."""
+
+    ILO_BOOT_HK = 673  # Boot memory dump
+    ILO_APP_SHK = 676  # Static housekeeping (values that don't change)
+    ILO_APP_NHK = 677  # Nominal housekeeping (engineering, health and status)
+    ILO_SCI_CNT = 705  # Science rates, including derived and histograms
+    ILO_SCI_DE = 706  # Science direct event data
+    ILO_STAR = 707  # Science star sensor data, every spin
+    ILO_SPIN = 708  # Spin information for each science cycle (28 spins)