Skip to content

Commit

Permalink
improved docsring
Browse files Browse the repository at this point in the history
  • Loading branch information
talonchandler committed Apr 23, 2024
1 parent 43a8b2b commit 9a59a3a
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions waveorder/models/isotropic_fluorescent_thick_3d.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down

0 comments on commit 9a59a3a

Please sign in to comment.