Skip to content

Commit fee6cd3

Browse files
added documentation
Signed-off-by: Lukas Folle <lukas.folle@snke.com>
1 parent 5135fb4 commit fee6cd3

File tree

3 files changed

+42
-0
lines changed

3 files changed

+42
-0
lines changed

docs/source/transforms.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ Generic Interfaces
3737
.. autoclass:: MultiSampleTrait
3838
:members:
3939

40+
`ReduceTrait`
41+
^^^^^^^^^^^^^^^^^^
42+
.. autoclass:: ReduceTrait
43+
:members:
44+
4045
`Randomizable`
4146
^^^^^^^^^^^^^^
4247
.. autoclass:: Randomizable
@@ -1252,6 +1257,12 @@ Utility
12521257
:members:
12531258
:special-members: __call__
12541259

1260+
`FlattenSequence`
1261+
""""""""""""""""""""""""
1262+
.. autoclass:: FlattenSequence
1263+
:members:
1264+
:special-members: __call__
1265+
12551266
Dictionary Transforms
12561267
---------------------
12571268

@@ -2337,6 +2348,12 @@ Utility (Dict)
23372348
:members:
23382349
:special-members: __call__
23392350

2351+
`FlattenSequenced`
2352+
"""""""""""""""""""""""""
2353+
.. autoclass:: FlattenSequenced
2354+
:members:
2355+
:special-members: __call__
2356+
23402357

23412358
MetaTensor
23422359
^^^^^^^^^^

monai/transforms/utility/array.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1954,6 +1954,22 @@ def inverse(self, data: torch.Tensor) -> torch.Tensor:
19541954

19551955

19561956
class FlattenSequence(Transform, ReduceTrait):
1957+
"""
1958+
Flatten a nested sequence (list or tuple) by one level.
1959+
If the input is a sequence of sequences, it will flatten them into a single sequence.
1960+
Non-nested sequences and other data types are returned unchanged.
1961+
1962+
For example:
1963+
1964+
.. code-block:: python
1965+
1966+
flatten = FlattenSequence()
1967+
data = [[1, 2], [3, 4], [5, 6]]
1968+
print(flatten(data))
1969+
[1, 2, 3, 4, 5, 6]
1970+
1971+
"""
1972+
19571973
def __init__(self):
19581974
super().__init__()
19591975

monai/transforms/utility/dictionary.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1911,6 +1911,15 @@ def inverse(self, data: Mapping[Hashable, torch.Tensor]) -> dict[Hashable, torch
19111911

19121912

19131913
class FlattenSequenced(MapTransform, ReduceTrait):
1914+
"""
1915+
Dictionary-based wrapper of :py:class:`monai.transforms.FlattenSequence`.
1916+
1917+
Args:
1918+
keys: keys of the corresponding items to be transformed.
1919+
See also: monai.transforms.MapTransform
1920+
allow_missing_keys:
1921+
Don't raise exception if key is missing.
1922+
"""
19141923
def __init__(
19151924
self,
19161925
keys: KeysCollection,

0 commit comments

Comments
 (0)