document 3d-to-2d transfer function

mehta-lab · Dec 21, 2024 · 55ff94e · 55ff94e
1 parent 888e29f
commit 55ff94e
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/waveorder/models/isotropic_thin_3d.py b/waveorder/models/isotropic_thin_3d.py
@@ -152,6 +152,11 @@ def visualize_transfer_function(
     absorption_2d_to_3d_transfer_function,
     phase_2d_to_3d_transfer_function,
 ):
+    """Note: unlike other `visualize_transfer_function` calls, this transfer 
+    function is a mixed 3D-to-2D transfer function, so it cannot reuse
+    util.add_transfer_function_to_viewer. If more 3D-to-2D transfer functions 
+    are added, consider refactoring.
+    """
     arrays = [
         (torch.imag(absorption_2d_to_3d_transfer_function), "Im(absorb TF)"),
         (torch.real(absorption_2d_to_3d_transfer_function), "Re(absorb TF)"),