From 53799fa6f7a44b2edcf5609353364935c4d641cd Mon Sep 17 00:00:00 2001 From: Matteo Cencini Date: Thu, 25 Jan 2024 09:56:17 +0100 Subject: [PATCH] Update docs --- src/deepmr/io/header/api.py | 3 ++- src/deepmr/io/image/api.py | 2 +- src/deepmr/io/kspace/api.py | 3 ++- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/src/deepmr/io/header/api.py b/src/deepmr/io/header/api.py index 3504e7c2..fee96eba 100644 --- a/src/deepmr/io/header/api.py +++ b/src/deepmr/io/header/api.py @@ -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). """ diff --git a/src/deepmr/io/image/api.py b/src/deepmr/io/image/api.py index d09ea778..f605c945 100644 --- a/src/deepmr/io/image/api.py +++ b/src/deepmr/io/image/api.py @@ -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 diff --git a/src/deepmr/io/kspace/api.py b/src/deepmr/io/kspace/api.py index 5149abec..704731cf 100644 --- a/src/deepmr/io/kspace/api.py +++ b/src/deepmr/io/kspace/api.py @@ -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