Skip to content

Commit 8a91848

Browse files
committed
Entities becomes ProvEntities
1 parent 0e6c92b commit 8a91848

File tree

2 files changed

+20
-13
lines changed

2 files changed

+20
-13
lines changed

provenance_dcm2niix/README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,28 @@
1-
# BEP028 example dataset - Provenance records for `dcm2niix`
1+
# Provenance of DICOM to Nifti conversion with `dcm2niix`
22

3-
This example aims at showing provenance records for a DICOM to Nifti conversion, performed by [`dcm2niix`](https://github.com/rordenlab/dcm2niix
4-
). Provenance records were created manually ; they act as a guideline for further machine-generated records by `dcm2niix`.
3+
## Goal
54

6-
After conversion, and adding provenance traces, the directory tree is as follows:
5+
This example aims at showing provenance metadata for a DICOM to Nifti conversion with [`dcm2niix`](https://github.com/rordenlab/dcm2niix
6+
). Provenance metadata was created manually ; its acts as a guideline for further machine-generated provenance by `dcm2niix`.
7+
8+
## Source data
9+
10+
That the `sourcedata/` directory contains the source dataset (DICOM files) known as [hirni-demo](https://github.com/psychoinformatics-de/hirni-demo).
11+
12+
## Directory tree
13+
14+
After conversion, and adding provenance traces, the directory tree is as follows. Files marked with a ✍️ were generated manually.
15+
`sub-02/anat/sub-02_T1w.json` was generated by `dcm2niix`, then the `GeneratedBy` and `SidecarGeneratedBy` provenance-related fields were added manually.
716

817
```
9-
prov/
10-
├── prov-dcm2niix_act.json
11-
├── prov-dcm2niix_ent.json
12-
├── prov-dcm2niix_env.json
13-
└── prov-dcm2niix_soft.json
18+
✍️ prov/
19+
├── ✍️ prov-dcm2niix_act.json
20+
├── ✍️ prov-dcm2niix_ent.json
21+
├── ✍️ prov-dcm2niix_env.json
22+
└── ✍️ prov-dcm2niix_soft.json
1423
sourcedata/
1524
sub-02/
1625
└── anat
17-
├── sub-02_T1w.json
26+
├── ✍️ sub-02_T1w.json
1827
└── sub-02_T1w.nii
1928
```
20-
21-
Note that the `sourcedata/` directory contains the source dataset (DICOM files) known as [hirni-demo](https://github.com/psychoinformatics-de/hirni-demo).

provenance_dcm2niix/prov/prov-dcm2niix_ent.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"Entities": [
2+
"ProvEntities": [
33
{
44
"Id": "bids::sourcedata/hirni-demo/acq1/dicoms/example-dicom-structural-master/dicoms",
55
"Type": "Entity",

0 commit comments

Comments
 (0)