From 9a59a3a09d30eb2ceec6e671e7dee2968e913811 Mon Sep 17 00:00:00 2001 From: Talon Chandler Date: Tue, 23 Apr 2024 14:07:44 -0700 Subject: [PATCH] improved docsring --- .../models/isotropic_fluorescent_thick_3d.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/waveorder/models/isotropic_fluorescent_thick_3d.py b/waveorder/models/isotropic_fluorescent_thick_3d.py index dd6d70f..b52e71b 100644 --- a/waveorder/models/isotropic_fluorescent_thick_3d.py +++ b/waveorder/models/isotropic_fluorescent_thick_3d.py @@ -84,6 +84,21 @@ def visualize_transfer_function(viewer, optical_transfer_function, zyx_scale): def apply_transfer_function( zyx_object, optical_transfer_function, z_padding, background=10 ): + """Simulate imaging by applying a transfer function + + Parameters + ---------- + zyx_object : torch.Tensor + optical_transfer_function : torch.Tensor + z_padding : int + background : int, optional + constant background counts added to each voxel, by default 10 + + Returns + ------- + Simulated data : torch.Tensor + + """ if ( zyx_object.shape[0] + 2 * z_padding != optical_transfer_function.shape[0]