Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust wording on heuristics page -- do not claim creating some skeleton #741

Merged
merged 1 commit into from
Feb 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions docs/heuristics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,25 @@ Heuristics File
===============

The heuristic file controls how information about the DICOMs is used to convert
to a file system layout (e.g., BIDS). ``heudiconv`` includes some built-in
heuristics, including `ReproIn <https://github.com/ReproNim/reproin/blob/master/README.md>`_
(which is great to adopt if you will be starting your data collection!).

However, there is a large variety of data out there, and not all DICOMs will be
covered by the existing heuristics. This section will outline what makes up a
heuristic file, and some useful functions available when making one.
to a file system layout (e.g., BIDS).


Provided Heuristics
-------------------

Running ``heudiconv`` without a heuristic file results in the generation of a skeleton for the user to customize to their needs.
``heudiconv`` provides over 10 pre-created heuristics, which can be seen `here <https://github.com/nipy/heudiconv/tree/master/heudiconv/heuristics>`_ .

``heudiconv`` also provides more than 10 additional heuristics, which can be seen `here <https://github.com/nipy/heudiconv/tree/master/heudiconv/heuristics>`_
These heuristic files are documented in their code comments.
Some of them, like `convertall <https://github.com/nipy/heudiconv/blob/master/heudiconv/heuristics/convertall.py>`_ or `ReproIn <https://github.com/nipy/heudiconv/blob/master/heudiconv/heuristics/reproin.py>`__ could be immediately reused and represent two ends of the spectrum in heuristics:

- ``convertall`` is very simple and does not automate anything -- it is for a user to modify filenames in the prepared conversion table, and then rerun with ``-c dcm2niix``.
- ``reproin`` can be used fully automated, if original sequences were named according to its ReproIn convention.

Discover more on their user in the :ref:`Tutorials` section.

However, there is a large variety of data out there, and not all DICOMs
will be covered by the existing heuristics. This section will outline what
makes up a heuristic file, and some useful functions available when making one.

Components
==========
Expand Down
5 changes: 3 additions & 2 deletions docs/tutorials.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
.. _Tutorials:

==================
=========
Tutorials
==================
=========

.. toctree::

Expand Down
Loading