Skip to content

Commit

Permalink
DOC: extraction docstring update
Browse files Browse the repository at this point in the history
Co-authored-by: Scott Lowe <[email protected]>
  • Loading branch information
swkeemink and scottclowe authored Jun 7, 2021
1 parent bf38e4d commit 7f5a4bf
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions fissa/extraction.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,20 @@


class DataHandlerAbstract():
"""Abstract class for data handling.
The main thing to keep consistent is that the input into getmean(), roise2mask(), and extracttraces() depend
on the output of the image2array and rois2mask.
See the below DataHandler() and DataHandlerPillow() classes for example usages.
"""Abstract class for a data handler.
Note
----
- The `data` input into :meth:`getmean`, :meth:`rois2masks`, and
:meth:`extracttraces` must be the same format as the output to
:meth:`image2array`.
- The `masks` input into :meth:`extracttraces` must be the same format
as the output of :meth:`rois2mask`.
See Also
--------
See :class:`DataHandlerTifffile` and :class:`DataHandlerPillow` for example
subclasses.
"""
def __init__(self):
pass
Expand Down

0 comments on commit 7f5a4bf

Please sign in to comment.