avid.common.artefact.defaultProps

This module is the central unit to store the default artefact propertie keys To ensure an easier maintenance and upgrade all autoprocessing modules,

Module Attributes

ID

Case ID (e.g. Patient ID) should be unique for one subject/person/entity in a cohort.

CASE

ID for an instance of the case (e.g. for variation analysis).

CASEINSTANCE

ID for time points of data acquisition of a case.

TIMEPOINT

Tag lable used for a certain action step in the workflow

ACTIONTAG

Objective or Object id that can e.g. used to indicates a certain objective of an action (e.g. Registration with a special structure, segmentation/mask or statistics of a certain organ at risk).

OBJECTIVE

Type of the artefact represented by the entry

TYPE

Format of the artefact represented by the entry

FORMAT

URL to the artefact stored in a file/resource and indicated by the entry

URL

In case actions produce more then one result artefact, this property may be used to make the results distinguishable.

RESULT_SUB_TAG

In case actions produce more then one result artefact, distinguished by sub result tag, this property should be used to indicate how many sub results were produced.

RESULT_SUB_COUNT

Indicates if a given artefact is valid (True) or not (False).

INVALID

Creation time of an artefact.

TIMESTAMP

Dict with the IDs lists of input artefacts used to generate the artefact.

INPUT_IDS

Duration of the action execution that generated the artefact (in [s]).

EXECUTION_DURATION

Name of the action class that used to do/represent the action.

ACTION_CLASS

UID of the action instance that generated the artefact

ACTION_INSTANCE_UID

Defines a reference to a plan file the artefact is associated with.

VIRTUOS_PLAN_REF

Property containes the number of planned fractions associated with a artefact (typically a plan).

PLANNED_FRACTIONS

Property containes the prescribed dose associated with a artefact (typically a plan).

PRESCRIBED_DOSE

Element of an accumulation (e.g. dose accumulation).

ACC_ELEMENT

Property indicates a certain dose statistic value covered by the associated artefact

DOSE_STAT

Property indicates a certain diagram type covered by the associated artefact

DIAGRAM_TYPE

Property indicates a certain diagram type covered by the associated artefact

ONLY_ESTIMATOR

Property indicates a certain diagram type covered by the associated artefact

N_FRACTIONS_FOR_ESTIMATION

Standard type value.

TYPE_VALUE_MISC

Standard type value.

TYPE_VALUE_CONFIG

Standard type value.

TYPE_VALUE_RESULT

Standard type value.

TYPE_VALUE_INTERIM

Standard type value.

FORMAT_VALUE_UNDEFINED

Standard type value.

FORMAT_VALUE_DCM

Standard type value.

FORMAT_VALUE_ITK

Standard type value.

FORMAT_VALUE_ITK_TRANSFORM

Standard type value.

FORMAT_VALUE_CSV

Standard type value.

FORMAT_VALUE_JSON

Standard type value.

FORMAT_VALUE_XML

Standard type value.

FORMAT_VALUE_BAT

Standard type value.

FORMAT_VALUE_HELAX_DCM

Standard type value.

FORMAT_VALUE_RTTB_STATS_XML

Standard type value.

FORMAT_VALUE_RTTB_CUM_DVH_XML

Standard type value.

FORMAT_VALUE_R

Standard type value.