Skip to content

Commit

Permalink
Add class docstrings to Resource placeholders
Browse files Browse the repository at this point in the history
  • Loading branch information
ebrahimebrahim committed Aug 1, 2024
1 parent b4bfd71 commit e3be9ff
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
6 changes: 3 additions & 3 deletions src/abcdmicro/io.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@


class NiftiVolumeResrouce(VolumeResource):
pass
"""A volume or volume stack that is saved to disk in the nifti file format."""


class FslBvalResource(BvalResource):
pass
"""A b-value list that is saved to disk in the FSL text file format."""


class FslBvecResource(BvecResource):
pass
"""A b-vector list that is saved to disk in the FSL text file format."""
20 changes: 13 additions & 7 deletions src/abcdmicro/resource.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,34 @@


class Resource:
pass
"""Base class for resources."""


class VolumeResource(Resource):
pass
"""Base class for resources representing a volume or volume stack.
An n-D array where n >= 3 and where three of the dimensions are spatial
and have associated header information describing a patient coordinate system."""


class InMemoryVolumeResource(VolumeResource):
pass
"""A volume resource that is loaded into memory.
An n-D array where n >= 3 and where three of the dimensions are spatial
and have associated header information describing a patient coordinate system."""


class BvalResource(Resource):
pass
"""Base class for resources representing a list of b-values associated with a 4D DWI
volume stack."""


class InMemoryBvalResource(BvalResource):
pass
"""A b-value list that is loaded into memory."""


class BvecResource(Resource):
pass
"""Base class for resources representing a list of b-vectors associated with a 4D DWI
volume stack."""


class InMemoryBvecResource(BvecResource):
pass
"""A b-vector list that is loaded into memory."""

0 comments on commit e3be9ff

Please sign in to comment.