Skip to content

Commit 2dd71e8

Browse files
committed
DOC: basic doc about "-g custom"
1 parent ca402a9 commit 2dd71e8

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/heuristics.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,20 @@ DICOMs where this function returns ``True`` will be filtered out.
6868
Further processing on ``seqinfos`` to deduce/customize subject, session, and locator.
6969

7070
A dictionary of {"locator": locator, "session": session, "subject": subject} is returned.
71+
72+
---------------------------------------------------------------
73+
``grouping`` string or ``grouping(files, dcmfilter, seqinfo)``
74+
---------------------------------------------------------------
75+
76+
Whenever ``--grouping custom`` (``-g custom``) is used, this attribute or callable
77+
will be used to inform how to group the DICOMs into separate groups. From
78+
`original PR#359 <https://github.com/nipy/heudiconv/pull/359>`_::
79+
80+
grouping = 'AcquisitionDate'
81+
82+
or::
83+
84+
def grouping(files, dcmfilter, seqinfo):
85+
seqinfos = collections.OrderedDict()
86+
...
87+
return seqinfos # ordered dict containing seqinfo objects: list of DICOMs

0 commit comments

Comments
 (0)