Skip to content
Snippets Groups Projects

Docstrings

Merged s214735 requested to merge docstrings into main
1 file
+ 7
2
Compare changes
  • Side-by-side
  • Inline
  • 8e8dd2ef
    fix · 8e8dd2ef
    s214735 authored
+ 7
2
@@ -797,8 +797,13 @@ def load(
@@ -797,8 +797,13 @@ def load(
force_load (bool, optional): If the file size exceeds available memory, a MemoryError is raised.
force_load (bool, optional): If the file size exceeds available memory, a MemoryError is raised.
If force_load is True, the error is changed to warning and the loader tries to load it anyway. Default is False.
If force_load is True, the error is changed to warning and the loader tries to load it anyway. Default is False.
dim_order (tuple, optional): The order of the dimensions in the volume for .vol files. Default is (2,1,0) which corresponds to (z,y,x)
dim_order (tuple, optional): The order of the dimensions in the volume for .vol files. Default is (2,1,0) which corresponds to (z,y,x)
**kwargs: Additional keyword arguments to be passed
**kwargs: Additional keyword arguments supported by `DataLoader`:
to the DataLoader constructor.
- `virtual_stack` (bool)
 
- `dataset_name` (str)
 
- `return_metadata` (bool)
 
- `contains` (str)
 
- `force_load` (bool)
 
- `dim_order` (tuple)
Returns:
Returns:
vol (numpy.ndarray, numpy.memmap, h5py._hl.dataset.Dataset, nibabel.arrayproxy.ArrayProxy or tuple): The loaded volume
vol (numpy.ndarray, numpy.memmap, h5py._hl.dataset.Dataset, nibabel.arrayproxy.ArrayProxy or tuple): The loaded volume
Loading