Make all artifact arguments optional & Add assert statements to catch undefined components in system functions

payload_designer/components/component.py

@@ -25,7 +25,8 @@ def __init__(self, dimensions: tuple = None, mass=None):
 
     def get_volume(self):
         """Get the volume of the component from its bounding box."""
-
+        assert self.dimensions is not None, "A dimensions component must be specified."
+
         volume = self.dimensions[0] * self.dimensions[1] * self.dimensions[2]
 
         return volume

payload_designer/components/diffractors.py

@@ -39,7 +39,8 @@ def get_emergent_angle(self, incident_angle, wavelength, order=1):
             order: Diffraction order.
 
         """
-
+        assert self.fringe_frequency is not None, "Fringe frequency must be specified."
+
         emergent_angle = np.arcsin(
             np.sin(incident_angle) - order * self.fringe_frequency * wavelength
         )
@@ -149,7 +150,10 @@ def __init__(
     def get_emergent_angle(
         self, incident_angle, wavelength, n_initial=1, n_final=1, order=1
     ):
-
+        assert self.index_seal is not None, "Index Seal must be specified."
+        assert self.fringe_frequency is not None, "Fringe frequency must be specified."
+        assert self.index_dcg is not None, "Index DCG must be specified."
+
         angle_1 = snell(angle=incident_angle, n_1=n_initial, n_2=self.index_seal)
         angle_2 = np.arscin(
             (order * wavelength * self.fringe_frequency / self.index_dcg)
@@ -161,7 +165,10 @@ def get_emergent_angle(
 
     def get_transmittance_theoretical(self, wavelength, order=1):
         """Calculates the Kogelnik efficiency for unpolarized light."""
-
+        assert self.index_dcg is not None, "Index DCG must be specified."
+        assert self.index_dcg_amplitude is not None, "Index DCG amplitude must be specified."
+        assert self.dcg_thickness is not None, "DCG thickness must be specified."
+
         a_2b = np.arcsin((order * wavelength) / (2 * self.index_dcg * wavelength))
         mu_s = (
             np.sin(
@@ -185,6 +192,9 @@ def get_transmittance_theoretical(self, wavelength, order=1):
         return mu_s
 
     def get_efficiency_bandwidth(self, wavelength, order=1):
+        assert self.index_dcg is not None, "Index DCG must be specified."
+        assert self.dcg_thickness is not None, "DCG thickness must be specified."
+
         a_2b = np.arcsin((order * wavelength) / (2 * self.index_dcg * wavelength))
         lmda_eff = (wavelength * wavelength) / (self.dcg_thickness * np.tan(a_2b))
 
@@ -227,6 +237,11 @@ def __init__(
     def get_emergent_angle(
         self, angle_in, wavelength, index_in=1, index_out=1, order=1
     ):
+        assert self.apex_angle is not None, "Apex angle must be specified."
+        assert self.index_prism is not None, "Index prism amplitude must be specified."
+        assert self.fringe_frequency is not None, "Fringe frequency must be specified."
+        assert self.index_seal is not None, "Index seal must be specified."
+
         angle_1 = angle_in + self.apex_angle
         angle_2 = snell(angle=angle_1, n_1=index_in, n_2=self.index_prism)
         angle_3 = self.apex_angle - angle_2
@@ -244,6 +259,11 @@ def get_emergent_angle(
         return angle_out
 
     def get_undeviated_wavelength(self, angle_in, order=1, index_in=1, index_out=1):
+        assert self.apex_angle is not None, "Apex angle must be specified."
+        assert self.index_prism is not None, "Index prism amplitude must be specified."
+        assert self.fringe_frequency is not None, "Fringe frequency must be specified."
+        assert self.index_seal is not None, "Index seal must be specified."
+
         angle_1 = angle_in + self.apex_angle
         angle_2 = snell(angle=angle_1, n_1=index_in, n_2=self.index_prism)
         angle_3 = self.apex_angle - angle_2

payload_designer/components/filters.py

@@ -27,15 +27,16 @@ def __init__(
         super().__init__(
             diameter=diameter,
             focal_length=None,
-            index=index,
-            mass=mass,
-            thickness=thickness,
-            transmittance=transmittance,
+            index=None,
+            mass=None,
+            thickness=None,
+            transmittance=None,
         ),
 
     def get_phase_shift(self, wavelength, angle_in, index_in=1):
         """Get the phase shift of the filter."""
-
+        assert self.index is not None, "Index must be specified."
+
         wavelength_shifted = wavelength * np.sqrt(
             1 - ((index_in, self.index) * np.sin(angle_in) ** 2)
         )
@@ -44,6 +45,7 @@ def get_phase_shift(self, wavelength, angle_in, index_in=1):
 
     def get_reflectance(self, index_in=1):
         """Get the reflectance of the filter."""
+        assert self.index is not None, "Index must be specified."
 
         reflectance = ((self.index - index_in) / (self.index + index_in)) ** 2
 

payload_designer/components/lenses.py

@@ -43,14 +43,16 @@ def __init__(
     def get_image_height(self, incident_angle):
         """Get the height of the image formed above or below the optical axis of
         the lens for an incoming beam of collimated light."""
-
+        assert self.focal_length is not None, "Focal length must be specified."
+
         image_height = self.focal_length * np.tan(incident_angle)
 
         return image_height
 
     def get_volume(self):
         """Get the volume of the lens."""
-
+        assert self.diameter is not None, "Diameter must be specified."
+
         volume = const.pi * (self.diameter / 2) ** 2 * self.thickness
 
         return volume

payload_designer/components/masks.py

@@ -29,7 +29,8 @@ def __init__(self, mass=None, diameter=None, thickness=None, size: tuple = None)
 
     def get_area(self):
         """Get the clear aperture slit area."""
-
+        assert self.size is not None, "Size must be specified."
+
         area = self.size[0] * self.size[1]
 
         return area

payload_designer/components/sensors.py

@@ -63,7 +63,9 @@ def __init__(
     def get_size(self) -> tuple:
         """Get the size of the sensor face in the (x, y) dimensions of the
         cubesat frame."""
-
+        assert self.n_px is not None, "n_px must be specified."
+        assert self.pitch is not None, "Pitch must be specified."
+
         size = (self.n_px * self.pitch, self.n_px * self.pitch)
 
         return size
@@ -83,28 +85,35 @@ def get_pixel_area(self):
         Assumes square pixels.
 
         """
+        assert self.pitch is not None, "Pitch must be specified."
 
         pixel_area = self.pitch**2
 
         return pixel_area
 
     def get_dark_noise(self):
         """Get the dark noise of the sensor."""
-
+        assert self.i_dark is not None, "i_dark must be specified."
+        assert self.dt is not None, "dt amplitude must be specified."
+
         dark_noise = self.i_dark * self.dt
 
         return dark_noise
 
     def get_quantization_noise(self):
         """Get the quantization noise of the sensor."""
-
+        assert self.n_well is not None, "n_well must be specified."
+        assert self.n_bit is not None, "n_bit must be specified."
+
         quant_noise = (1 / math.sqrt(12)) * self.n_well / 2**self.n_bit
 
         return quant_noise
 
     def get_noise(self, signal):
         """Get the net noise of the sensor."""
-
+        assert self.n_bin is not None, "n_bin must be specified."
+        assert self.noise_read is not None, "noise_read must be specified."
+
         noise = np.sqrt(
             signal
             + self.n_bin * self.get_dark_noise() ** 2

payload_designer/luts/functions.py

@@ -35,17 +35,22 @@ def __init__(self, path: Path, name: str = None):
         self.name = name
 
     def get_table(self):
+        assert self.x is not None, "x must be specified."
+        assert self.y is not None, "y must be specified."
+
         data = {f"X [{self.x.unit}]": self.x.value, f"Y [{self.y.unit}]": self.y.value}
 
         df = pd.DataFrame.from_dict(data)
 
         return df
 
     def __str__(self):
+        assert self.name is not None, "Name must be specified."
         df = self.get_table()
         return f"LUT ({self.name})\n{df.to_string(index=False)}"
 
     def _repr_html_(self):
+        assert self.name is not None, "Name must be specified."
         df = self.get_table()
         return f"LUT ({self.name})\n{df.to_html(index=False)}"
 
@@ -59,6 +64,8 @@ def __call__(self, x):
             array-like: The interpolated y values.
 
         """
+        assert self.x is not None, "x must be specified."
+        assert self.y is not None, "y must be specified."
         return np.interp(x=x, xp=self.x, fp=self.y)
 
 

payload_designer/systems/payloads.py

@@ -77,6 +77,9 @@ def get_signal_to_noise(self, radiance: LUT, wavelength):
             wavelength: Wavelength(s) at which to evaluate SNR.
 
         """
+        assert self.sensor is not None, "A sensor component must be specified." 
+        assert self.foreoptic is not None, "A foreoptic component must be specified."
+        assert self.slit is not None, "A slit component must be specified."
 
         signal = (
             (const.pi / 4)
@@ -97,12 +100,14 @@ def get_signal_to_noise(self, radiance: LUT, wavelength):
 
     def get_FOV(self) -> np.ndarray[float, float]:
         """Get the field of view vector.
-
+        
         A vector that defines the angular extent that can be imaged by the payload in
         the along-track and the across-track directions.
 
         """
-
+        assert self.slit is not None, "A slit component must be specified."
+        assert self.foreoptic is not None, "A foreoptic component must be specified."
+
         fov = 2 * np.arctan(self.slit.size / (2 * self.foreoptic.focal_length))
 
         return fov

payload_designer/systems/satellites.py

@@ -15,7 +15,8 @@ def __init__(self, altitude):
 
     def get_attrs_table(self):
         """Get a table of satellite parameters."""
-
+        assert self.altitude is not None, "An altitude component must be specified."
+
         orbit_radius = self.get_orbit_radius()
         orbit_velocity = self.get_orbit_velocity()
         orbit_angular_velocity = self.get_orbit_angular_velocity()
@@ -43,7 +44,8 @@ def get_attrs_table(self):
 
     def get_orbit_radius(self):
         """Get the orbital radius."""
-
+        assert self.altitude is not None, "An altitude component must be specified."
+
         R_orbit = const.R_earth + self.altitude
 
         return R_orbit