Update sensors.py: new function for datacube size (in bit)

.pre-commit-config.yaml

@@ -1,26 +1,26 @@
 repos:
 - repo: https://github.com/pycqa/isort
-  rev: 5.10.1
+  rev: 5.13.2
   hooks:
   - id: isort
 
 - repo: https://github.com/psf/black
-  rev: 22.3.0
+  rev: 24.3.0
   hooks:
   - id: black
 
 - repo: https://github.com/PyCQA/autoflake
-  rev: v1.7.7
+  rev: v2.3.1
   hooks:
   - id: autoflake
 
 - repo: https://github.com/asottile/pyupgrade
-  rev: v2.32.0
+  rev: v3.15.1
   hooks:
   - id: pyupgrade
 
 - repo: https://github.com/myint/docformatter
-  rev: v1.5.0
+  rev: v1.7.5
   hooks:
   - id: docformatter
     args: [--blank, --in-place, --recursive, --wrap-descriptions=88, --wrap-summaries=80] # does not yet support toml config
@@ -33,7 +33,7 @@ repos:
 
 
 - repo: https://github.com/nbQA-dev/nbQA
-  rev: 1.3.1
+  rev: 1.8.4
   hooks:
   - id: nbqa-isort
   - id: nbqa-black

architect/libs/utillib.py

@@ -1,4 +1,5 @@
 """An assortment of utilities and classes for scientific computing."""
+
 # external
 import numpy as np
 from astropy.units.quantity import Quantity

architect/luts/__init__.py

@@ -1,2 +1,3 @@
 """Look Up Table implementation."""
+
 from .functions import *

architect/systems/__init__.py

@@ -1,3 +1,4 @@
 """Import base classes."""
+
 from .system import System  # isort:skip
 from .component import Component

architect/systems/component.py

@@ -1,4 +1,5 @@
 """Component class."""
+
 # external
 import astropy.units as unit
 

architect/systems/optical/__init__.py

@@ -1,2 +1,3 @@
 """Import component type."""
+
 from .optical_component import OpticalComponent

architect/systems/optical/optical_component.py

@@ -1,4 +1,5 @@
 """Optical component class."""
+
 # stdlib
 import logging
 

architect/systems/optical/sensors.py

@@ -189,6 +189,26 @@ def get_waveband(self) -> Quantity[unit.m]:
         else:
             raise ValueError("Waveband is not set.")
 
+    def get_datacube_size(self) -> unit.bit:
+        """Get the size of datacube in bit.
+
+        Ref: https://www.notion.so/utat-ss/Hyperspectral-Datacube-Size-5390b2593dff48b2b96d954eb8267844
+
+        """
+
+        assert self.n_px is not None, "n_px must be specified."
+        assert self.n_bit is not None, "n_bit must be specified."
+
+        npxx = self.n_px[
+            0
+        ]  # 640 px, pixels on the sensor in the across-track direction -> spatial information
+        npxy = self.n_px[
+            1
+        ]  # 512 px, pixels on the sensor in the along-track direction -> spectral information
+        nbit = self.n_bit  # bit depth
+        D = npxx * npxx * npxy * nbit
+        return D / unit.pix**3
+
 
 class TauSWIR(Sensor):
     """Teledyne FLIR Tau SWIR sensor.

architect/systems/optical/spectrometers.py

@@ -1,4 +1,5 @@
 """Spectrometer classes."""
+
 # stdlib
 import logging
 import math

architect/systems/space/satellites.py

@@ -1,4 +1,5 @@
 """Satellite system classes."""
+
 # external
 import astropy.constants as const
 import astropy.units as unit

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "architect"
-version = "0.1.0"
+version = "1.4.0"
 description = ""
 authors = ["UTAT"]
 

tests/test_systems/test_optical/test_diffractors/test_TransmissiveDiffractor.py

@@ -1,4 +1,5 @@
 """Tests for transmissive diffractor component."""
+
 # stdlib
 import logging
 

tests/test_systems/test_optical/test_diffractors/test_VPHGrating.py

@@ -1,4 +1,5 @@
 """Tests for VPH Grating component."""
+
 # stdlib
 import logging
 

tests/test_systems/test_optical/test_diffractors/test_VPHGrism.py

@@ -1,4 +1,5 @@
 """Tests for VPH Grism component."""
+
 # stdlib
 import logging
 

tests/test_systems/test_optical/test_foreoptics/test_Foreoptic.py

@@ -1,4 +1,5 @@
 """Tests for Foreoptic component."""
+
 # stdlib
 import logging
 

tests/test_systems/test_optical/test_lenses/test_Lens.py

@@ -1,4 +1,5 @@
 """Tests for AchromLens component."""
+
 # stdlib
 import logging
 

tests/test_systems/test_optical/test_sensors/test_Sensor.py

@@ -1,4 +1,5 @@
 """Tests for Sensor component."""
+
 # stdlib
 import logging
 
@@ -156,3 +157,14 @@ def test_get_efficiency():
     LOG.info(result)
 
     assert result.unit == unit.pct * unit.electron
+
+
+def test_get_datacube_size():
+    """Test get_datacube_size method."""
+
+    sensor = Sensor(n_px=(640, 512) * unit.pix, n_bit=14 * unit.bit)
+
+    result = sensor.get_datacube_size()
+    LOG.info(result)
+
+    assert result.unit == unit.bit

tests/test_systems/test_optical/test_spectrometers/test_FINCHEye.py

@@ -1,4 +1,5 @@
 """FINCHEye class tests."""
+
 # stdlib
 import logging
 

tests/test_systems/test_space/test_CubeSat.py

@@ -1,4 +1,5 @@
 """Satellite class tests."""
+
 # stdlib
 import logging
 

tests/test_systems/test_space/test_FINCH.py

@@ -1,4 +1,5 @@
 """Satellite class tests."""
+
 # stdlib
 import logging
 

tests/test_systems/test_space/test_Satellite.py

@@ -1,4 +1,5 @@
 """Satellite class tests."""
+
 # stdlib
 import logging
 

tests/test_systems/test_system.py

@@ -1,4 +1,5 @@
 """System class tests."""
+
 # stdlib
 import logging