Note
This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.
brainprep.interfaces.write_uuid_mapping¶
- brainprep.interfaces.write_uuid_mapping(input_file, output_dir, entities, name='uuid_mapping.tsv', full_path=False)[source]¶
Create a TSV file that records a deterministic UUID-based mapping.
Each row contains: - filename: relative path within the BIDS dataset. - run_default: 5-digit deterministic run ID derived from the filename. - uuid: full UUIDv5 for traceability.
- Parameters:
- input_fileFile
Path to the file to map.
- output_dirDirectory
Directory where the TSV file is created.
- entitiesdict
A dictionary of parsed BIDS entities including modality.
- namestr
Name of the TSV file to write. Default is “uuid_mapping.tsv”.
- full_path: bool
If True, extract entities from the full input path rather than only the filename. Default is False.
- Returns:
- output_fileFile
Path to the written TSV file.