Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wyli committed Mar 16, 2020
1 parent b9c4f19 commit ad30fc4
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 6 deletions.
7 changes: 7 additions & 0 deletions docs/source/highlights.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ This figure shows modules currently available in the codebase.
![image](../images/end_to_end_process.png)
The rest of this page provides more details for each module.

* [Image transformations](#image-transformations)
* [Loss functions](#losses)
* [Network architectures](#network-architectures)
* [Evaluation](#evaluation)
* [Visualization](#visualization)
* [Result writing](#result-writing)

## Image transformations
Medical image data pre-processing is challenging. Data are often in specialized formats with rich meta information; and the data volumes are often high-dimensional and requiring carefully designed manipulation procedures. As an important part of MONAI, powerful and flexible image transformations are provided to enable user-friednly, reproducible, optimized medical data pre-processing piepline.

Expand Down
5 changes: 5 additions & 0 deletions docs/source/transform_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,11 @@ Dictionary-based Composables
:members:
:special-members: __call__

`DeleteKeysd`
~~~~~~~~~~~~~
.. autoclass:: DeleteKeysd
:members:
:special-members: __call__

Transform Adaptors
------------------
Expand Down
12 changes: 6 additions & 6 deletions monai/transforms/composables.py
Original file line number Diff line number Diff line change
Expand Up @@ -653,7 +653,7 @@ def __call__(self, data):
@alias('RandFlipD', 'RandFlipDict')
class RandFlipd(Randomizable, MapTransform):
"""Dict-based wrapper of RandFlip.
See `numpy.flip` for additional details.
https://docs.scipy.org/doc/numpy/reference/generated/numpy.flip.html
Expand Down Expand Up @@ -723,18 +723,18 @@ class RandRotated(Randomizable, MapTransform):
Args:
prob (float): Probability of rotation.
degrees (tuple of float or float): Range of rotation in degrees. If single number,
angle is picked from (-degrees, degrees).
angle is picked from (-degrees, degrees).
spatial_axes (tuple of 2 ints): Spatial axes of rotation. Default: (0, 1).
This is the first two axis in spatial dimensions.
reshape (bool): If true, output shape is made same as input. Default: True.
order (int): Order of spline interpolation. Range 0-5. Default: 1. This is
different from scipy where default interpolation is 3.
mode (str): Points outside boundary filled according to this mode. Options are
mode (str): Points outside boundary filled according to this mode. Options are
'constant', 'nearest', 'reflect', 'wrap'. Default: 'constant'.
cval (scalar): Value to fill outside boundary. Default: 0.
prefiter (bool): Apply spline_filter before interpolation. Default: True.
"""
def __init__(self, keys, degrees, prob=0.1, spatial_axes=(0, 1), reshape=True, order=1,
def __init__(self, keys, degrees, prob=0.1, spatial_axes=(0, 1), reshape=True, order=1,
mode='constant', cval=0, prefilter=True):
MapTransform.__init__(self, keys)
self.prob = prob
Expand Down Expand Up @@ -822,7 +822,7 @@ class RandZoomd(Randomizable, MapTransform):
keep_size (bool): Should keep original size (pad if needed).
"""

def __init__(self, keys, prob=0.1, min_zoom=0.9,
def __init__(self, keys, prob=0.1, min_zoom=0.9,
max_zoom=1.1, order=3, mode='constant',
cval=0, prefilter=True, use_gpu=False, keep_size=False):
MapTransform.__init__(self, keys)
Expand Down Expand Up @@ -872,7 +872,7 @@ def __init__(self, keys):
"""
Args:
keys (hashable items): keys of the corresponding items to be transformed.
See also: monai.transform.composables.MapTransform
See also: :py:class:`monai.transforms.compose.MapTransform`
"""
MapTransform.__init__(self, keys)

Expand Down

0 comments on commit ad30fc4

Please sign in to comment.