Document file names and conventions used for saving results

Also see issue 108.

During usage of SliceTracker the following data is saved:

Saved Data

• Approved ZFrame transformation
• Preop targets
• Bias corrected volume (if bias correction has been executed)
• Cover Prostate label (segmentation of the prostate)
• Cover Prostate model (surface model which is the result of the VolumeClip module)
• Registration Results:
  • approved targets
  • rigid, bSpline targets (affine if exist)
  • rigid, bSpline transformations (affine if exist)
  • rigid, bSpline volumes (affine if exist)
  • registration CMD parameters

Filename conventions

All characters ": ", " ", ":", "/" are replaced with "-" to prevent having unwanted characters in filenames.

The following formatting is used:

• Bias corrected volume: volume-PREOP-N4.nrrd
• Cover Prostate label: {seriesNumber}-{seriesName}-LABEL.nrrd
• Cover Prostate model: {seriesNumber}-{seriesName}-MODEL.nrrd
• Preop Targets: PreopTargets.fcsv
• ZFrame Transform: ZFrameTransform.h5
• Approved targets: {seriesNumber}-APPROVED-TARGETS-{registrationType}.fcsv
• Targets: {seriesNumber}-TARGETS-{registrationType}(Retry{number of retry}).fcsv
• Transforms: {seriesNumber}-TRANSFORM-{registrationType}(Retry{number of retry}).h5
• Volumes: {seriesNumber}-VOLUME-{registrationType}(Retry{number of retry}).h5
• CMD parameters: {resultName}-CMD-PARAMETERS.txt

resultName: {seriesNumber}-{seriesName}(_Retry_{number of retry})
seriesNumber: extracted from DICOM tag '0020,0011'
seriesName: extracted series description from DICOM tag '0008,103E' 

JSON results file (continue/load case)

Note: Work in progress

{
  "results": {
    "3: AXIAL T2 COVER PROSTATE 3mm 0gap at iso": {
      "status": "approved", 
      "movingVolume": null, 
      "suffix": "", 
      "approvedRegistrationType": "bSpline", 
      "fixedLabel": "3-AXIAL-T2-COVER-PROSTATE-3mm-0gap-at-iso-label.nrrd", 
      "transforms": {
        "bSpline": null, 
        "affine": null, 
        "rigid": null
      }, 
      "targets": {
        "bSpline": "3-TARGETS-bSpline.fcsv", 
        "affine": null, 
        "rigid": null
      }, 
      "fixedVolume": "3-AXIAL-T2-COVER-PROSTATE-3mm-0gap-at-iso.nrrd", 
      "volumes": {
        "bSpline": null, 
        "affine": null, 
        "rigid": null
      }, 
      "score": 5, 
      "originalTargets": "IntraopTargets.fcsv", 
      "movingLabel": null
    }
  "usedPreopData": false, 
  "VOLUME-PREOP-N4": null,
  "zFrameTransform": "2-ZFrameTransform.h5",
  "completed" : false
}