Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mcencini committed Jan 25, 2024
1 parent 89669aa commit 53799fa
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
3 changes: 2 additions & 1 deletion src/deepmr/io/header/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,8 @@ def read_acqheader(filepath, *args, device="cpu", verbose=False, **kwargs):
* **2Dcart:** reconstructed image has (nslices, ncontrasts, ny, nx) -> transpose = [1, 0, 2, 3]
* **2Dnoncart:** reconstructed image has (nslices, ncontrasts, ny, nx) -> transpose = [1, 0, 2, 3]
* **3Dcart:** reconstructed image has (ncontrasts, nz, ny, nx) -> transpose = [0, 1, 2, 3]
* **3Dnoncart:** reconstructed image has (nx, ncontrasts, nz, ny) -> transpose = [1, 2, 3, 0]
* **3Dnoncart:** reconstructed image has (nx, ncontrasts, nz, ny) -> transpose = [1, 2, 3, 0]
The default is an empty list (no transposition).
"""
Expand Down
2 changes: 1 addition & 1 deletion src/deepmr/io/image/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ def write_image(
Structure containing trajectory of shape (ncontrasts, nviews, npts, ndim)
and meta information (shape, resolution, spacing, etc). If None,
assume 1mm isotropic resolution, contiguous slices and axial orientation.
The default is None
The default is None.
dataformat : str, optional
Available formats ('dicom' or 'nifti'). The default is 'nifti'.
series_description : str, optional
Expand Down
3 changes: 2 additions & 1 deletion src/deepmr/io/kspace/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,8 @@ def read_rawdata(filepath, acqheader=None, device="cpu", verbose=0):
* **2Dcart:** reconstructed image has (nslices, ncontrasts, ny, nx) -> transpose = [1, 0, 2, 3]
* **2Dnoncart:** reconstructed image has (nslices, ncontrasts, ny, nx) -> transpose = [1, 0, 2, 3]
* **3Dcart:** reconstructed image has (ncontrasts, nz, ny, nx) -> transpose = [0, 1, 2, 3]
* **3Dnoncart:** reconstructed image has (nx, ncontrasts, nz, ny) -> transpose = [1, 2, 3, 0]
* **3Dnoncart:** reconstructed image has (nx, ncontrasts, nz, ny) -> transpose = [1, 2, 3, 0]
The default is an empty list (no transposition).
References
Expand Down

0 comments on commit 53799fa

Please sign in to comment.