Skip to content
Snippets Groups Projects
Commit c7e2c3cf authored by Tamino Huxohl's avatar Tamino Huxohl
Browse files

change doc format for patch dataset

parent 56b9f617
No related branches found
No related tags found
No related merge requests found
...@@ -11,15 +11,24 @@ class MuMapPatchDataset(MuMapDataset): ...@@ -11,15 +11,24 @@ class MuMapPatchDataset(MuMapDataset):
""" """
A wrapper around the MuMapDataset that computes patches for each reconstruction-μ-map pair. A wrapper around the MuMapDataset that computes patches for each reconstruction-μ-map pair.
:param dataset_dir: the directory containing the dataset - is passed to MuMapDataset Parameters
:param patches_per_image: the amount of patches to randomly generate for each image ----------
:param patch_size: the size of patches in x- and y-direction dataset_dir: str
:param patch_size_z: the size of patches in z-direction --- it is a separate parameter because the directory containing the dataset - is passed to MuMapDataset
images are typically shorter in this direction patches_per_image: int
:param patch_offset: offset of generated patches to the border of images --- this space will the amount of patches to randomly generate for each image
then not appear in patches because it is often empty patch_size: int
:param shuffle: shuffle the patches so that patches of image pairs are mixed the size of patches in x- and y-direction
:param **kwargs: remaining parameters passed to MuMapDataset patch_size_z: int
the size of patches in z-direction --- it is a separate parameter because
images are typically shorter in this direction
patch_offset: int
offset of generated patches to the border of images --- this space will
then not appear in patches because it is often empty
shuffle: bool
shuffle the patches so that patches of image pairs are mixed
**kwargs:
remaining parameters passed to MuMapDataset
""" """
def __init__( def __init__(
...@@ -138,7 +147,7 @@ if __name__ == "__main__": ...@@ -138,7 +147,7 @@ if __name__ == "__main__":
parser.add_argument( parser.add_argument(
"--dataset_dir", "--dataset_dir",
type=str, type=str,
default="data/initial/", default="data/second/",
help="the directory of the dataset", help="the directory of the dataset",
) )
for key, _default, _help in zip(param_keys, param_defaults, param_help): for key, _default, _help in zip(param_keys, param_defaults, param_help):
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment