mrsiprep.io.naming

BIDS-like naming helpers.

Functions

anat_derivative(root, subject, session, ...)

chimera_derivative(root, subject, session, ...)

coverage_figure_derivative(root, subject, ...)

coverage_report_dir(root, subject, session)

coverage_report_html(root, subject, session)

mrsi_derivative(root, subject, session, ...)

mrsi_parcel_dir(root, subject, session)

parcellation_derivative(root, subject, ...)

prefix(subject[, session])

provenance_derivative(root, subject, session)

qc_report_derivative(root, subject, session, ...)

resampling_work_path(work_dir, subject, ...)

Scratch location (under --work-dir) for resampled maps needed only to render a report, not intended as a permanent BIDS derivative.

subject_session_dir(root, subject, session, ...)

mrsiprep.io.naming.anat_derivative(root, subject, session, **entities)[source]
Parameters:
  • root (Path)

  • subject (str)

  • session (str | None)

Return type:

Path

mrsiprep.io.naming.chimera_derivative(root, subject, session, **entities)[source]
Parameters:
  • root (Path)

  • subject (str)

  • session (str | None)

Return type:

Path

mrsiprep.io.naming.coverage_figure_derivative(root, subject, session, extension='png', **entities)[source]
Parameters:
  • root (Path)

  • subject (str)

  • session (str | None)

  • extension (str)

Return type:

Path

mrsiprep.io.naming.coverage_report_dir(root, subject, session)[source]
Parameters:
  • root (Path)

  • subject (str)

  • session (str | None)

Return type:

Path

mrsiprep.io.naming.coverage_report_html(root, subject, session)[source]
Parameters:
  • root (Path)

  • subject (str)

  • session (str | None)

Return type:

Path

mrsiprep.io.naming.mrsi_derivative(root, subject, session, **entities)[source]
Parameters:
  • root (Path)

  • subject (str)

  • session (str | None)

Return type:

Path

mrsiprep.io.naming.mrsi_parcel_dir(root, subject, session)[source]
Parameters:
  • root (Path)

  • subject (str)

  • session (str | None)

Return type:

Path

mrsiprep.io.naming.parcellation_derivative(root, subject, session, **entities)[source]
Parameters:
  • root (Path)

  • subject (str)

  • session (str | None)

Return type:

Path

mrsiprep.io.naming.prefix(subject, session=None)[source]
Parameters:
  • subject (str)

  • session (str | None)

Return type:

str

mrsiprep.io.naming.provenance_derivative(root, subject, session)[source]
Parameters:
  • root (Path)

  • subject (str)

  • session (str | None)

Return type:

Path

mrsiprep.io.naming.qc_report_derivative(root, subject, session, step, extension='html')[source]
Parameters:
  • root (Path)

  • subject (str)

  • session (str | None)

  • step (str)

  • extension (str)

Return type:

Path

mrsiprep.io.naming.resampling_work_path(work_dir, subject, session, **entities)[source]

Scratch location (under --work-dir) for resampled maps needed only to render a report, not intended as a permanent BIDS derivative.

Parameters:
  • work_dir (Path)

  • subject (str)

  • session (str | None)

Return type:

Path

mrsiprep.io.naming.subject_session_dir(root, subject, session, suffix)[source]
Parameters:
  • root (Path)

  • subject (str)

  • session (str | None)

  • suffix (str)

Return type:

Path