Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
XRD
darfix
Commits
29f95aa4
Commit
29f95aa4
authored
Sep 14, 2021
by
Julia Garriga Ferrer
Browse files
[core][dataset] Update docstring for Dataset
parent
0f78616d
Changes
1
Hide whitespace changes
Inline
Side-by-side
darfix/core/dataset.py
View file @
29f95aa4
...
...
@@ -92,11 +92,16 @@ class Dataset():
:type raw_folder: Union[None,str], optional
:param filenames: Ordered list of filenames, defaults to None.
:type filenames: Union[Generator,Iterator,List], optional
:param treated: Name of the folder with the treated data, defaults 'treated_data'
:type treated: str, optional
:param dims: Dimensions dictionary
:type dims: AcquisitionDims, optional
:param transformation: Axes to use when displaying the images
:type transformation: ndarray, optional
:param in_memory: If True, data is loaded into memory, else, data is read in
chunks depending on the algorithm to apply, defaults to False.
:type in_memory: bool, optional
:param copy_files: If True, creates a new treated data folder and doesn't replace
the directory files.
:type copy_files: bool, optional
"""
def
__init__
(
self
,
_dir
,
data
=
None
,
first_filename
=
None
,
filenames
=
None
,
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment