imap-processing 0.6.0__py3-none-any.whl

imap_processing/codice/data/esa_sweep_values.csv

@@ -0,0 +1,257 @@
+table_idx,e_step,esa_v,esa_v_raw
+0,0,14100,4095
+0,1,13546,3934
+0,2,13015,3780
+0,3,12506,3632
+0,4,12017,3490
+0,5,11545,3353
+0,6,11091,3221
+0,7,10657,3095
+0,8,10240,2974
+0,9,9837,2857
+0,10,9455,2746
+0,11,9083,2638
+0,12,8729,2535
+0,13,8384,2435
+0,14,8057,2340
+0,15,7740,2248
+0,16,7437,2160
+0,17,7145,2075
+0,18,6866,1994
+0,19,6597,1916
+0,20,6339,1841
+0,21,6091,1769
+0,22,5850,1699
+0,23,5623,1633
+0,24,5402,1569
+0,25,5189,1507
+0,26,4986,1448
+0,27,4793,1392
+0,28,4604,1337
+0,29,4425,1285
+0,30,4249,1234
+0,31,4084,1186
+0,32,3922,1139
+0,33,3770,1095
+0,34,3622,1052
+0,35,3481,1011
+0,36,3343,971
+0,37,3213,933
+0,38,3085,896
+0,39,2965,861
+0,40,2851,828
+0,41,2737,795
+0,42,2631,764
+0,43,2527,734
+0,44,2427,705
+0,45,2335,678
+0,46,2242,651
+0,47,2152,625
+0,48,2069,601
+0,49,1987,577
+0,50,1911,555
+0,51,1835,533
+0,52,1763,512
+0,53,1694,492
+0,54,1629,473
+0,55,1563,454
+0,56,1501,436
+0,57,1443,419
+0,58,1388,403
+0,59,1333,387
+0,60,1281,372
+0,61,1229,357
+0,62,1181,343
+0,63,1136,330
+0,64,1092,317
+0,65,1047,304
+0,66,1005,292
+0,67,968,281
+0,68,930,270
+0,69,892,259
+0,70,857,249
+0,71,823,239
+0,72,792,230
+0,73,763,221
+0,74,733,213
+0,75,704,204
+0,76,676,196
+0,77,650,189
+0,78,624,181
+0,79,600,174
+0,80,576,167
+0,81,554,161
+0,82,532,155
+0,83,511,149
+0,84,491,143
+0,85,472,137
+0,86,453,132
+0,87,436,127
+0,88,419,122
+0,89,402,117
+0,90,386,112
+0,91,371,108
+0,92,357,104
+0,93,343,100
+0,94,329,96
+0,95,316,92
+0,96,304,88
+0,97,292,85
+0,98,281,82
+0,99,270,78
+0,100,259,75
+0,101,249,72
+0,102,239,69
+0,103,230,67
+0,104,221,64
+0,105,212,62
+0,106,204,59
+0,107,196,57
+0,108,188,55
+0,109,181,53
+0,110,174,50
+0,111,167,48
+0,112,160,47
+0,113,154,45
+0,114,148,43
+0,115,142,41
+0,116,137,40
+0,117,131,38
+0,118,126,37
+0,119,121,35
+0,120,116,34
+0,121,112,33
+0,122,107,31
+0,123,103,30
+0,124,99,29
+0,125,95,28
+0,126,92,27
+0,127,88,26
+1,0,88,26
+1,1,92,27
+1,2,95,28
+1,3,99,29
+1,4,103,30
+1,5,108,31
+1,6,112,33
+1,7,117,34
+1,8,121,35
+1,9,126,37
+1,10,131,38
+1,11,137,40
+1,12,142,41
+1,13,148,43
+1,14,154,45
+1,15,160,46
+1,16,167,49
+1,17,174,51
+1,18,181,53
+1,19,188,55
+1,20,196,57
+1,21,204,59
+1,22,212,62
+1,23,221,64
+1,24,230,67
+1,25,239,69
+1,26,249,72
+1,27,259,75
+1,28,270,78
+1,29,281,82
+1,30,292,85
+1,31,304,88
+1,32,317,92
+1,33,329,96
+1,34,343,100
+1,35,357,104
+1,36,371,108
+1,37,387,112
+1,38,402,117
+1,39,419,122
+1,40,436,127
+1,41,454,132
+1,42,472,137
+1,43,491,143
+1,44,511,148
+1,45,532,155
+1,46,554,161
+1,47,576,167
+1,48,600,174
+1,49,624,181
+1,50,650,189
+1,51,676,196
+1,52,704,204
+1,53,733,213
+1,54,763,222
+1,55,794,231
+1,56,826,240
+1,57,860,250
+1,58,895,260
+1,59,931,270
+1,60,969,281
+1,61,1009,293
+1,62,1050,305
+1,63,1093,317
+1,64,1137,330
+1,65,1184,344
+1,66,1232,358
+1,67,1282,372
+1,68,1334,387
+1,69,1389,403
+1,70,1445,420
+1,71,1504,437
+1,72,1566,455
+1,73,1629,473
+1,74,1696,493
+1,75,1765,513
+1,76,1837,534
+1,77,1912,555
+1,78,1990,578
+1,79,2071,601
+1,80,2155,626
+1,81,2243,651
+1,82,2335,678
+1,83,2430,706
+1,84,2529,734
+1,85,2632,764
+1,86,2739,795
+1,87,2851,828
+1,88,2967,862
+1,89,3088,897
+1,90,3214,933
+1,91,3345,971
+1,92,3482,1011
+1,93,3624,1053
+1,94,3771,1095
+1,95,3925,1140
+1,96,4085,1186
+1,97,4252,1235
+1,98,4425,1285
+1,99,4605,1337
+1,10,4793,1392
+1,10,4989,1449
+1,10,5192,1508
+1,10,5404,1569
+1,10,5624,1633
+1,10,5853,1700
+1,10,6092,1769
+1,10,6340,1841
+1,10,6599,1917
+1,10,6868,1995
+1,11,7148,2076
+1,11,7439,2160
+1,11,7743,2249
+1,11,8058,2340
+1,11,8387,2436
+1,11,8729,2535
+1,11,9085,2639
+1,11,9455,2746
+1,11,9841,2858
+1,11,10242,2975
+1,12,10659,3096
+1,12,11094,3222
+1,12,11546,3353
+1,12,12017,3490
+1,12,12507,3632
+1,12,13017,3780
+1,12,13548,3935
+1,12,14100,4095

imap_processing/codice/data/lo_stepping_values.csv

@@ -0,0 +1,129 @@
+table_num,row_num,num_reps,store_data,e1,e2,e3,e4,e5,e6,e7,e8,acq_time
+0,0,1,12,0,-,-,-,-,-,-,-,578.708
+0,1,1,12,1,-,-,-,-,-,-,-,578.708
+0,2,1,12,2,-,-,-,-,-,-,-,578.708
+0,3,1,12,3,-,-,-,-,-,-,-,578.708
+0,4,1,12,4,5,-,-,-,-,-,-,289.354
+0,5,1,12,6,7,-,-,-,-,-,-,289.354
+0,6,1,12,8,9,-,-,-,-,-,-,289.354
+0,7,1,12,10,11,-,-,-,-,-,-,289.354
+0,8,1,12,12,13,14,-,-,-,-,-,192.903
+0,9,1,12,15,16,17,-,-,-,-,-,192.903
+0,10,1,12,18,19,20,-,-,-,-,-,192.903
+0,11,1,12,21,22,23,-,-,-,-,-,192.903
+0,12,1,12,24,25,26,27,-,-,-,-,144.677
+0,13,1,12,28,29,30,31,-,-,-,-,144.677
+0,14,1,12,32,33,34,35,-,-,-,-,144.677
+0,15,1,12,36,37,38,39,-,-,-,-,144.677
+0,16,1,12,40,41,42,43,44,-,-,-,115.742
+0,17,1,12,45,46,47,48,49,-,-,-,115.742
+0,18,1,12,50,51,52,53,54,-,-,-,115.742
+0,19,1,12,55,56,57,58,59,-,-,-,115.742
+0,20,1,12,60,61,62,63,64,-,-,-,115.742
+0,21,1,12,65,66,67,68,69,-,-,-,115.742
+0,22,1,12,70,71,72,73,74,-,-,-,115.742
+0,23,1,12,75,76,77,78,79,-,-,-,115.742
+0,24,1,12,80,81,82,83,84,85,-,-,95.694
+0,25,1,12,86,87,88,89,90,91,-,-,95.694
+0,26,1,12,92,93,94,95,96,97,-,-,95.694
+0,27,1,12,98,99,100,101,102,103,-,-,95.694
+0,28,1,12,104,105,106,107,108,109,-,-,95.694
+0,29,1,12,110,111,112,113,114,115,-,-,95.694
+0,30,1,12,116,117,118,119,120,121,-,-,95.694
+0,31,1,11,122,123,124,125,126,127,-,-,95.694
+1,0,1,12,0,-,-,-,-,-,-,-,578.708
+1,1,1,12,1,-,-,-,-,-,-,-,578.708
+1,2,1,12,2,-,-,-,-,-,-,-,578.708
+1,3,1,12,3,-,-,-,-,-,-,-,578.708
+1,4,1,12,4,5,-,-,-,-,-,-,289.354
+1,5,1,12,6,7,-,-,-,-,-,-,289.354
+1,6,1,12,8,9,-,-,-,-,-,-,289.354
+1,7,1,12,10,11,-,-,-,-,-,-,289.354
+1,8,1,12,12,13,14,-,-,-,-,-,192.903
+1,9,1,12,15,16,17,-,-,-,-,-,192.903
+1,10,1,12,18,19,20,-,-,-,-,-,192.903
+1,11,1,12,21,22,23,-,-,-,-,-,192.903
+1,12,1,12,24,25,26,27,-,-,-,-,144.677
+1,13,1,12,28,29,30,31,-,-,-,-,144.677
+1,14,1,12,32,33,34,35,-,-,-,-,144.677
+1,15,1,12,36,37,38,39,-,-,-,-,144.677
+1,16,1,12,40,41,42,43,44,-,-,-,115.742
+1,17,1,12,45,46,47,48,49,-,-,-,115.742
+1,18,1,12,50,51,52,53,54,-,-,-,115.742
+1,19,1,12,55,56,57,58,59,-,-,-,115.742
+1,20,1,12,60,61,62,63,64,-,-,-,115.742
+1,21,1,12,65,66,67,68,69,-,-,-,115.742
+1,22,1,12,70,71,72,73,74,-,-,-,115.742
+1,23,1,12,75,76,77,78,79,-,-,-,115.742
+1,24,1,12,80,81,82,83,84,85,-,-,95.694
+1,25,1,12,86,87,88,89,90,91,-,-,95.694
+1,26,1,12,92,93,94,95,96,97,-,-,95.694
+1,27,1,12,98,99,100,101,102,103,-,-,95.694
+1,28,1,12,104,105,106,107,108,109,-,-,95.694
+1,29,1,12,110,111,112,113,114,115,-,-,95.694
+1,30,1,12,116,117,118,119,120,121,-,-,95.694
+1,31,1,11,122,123,124,125,126,127,-,-,95.694
+2,0,1,12,0,-,-,-,-,-,-,-,578.708
+2,1,1,12,1,-,-,-,-,-,-,-,578.708
+2,2,1,12,2,-,-,-,-,-,-,-,578.708
+2,3,1,12,3,-,-,-,-,-,-,-,578.708
+2,4,1,12,4,5,-,-,-,-,-,-,289.354
+2,5,1,12,6,7,-,-,-,-,-,-,289.354
+2,6,1,12,8,9,-,-,-,-,-,-,289.354
+2,7,1,12,10,11,-,-,-,-,-,-,289.354
+2,8,1,12,12,13,14,-,-,-,-,-,192.903
+2,9,1,12,15,16,17,-,-,-,-,-,192.903
+2,10,1,12,18,19,20,-,-,-,-,-,192.903
+2,11,1,12,21,22,23,-,-,-,-,-,192.903
+2,12,1,12,24,25,26,27,-,-,-,-,144.677
+2,13,1,12,28,29,30,31,-,-,-,-,144.677
+2,14,1,12,32,33,34,35,-,-,-,-,144.677
+2,15,1,12,36,37,38,39,-,-,-,-,144.677
+2,16,1,12,40,41,42,43,44,-,-,-,115.742
+2,17,1,12,45,46,47,48,49,-,-,-,115.742
+2,18,1,12,50,51,52,53,54,-,-,-,115.742
+2,19,1,12,55,56,57,58,59,-,-,-,115.742
+2,20,1,12,60,61,62,63,64,-,-,-,115.742
+2,21,1,12,65,66,67,68,69,-,-,-,115.742
+2,22,1,12,70,71,72,73,74,-,-,-,115.742
+2,23,1,12,75,76,77,78,79,-,-,-,115.742
+2,24,1,12,80,81,82,83,84,85,-,-,95.694
+2,25,1,12,86,87,88,89,90,91,-,-,95.694
+2,26,1,12,92,93,94,95,96,97,-,-,95.694
+2,27,1,12,98,99,100,101,102,103,-,-,95.694
+2,28,1,12,104,105,106,107,108,109,-,-,95.694
+2,29,1,12,110,111,112,113,114,115,-,-,95.694
+2,30,1,12,116,117,118,119,120,121,-,-,95.694
+2,31,1,11,122,123,124,125,126,127,-,-,95.694
+3,0,1,12,0,-,-,-,-,-,-,-,578.708
+3,1,1,12,1,-,-,-,-,-,-,-,578.708
+3,2,1,12,2,-,-,-,-,-,-,-,578.708
+3,3,1,12,3,-,-,-,-,-,-,-,578.708
+3,4,1,12,4,5,-,-,-,-,-,-,289.354
+3,5,1,12,6,7,-,-,-,-,-,-,289.354
+3,6,1,12,8,9,-,-,-,-,-,-,289.354
+3,7,1,12,10,11,-,-,-,-,-,-,289.354
+3,8,1,12,12,13,14,-,-,-,-,-,192.903
+3,9,1,12,15,16,17,-,-,-,-,-,192.903
+3,10,1,12,18,19,20,-,-,-,-,-,192.903
+3,11,1,12,21,22,23,-,-,-,-,-,192.903
+3,12,1,12,24,25,26,27,-,-,-,-,144.677
+3,13,1,12,28,29,30,31,-,-,-,-,144.677
+3,14,1,12,32,33,34,35,-,-,-,-,144.677
+3,15,1,12,36,37,38,39,-,-,-,-,144.677
+3,16,1,12,40,41,42,43,44,-,-,-,115.742
+3,17,1,12,45,46,47,48,49,-,-,-,115.742
+3,18,1,12,50,51,52,53,54,-,-,-,115.742
+3,19,1,12,55,56,57,58,59,-,-,-,115.742
+3,20,1,12,60,61,62,63,64,-,-,-,115.742
+3,21,1,12,65,66,67,68,69,-,-,-,115.742
+3,22,1,12,70,71,72,73,74,-,-,-,115.742
+3,23,1,12,75,76,77,78,79,-,-,-,115.742
+3,24,1,12,80,81,82,83,84,85,-,-,95.694
+3,25,1,12,86,87,88,89,90,91,-,-,95.694
+3,26,1,12,92,93,94,95,96,97,-,-,95.694
+3,27,1,12,98,99,100,101,102,103,-,-,95.694
+3,28,1,12,104,105,106,107,108,109,-,-,95.694
+3,29,1,12,110,111,112,113,114,115,-,-,95.694
+3,30,1,12,116,117,118,119,120,121,-,-,95.694
+3,31,1,11,122,123,124,125,126,127,-,-,95.694

imap_processing/codice/decompress.py

@@ -0,0 +1,142 @@
+"""
+Will decompress CoDICE science data.
+
+For CoDICE, there are 3 forms of compression:
+
+    | 1. Table-based lossy compression A (24- or 32-bit -> 8-bit)
+    | 2. Table-based lossy compression B (24- or 32-bit -> 8 bit)
+    | 3. LZMA lossless compression
+
+Only one lossy option can be selected in cases of lossy + lossless compression.
+Thus, there are 6 possibly compression algorithms:
+
+    | 1. No compression
+    | 2. Lossy A only
+    | 3. Lossy B only
+    | 4. Lossless only
+    | 5. Lossy A + lossless
+    | 6. Lossy B + lossless
+
+In the case of (5) and (6), the data is first run through lossy compression, and
+then the result is run through lossless compression. Thus, to decompress, one
+must apply lossless decompression first, then lossy decompression
+
+References
+----------
+    This information was provided via email from Greg Dunn on Oct 23, 2023
+"""
+
+import lzma
+from enum import IntEnum
+
+from imap_processing.codice.constants import LOSSY_A_TABLE, LOSSY_B_TABLE
+from imap_processing.codice.utils import CoDICECompression
+
+
+def _apply_lossy_a(compressed_bytes: bytes) -> list[int]:
+    """
+    Apply 8-bit to 32-bit Lossy A decompression algorithm.
+
+    The Lossy A algorithm uses a lookup table imported into this module.
+
+    Parameters
+    ----------
+    compressed_bytes : bytes
+        The compressed byte stream.
+
+    Returns
+    -------
+    decompressed_values : list[int]
+        The 24- or 32-bit decompressed values.
+    """
+    compressed_values = list(compressed_bytes)
+    decompressed_values = [LOSSY_A_TABLE[item] for item in compressed_values]
+    return decompressed_values
+
+
+def _apply_lossy_b(compressed_bytes: bytes) -> list[int]:
+    """
+    Apply 8-bit to 32-bit Lossy B decompression algorithm.
+
+    The Lossy B algorithm uses a lookup table imported into this module.
+
+    Parameters
+    ----------
+    compressed_bytes : bytes
+        The compressed byte stream.
+
+    Returns
+    -------
+    decompressed_values : list[int]
+        The 24- or 32-bit decompressed values.
+    """
+    compressed_values = list(compressed_bytes)
+    decompressed_values = [LOSSY_B_TABLE[item] for item in compressed_values]
+    return decompressed_values
+
+
+def _apply_lzma_lossless(compressed_bytes: bytes) -> bytes:
+    """
+    Apply LZMA lossless decompression algorithm.
+
+    Parameters
+    ----------
+    compressed_bytes : bytes
+        The compressed byte stream.
+
+    Returns
+    -------
+    lzma_decompressed_values : bytes
+        The 24- or 32-bit lzma decompressed values.
+    """
+    lzma_decompressed_values = lzma.decompress(compressed_bytes)
+
+    return lzma_decompressed_values
+
+
+def decompress(compressed_binary: str, algorithm: IntEnum) -> list[int]:
+    """
+    Perform decompression on a binary string into a list of integers.
+
+    Apply the appropriate decompression algorithm(s) based on the value
+    of the ``algorithm`` attribute. One or more individual algorithms may be
+    applied to a given compressed value.
+
+    Parameters
+    ----------
+    compressed_binary : str
+        The compressed binary string.
+    algorithm : int
+        The algorithm to apply. Supported algorithms are provided in the
+        ``codice_utils.CoDICECompression`` class.
+
+    Returns
+    -------
+    decompressed_values : list[int]
+        The 24- or 32-bit decompressed values.
+    """
+    # Convert the binary string to a byte stream
+    compressed_bytes = int(compressed_binary, 2).to_bytes(
+        (len(compressed_binary) + 7) // 8, byteorder="big"
+    )
+
+    # Apply the appropriate decompression algorithm
+    if algorithm == CoDICECompression.NO_COMPRESSION:
+        decompressed_values = list(compressed_bytes)
+    elif algorithm == CoDICECompression.LOSSY_A:
+        decompressed_values = _apply_lossy_a(compressed_bytes)
+    elif algorithm == CoDICECompression.LOSSY_B:
+        decompressed_values = _apply_lossy_b(compressed_bytes)
+    elif algorithm == CoDICECompression.LOSSLESS:
+        decompressed_bytes = _apply_lzma_lossless(compressed_bytes)
+        decompressed_values = list(decompressed_bytes)
+    elif algorithm == CoDICECompression.LOSSY_A_LOSSLESS:
+        decompressed_bytes = _apply_lzma_lossless(compressed_bytes)
+        decompressed_values = _apply_lossy_a(decompressed_bytes)
+    elif algorithm == CoDICECompression.LOSSY_B_LOSSLESS:
+        decompressed_bytes = _apply_lzma_lossless(compressed_bytes)
+        decompressed_values = _apply_lossy_b(decompressed_bytes)
+    else:
+        raise ValueError(f"{algorithm} is not supported")
+
+    return decompressed_values