Label¶
label <store> reads the collated accessions and works out where each one belongs in
the data store, from its metadata, writing the labelled accessions to OUTPUT_DIR in
directories named by their labels (see Labels and data stores). Each data store provides
its own subcommand, since each has its own label levels:
$ accessionflow label xnat /data/staging/collated /data/staging/labelled
$ accessionflow label folder /data/staging/collated /data/staging/labelled \
--level site SiteID --level subject PatientID
INPUT_DIR— thecollateoutput directory, or the output ofattachif it ran aftercollate(ACFLOW_INPUT_DIR)OUTPUT_DIR— where the labelled accessions are written (ACFLOW_OUTPUT_DIR)
Each label is taken from a metadata field, or composed from several with a format
string, e.g. --subject '{PatientID}_{StudyDate:%Y}' (see
Metadata fields and specifiers). This is the part of an accession flow most likely to need
adjusting for each site, since instruments populate different fields:
XNAT has an option for each of its levels,
--project,--subjectand--session, with defaults for DICOM, and--constant-project-idto fix the project for everything a command labelsFolder store has no fixed levels, so you name each one and the field it is labelled from with
--level <name> <field>, from the top, and can fix any of them with--constant-label <name> <value>
Labelling also describes each acquisition, from SeriesDescription for DICOM by
default. The option is named after what the store calls an acquisition: --scan for
XNAT and --acquisition for a folder store. An acquisition whose description can't be
resolved is left without one.
An accession whose labels can't all be resolved is saved under __invalid__ rather
than dropped (see When a label can't be resolved). --unlink-source removes the collated
input once an accession has been labelled (see Cleaning up previous stages), and
--loop keeps the stage running (see Running continuously and handling errors).
Routing datatypes through separate labelling pathways¶
Use repeatable --include options when different datatypes from one collated accession
need different labels, e.g. different projects. Each label command reads the same
collated input and writes only the matching resources:
$ accessionflow label xnat /data/staging/collated /data/staging/dicom-labelled \
--include medimage/dicom-series --constant-project-id DICOM_PROJECT
$ accessionflow label xnat /data/staging/collated /data/staging/report-labelled \
--include application/pdf --constant-project-id REPORT_PROJECT
Multiple --include options match any of their datatypes. Filtering by datatype can't
be combined with --unlink-source, because the collated data must remain available to
every labelling pathway.