pyASDReader 1.2.0__py3-none-any.whl

pyASDReader/constant.py

@@ -0,0 +1,138 @@
+"""
+The constant values for the ASD file format
+"""
+from enum import Enum
+
+
+# metadata.fileVersion: ASD File Version, at byte offset 0
+class FileVersion_e(Enum):
+    FILE_VERSION_INVALID = 0
+    FILE_VERSION_1 = 1
+    FILE_VERSION_2 = 2
+    FILE_VERSION_3 = 3
+    FILE_VERSION_4 = 4
+    FILE_VERSION_5 = 5
+    FILE_VERSION_6 = 6
+    FILE_VERSION_7 = 7
+    FILE_VERSION_8 = 8
+
+# metadata.instrument: Instrument type that created spectrum, at byte offset 431
+class InstrumentType_e(Enum):
+    UNKNOWN_INSTRUMENT = 0
+    PSII_INSTRUMENT = 1
+    LSVNIR_INSTRUMENT = 2
+    FSVNIR_INSTRUMENT = 3
+    FSFR_INSTRUMENT = 4
+    FSNIR_INSTRUMENT = 5
+    CHEM_INSTRUMENT = 6
+    LAB_SPEC_PRO = 7
+    HAND_HELD_INSTRUMENT = 10
+
+class InstrumentModel_e(Enum):
+    itVnir = 1
+    # itDual
+    itSwir1 = 4
+    itVnirSwir1 = 5
+    itSwir2 = 8
+    itVnirSwir2 = 9
+    itSwir1Swir2 = 12
+    itVnirSwir1Swir2 = 13
+
+# metadata.dataType: Spectrum type, at byte offset 186
+class SpectraType_e(Enum):
+    RAW = 0
+    REFLECTANCE = 1
+    RADIANCE = 2
+    NO_UNITS = 3
+    IRRADIANCE = 4
+    QUALITY_INDEX = 5
+
+class SignatureState_e(Enum):
+    SIGNED_INVALID = -1
+    UN_SIGNED = 0
+    SIGNED = 1
+    # VERIFIED = 2
+    # NOT_VERIFIED = 3
+
+class AuditLogType_e(Enum):
+    AUDIT_EVENT_ELEMENT = "Audit_Event"
+    AUDIT_APPLICATION_ELEMENT = "Audit_Application"
+    AUDIT_APP_VERSION_ELEMENT = "Audit_AppVersion"
+    AUDIT_FUNCTION_ELEMENT = "Audit_Function"
+    AUDIT_SOURCE_ELEMENT = "Audit_Source"
+    AUDIT_LOGIN_ELEMENT = "Audit_Login"
+    AUDIT_NAME_ELEMENT = "Audit_Name"
+    AUDIT_TIME_ELEMENT = "Audit_Time"
+    AUDIT_NOTES_ELEMENT = "Audit_Notes"
+
+class IT_ms_e(Enum):
+    Invalid = 0         # 0 ms, not inluded in the original manual and codes, added by Kai Cao
+    ms_8 = 8            # 8 ms, not inluded in the original manual and codes, added by Kai Cao
+    ms_8_5 = 9
+    ms_17 = 17
+    ms_34 = 34
+    ms_68 = 68
+    ms_136 = 136
+    ms_272 = 272
+    ms_544 = 544
+    ms_1088 = 1088
+    ms_2176 = 2176
+    ms_4352 = 4352
+    ms_8704 = 8704
+    ms_17408 = 17408
+    ms_34816 = 34816
+    ms_69632 = 69632
+    ms_139264 = 139264
+    ms_278528 = 278528
+    ms_557056 = 557056
+
+# metadata.dataFormat: Spectrum data format, at byte offset 199
+class DataFormat_e(Enum):
+    df_FLOAT = 0
+    df_INTEGER = 1
+    df_DOUBLE = 2
+    df_UNKNOWN = 3
+
+# metadata.calibrationSeries: Calibration type, at byte offset 432
+class CalibrationType_e(Enum):
+    cb_ABSOLUTE = 0         # ABS, Absolute Reflectance File;
+    cb_BASE = 1             # BSE, Base File
+    cb_LAMP = 2             # LMP, Lamp File
+    cb_FIBER = 3            # FO, Fiber Optic File
+    cb_UNKNOWN = 4          # Unknown Calibration Series
+
+class DataType_e(Enum):
+    dt_RAW_TYPE = 0          # Raw Spectrum File
+    dt_REF_TYPE = 1          # Reflectance File
+    dt_RAD_TYPE = 2          # Radiance File
+    dt_NOUNITS_TYPE = 3      # No Units File
+    dt_IRRAD_TYPE = 4        # Irradiance File
+    dt_QI_TYPE = 5           # Quality Index File
+    dt_TRANS_TYPE = 6        # Transmittance File
+    dt_UNKNOWN_TYPE = 7      # Unknown File
+    dt_ABS_TYPE = 8          # Absolute Reflectance File
+    # dt_ADF_TYPE
+    # dt_ADC_TYPE
+    # dt_MTF_TYPE
+    # dt_MTC_TYPE
+    # dt_RTF_TYPE
+    # dt_RTC_TYPE
+    # dt_SBF_TYPE
+    # dt_SBC_TYPE
+
+# Classifier Data Type
+class ClassiferDataType_e(Enum):
+    SAM = 0
+    GALACTIC = 1
+    CAMOPREDICT = 2
+    CAMOCLASSIFY = 3
+    PCAZ = 4
+    INFOMETRIX = 5
+
+# Error types for flags2 in the metadata
+class SaturationError_e(Enum):
+    VNIR_SATURATION = 1         # Vnir Saturation    0 0 0 0  0 0 0 1   0x01
+    SWIR1_SATURATION = 2        # Swir1 Saturation   0 0 0 0  0 0 1 0   0x02
+    SWIR2_SATURATION = 4        # Swir2 Saturation   0 0 0 0  0 1 0 0   0x04
+    SWIR1_TEC_ALARM = 8         # Swir1 Tec Alarm    0 0 0 0  1 0 0 0   0x08
+    SWIR2_TEC_ALARM = 16        # Swir2 Tec Alarm    0 0 0 1  0 0 0 0   0x16

pyASDReader/file_attributes.py

@@ -0,0 +1,113 @@
+"""
+File attribute class includes the following aspects: 
+        • File attributes include: file name, path, size, creation time, modification time, access time, file type, etc.
+        • Some basic operations can be provided for files, such as reading, writing, deleting, etc.
+        • File permission settings may need support (such as read-only, executable, etc.).
+
+Main function description:
+    1. Initialization method (__init__): Receive the file path, check whether the file exists, and then get the basic information of the file (such as name, size, creation time, modification time, access time, etc.).
+    2. Get file type (get_file_type): Get the file type by the file extension.
+    3. Read file (read_file): Read the file's content and return it.
+    4. Write file (write_to_file): Write the content to the file, overwriting the original content.
+    5. Delete file (delete_file): Delete the file in the specified path.
+    6. Print basic information of the file (__str__): Returns brief information of the file, which is convenient for viewing the properties of the file.
+
+3. To be added:
+• More properties such as file permissions, file owners, and file locking mechanisms.
+• Support file reading and writing in different encoding formats.
+• Error handling mechanisms to ensure robustness in abnormal situations.
+"""
+
+
+import os
+import time
+import hashlib
+
+
+class FileAttributes(object):
+    def __init__(self, filepath):
+
+        if os.path.exists(filepath) and os.path.isfile(filepath):
+            self.filepath = filepath
+        else:
+            print(f"File \'{filepath}\' do not exist.")
+            exception = FileNotFoundError(f"File \'{filepath}\' do not exist.")
+            raise exception
+            
+        # Basic file attributes
+        self.filepath = filepath
+        self.filename = os.path.basename(filepath)
+        self.filesize = os.path.getsize(filepath)
+        self.filetype = os.path.splitext(filepath)[1]
+        self.dirname = os.path.dirname(filepath)
+        self.creation_time = time.ctime(os.path.getctime(filepath))
+        self.modification_time = time.ctime(os.path.getmtime(filepath))
+        self.access_time = time.ctime(os.path.getatime(filepath))
+        self.file_permission = os.stat(filepath).st_mode
+        self._data = self.__get_data()
+        self._hashMD5 = None
+        self._hashSHA265 = None
+    
+    def __get_data(self):
+        with open(self.filepath, 'rb') as file:
+            return file.read()
+    
+    def delete(self):
+        if os.path.exists(self.filepath) and os.path.isfile(self.filepath):
+            os.remove(self.filepath)
+        else:
+            print(f"File delete fail: file \'{self.filepath}\' do not exist")
+            raise FileNotFoundError(f"File \'{self.filepath}\' do not exist")
+    
+    def read(self):
+        if os.path.exists(self.filepath) and os.path.isfile(self.filepath):
+            with open(self.filepath, 'r', encoding='utf-8') as file:
+                return file.read()
+    
+    def write(self, content):
+        if os.path.exists(self.filepath) and os.path.isfile(self.filepath):
+            with open(self.filepath, 'w', encoding='utf-8') as file:
+                file.write(content)
+
+    # def save(self):
+    #     with open(self.filepath, 'wb') as file:
+    #         file.write(content)
+
+    # def saveAS(self, filepath):
+    #     with open(filepath, 'wb') as file:
+    #         file.write(filepath)
+
+    def set_file_name(self, new_name):
+        self.file_name = new_name
+        self.file_path = os.path.join(os.path.dirname(self.file_path), new_name)
+    
+    def set_file_path(self, new_path):
+        self.file_path = new_path
+        self.file_name = os.path.basename(new_path)
+
+    def __str__(self):
+        return f"File Name: \t\t{self.filename}\n" \
+               f"File Path: \t\t{self.filepath}\n" \
+               f"File Size: \t\t{self.filesize} bytes\n" \
+               f"Creation Time: \t\t{self.creation_time}\n" \
+               f"Modification Time: \t{self.modification_time}\n" \
+               f"Access Time: \t\t{self.access_time}\n" \
+               f"File type: \t\t{self.filetype}\n"\
+               f"MD5: \t\t\t{self.hashMD5}\n" \
+               f"SHA265: \t\t{self.hashSHA265}"
+
+    @property
+    def hashMD5(self):
+        if self._hashMD5 is None:
+            self._hashMD5 = hashlib.md5(self._data).hexdigest()
+        return self._hashMD5
+    
+    @property
+    def hashSHA265(self):
+        if self._hashSHA265 is None:
+            self._hashSHA265 = hashlib.sha256(self._data).hexdigest()
+        return self._hashSHA265
+
+
+if __name__ == '__main__':
+    pass

pyASDReader/logger_setup.py

@@ -0,0 +1,35 @@
+import logging
+
+
+def setup_logging(log_file, log_level=logging.INFO) -> None:
+
+    # To generate a log file name that includes the date
+
+    # Set up logging format and level
+    level_list = [
+        logging.CRITICAL,
+        logging.ERROR,
+        logging.WARNING,
+        logging.INFO,
+        logging.DEBUG,
+        logging.NOTSET
+    ]
+
+    if log_level not in level_list:
+        raise ValueError(f"Invalid log level: {log_level}. Valid levels are as follows: {level_list}")
+
+
+    logging.basicConfig(
+        # Set the logging level
+        level=log_level,
+        # Log format
+        # format='%(asctime)s - %(levelname)s - %(message)s',
+        format='%(asctime)s - %(name)s - %(levelname)s - %(message)s - Line: %(lineno)d',
+        # format='%(levelname)s - %(message)s',
+        handlers=[
+            # NOTE: Create a file handler to log to console only
+            # logging.StreamHandler(),  
+            # NOTE: Create a file handler to log to a file and console
+            logging.FileHandler(log_file, encoding='utf-8')  # Log to file
+        ]
+    )