Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mcencini committed Jan 24, 2024
1 parent 9f49a83 commit b10d396
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions src/deepmr/io/header/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@

__all__ = ["read_acquisition_header", "write_acquisition_header"]

# **kwargs
# Keyword arguments passed to the specific subroutines
# for the different datatypes (see 'Keyword Arguments'):

# * deepmr.io.matlab.read_matlab_acqhead(filepath, dcfpath, methodpath, sliceprofpath)

def read_acquisition_header(filepath, *args, device="cpu", verbose=False, **kwargs):
"""
Expand All @@ -30,11 +35,7 @@ def read_acquisition_header(filepath, *args, device="cpu", verbose=False, **kwar
Computational device for internal attributes. The default is "cpu".
verbose : int, optional
Verbosity level (0=Silent, 1=Less, 2=More). The default is 0.
**kwargs
Keyword arguments passed to the specific subroutines
for the different datatypes (see 'Keyword Arguments'):
* deepmr.io.matlab.read_matlab_acqhead(filepath, dcfpath, methodpath, sliceprofpath)
Keyword Arguments
-----------------
Expand Down

0 comments on commit b10d396

Please sign in to comment.