AnnotationGroupFactory

Constructor

new AnnotationGroupFactory()

Methods

checkElements(dataElements) → {string|undefined}

Check dicom elements.

Parameters:
NameTypeDescription
dataElementsObject.<string, DataElement>

The DICOM data elements.

Throws:

Error for missing or wrong data.

Returns:

A possible warning.

Type: 
string | undefined

create(dataElements) → {AnnotationGroup}

Get an AnnotationGroup object from the read DICOM file.

Parameters:
NameTypeDescription
dataElementsObject.<string, DataElement>

The DICOM tags.

Throws:

Error for missing or wrong data.

Returns:

A new annotation group.

Type: 
AnnotationGroup

createCADReport(dataElements) → {CADReport|undefined}

Get an CADReport object from the read DICOM file.

Parameters:
NameTypeDescription
dataElementsObject.<string, DataElement>

The DICOM tags.

Returns:

A new CAD report.

Type: 
CADReport | undefined

getWarning() → {string|undefined}

Get a warning string if elements are not as expected. Created by checkElements.

Returns:

The warning.

Type: 
string | undefined

toDicom(annotationGroup, extraTagsopt) → {Object.<string, DataElement>}

Convert an annotation group into a DICOM SR object using the TID 1500 template.

Parameters:
NameTypeAttributesDescription
annotationGroupAnnotationGroup

The annotation group.

extraTagsObject.<string, any><optional>

Optional list of extra tags.

Returns:

A list of dicom elements.

Type: 
Object.<string, DataElement>

toDicomCADReport(report, extraTagsopt) → {Object.<string, DataElement>}

Convert a CAD report into a DICOM CAD report SR object using the TID 4100 template.

Parameters:
NameTypeAttributesDescription
reportCADReport

The CAD report.

extraTagsObject.<string, any><optional>

Optional list of extra tags.

Returns:

A list of dicom elements.

Type: 
Object.<string, DataElement>