DCMTK
Version 3.6.7
OFFIS DICOM Toolkit
|
General purpose class hiding global functions, constants and types from the global namespace. More...
Static Public Attributes | |
read() flags | |
These flags can be combined and passed to the read() methods. The 'shortcut' flags can be used for common combinations. | |
static const size_t | RF_readDigitalSignatures |
read digital signatures from dataset | |
static const size_t | RF_acceptUnknownRelationshipType |
accept unknown/missing relationship type | |
static const size_t | RF_acceptInvalidContentItemValue |
accept invalid content item value (e.g. violation of VR or VM definition) | |
static const size_t | RF_ignoreRelationshipConstraints |
ignore relationship constraints for this document class | |
static const size_t | RF_ignoreContentItemErrors |
do not abort on content item errors (e.g. missing value type specific attributes) | |
static const size_t | RF_skipInvalidContentItems |
do not abort when detecting an invalid content item, skip invalid sub-tree instead | |
static const size_t | RF_showCurrentlyProcessedItem |
show the currently processed content item (e.g. "1.2.3") | |
renderHTML() flags | |
These flags can be combined and passed to the renderHMTL() methods. Please note that only the 'external' flags can be used from outside this library. The 'shortcut' flags can be used for common combinations. | |
static const size_t | HF_neverExpandChildrenInline |
external: never expand child nodes inline | |
static const size_t | HF_alwaysExpandChildrenInline |
external: always expand child nodes inline | |
static const size_t | HF_renderInlineCodes |
external: render codes even if they appear inline | |
static const size_t | HF_useCodeDetailsTooltip |
external: render code details as a tooltip (not with HTML 3.2) | |
static const size_t | HF_renderConceptNameCodes |
external: render concept name codes (default: code meaning only) | |
static const size_t | HF_renderNumericUnitCodes |
external: render the code of the numeric measurement unit | |
static const size_t | HF_useCodeMeaningAsUnit |
external: use code meaning for the numeric measurement unit (default: code value) | |
static const size_t | HF_renderPatientTitle |
external: use patient information as document title (default: document type) | |
static const size_t | HF_renderNoDocumentHeader |
external: render no general document information (header) | |
static const size_t | HF_renderDcmtkFootnote |
external: render dcmtk/dcmsr comment at the end of the document | |
static const size_t | HF_renderFullData |
external: render the full data of all content items | |
static const size_t | HF_renderSectionTitlesInline |
external: render section titles inline (default: separate paragraph) | |
static const size_t | HF_copyStyleSheetContent |
external: copy Cascading Style Sheet (CSS) content to HTML file | |
static const size_t | HF_HTML32Compatibility |
external: output compatible to HTML version 3.2 (default: 4.01) | |
static const size_t | HF_XHTML11Compatibility |
external: output compatible to XHTML version 1.1 (default: HTML 4.01) | |
static const size_t | HF_addDocumentTypeReference |
external: add explicit reference to HTML document type (DTD) | |
static const size_t | HF_omitGeneratorMetaElement |
external: omit generator meta element referring to the DCMTK | |
static const size_t | HF_renderItemsSeparately |
internal: render items separately (for container with SEPARATE flag) | |
static const size_t | HF_renderItemInline |
internal: expand items inline when they are short and have no child nodes | |
static const size_t | HF_currentlyInsideAnnex |
internal: content item is rendered fully inside the annex | |
static const size_t | HF_createFootnoteReferences |
internal: create footnote references | |
static const size_t | HF_convertNonASCIICharacters |
internal: convert non-ASCII characters (> #127) to &#nnn; | |
static const size_t | HF_renderAllCodes |
shortcut: render all codes | |
static const size_t | HF_internalUseOnly |
shortcut: filter all flags that are only used internally | |
read/writeXML() flags | |
These flags can be combined and passed to the read/writeXML() methods. The 'shortcut' flags can be used for common combinations. | |
static const size_t | XF_writeEmptyTags |
write: write all tags even if their value is empty | |
static const size_t | XF_writeTemplateIdentification |
write: write template identification information (TID and mapping resource) | |
static const size_t | XF_alwaysWriteItemIdentifier |
write: always write item identifier "id", not only when item is referenced | |
static const size_t | XF_codeComponentsAsAttribute |
write: encode code value, coding scheme designator and coding scheme version as attribute instead of element text | |
static const size_t | XF_relationshipTypeAsAttribute |
write: encode relationship type as attribute instead of element text | |
static const size_t | XF_valueTypeAsAttribute |
write: encode value type as attribute instead of element text | |
static const size_t | XF_templateIdentifierAsAttribute |
write: encode template identifier as attribute instead of element text | |
static const size_t | XF_useDcmsrNamespace |
write: add DCMSR namespace declaration to the XML output | |
static const size_t | XF_addSchemaReference |
write: add Schema reference to XML document | |
static const size_t | XF_validateSchema |
read: validate content of XML document against Schema | |
static const size_t | XF_templateElementEnclosesItems |
read/write: template identification element encloses content items | |
static const size_t | XF_addCommentsForIncludedTemplate |
write: add comments with details at beginning/end of included template (might be useful for debugging purposes) | |
static const size_t | XF_acceptEmptyStudySeriesInstanceUID |
read: accept empty Study/Series/SOP Instance UID attribute values (must be filled later) | |
static const size_t | XF_encodeEverythingAsAttribute |
shortcut: combines all XF_xxxAsAttribute write flags (see above) | |
print() flags | |
These flags can be combined and passed to the print() methods. The 'shortcut' flags can be used for common combinations. | |
static const size_t | PF_printItemPosition |
print item position ("1.2.3") instead of line indentation | |
static const size_t | PF_shortenLongItemValues |
shorten long item value (e.g. long texts) | |
static const size_t | PF_printSOPInstanceUID |
print SOP instance UID of referenced objects | |
static const size_t | PF_printConceptNameCodes |
print coding scheme designator/version and code value of concept names | |
static const size_t | PF_printNoDocumentHeader |
print no general document information (header) | |
static const size_t | PF_printTemplateIdentification |
print template identification (TID and mapping resource) | |
static const size_t | PF_useANSIEscapeCodes |
use ANSI escape codes for output | |
static const size_t | PF_printLongSOPClassName |
print long SOP class name of referenced objects (default: short name for images) | |
static const size_t | PF_printSOPClassUID |
print SOP class UID of referenced objects (instead of the name) | |
static const size_t | PF_printInvalidCodes |
print code triple for invalid codes (instead of the text "invalid code") | |
static const size_t | PF_printNodeID |
print node ID at the beginning of each line (might be useful for debugging purposes) | |
static const size_t | PF_indicateEnhancedEncodingMode |
indicate with a "*" that the "enhanced encoding mode" is used for codes | |
static const size_t | PF_printAnnotation |
print annotation of a content item (optional, e.g. user-defined information) | |
static const size_t | PF_hideIncludedTemplateNodes |
do not print internal "included template" nodes (position counter is still increased) | |
static const size_t | PF_dontCountIncludedTemplateNodes |
do not count internal "included template" nodes (only with PF_hideIncludedTemplateNodes) | |
static const size_t | PF_printEmptyCodes |
print text "empty code" for empty codes (instead of "invalid code") | |
static const size_t | PF_printAllCodes |
shortcut: print all codes (combines all PF_printXxxCodes flags, see above) | |
checkByReferenceRelationships() modes | |
These modes can be combined and passed to the checkByReferenceRelationships() method. | |
static const size_t | CM_updatePositionString |
update the position string using the node ID | |
static const size_t | CM_updateNodeID |
update the node ID using the position string | |
static const size_t | CM_resetReferenceTargetFlag |
reset the reference target flag for all nodes | |
checkByReferenceRelationships() bit masks | |
These bit masks are used to "filter" valid flags passed to checkByReferenceRelationships(). | |
enum | E_DocumentType { DT_invalid , DT_unknown = DT_invalid , DT_BasicTextSR , DT_EnhancedSR , DT_ComprehensiveSR , DT_KeyObjectSelectionDocument , DT_MammographyCadSR , DT_ChestCadSR , DT_ColonCadSR , DT_ProcedureLog , DT_XRayRadiationDoseSR , DT_EnhancedXRayRadiationDoseSR , DT_SpectaclePrescriptionReport , DT_MacularGridThicknessAndVolumeReport , DT_ImplantationPlanSRDocument , DT_Comprehensive3DSR , DT_RadiopharmaceuticalRadiationDoseSR , DT_ExtensibleSR , DT_AcquisitionContextSR , DT_SimplifiedAdultEchoSR , DT_PatientRadiationDoseSR , DT_PerformedImagingAgentAdministrationSR , DT_PlannedImagingAgentAdministrationSR , DT_RenditionSelectionDocument , DT_last = DT_RenditionSelectionDocument } |
SR document types (DICOM IOD) More... | |
enum | E_RelationshipType { RT_invalid , RT_unknown , RT_isRoot , RT_contains , RT_hasObsContext , RT_hasAcqContext , RT_hasConceptMod , RT_hasProperties , RT_inferredFrom , RT_selectedFrom , RT_last = RT_selectedFrom } |
SR relationship types. More... | |
enum | E_ValueType { VT_invalid , VT_Text , VT_Code , VT_Num , VT_DateTime , VT_Date , VT_Time , VT_UIDRef , VT_PName , VT_SCoord , VT_SCoord3D , VT_TCoord , VT_Composite , VT_Image , VT_Waveform , VT_Container , VT_byReference , VT_includedTemplate , VT_last = VT_includedTemplate } |
SR value types. More... | |
enum | E_PresentationStateType { PT_invalid , PT_unknown = PT_invalid , PT_Grayscale , PT_Color , PT_PseudoColor , PT_Blending , PT_XAXRFGrayscale , PT_GrayscalePlanarMPR , PT_CompositingPlanarMPR , PT_AdvancedBlending , PT_VolumeRendering , PT_SegmentedVolumeRendering , PT_MultipleVolumeRendering , PT_last = PT_MultipleVolumeRendering } |
Softcopy presentation state types. More... | |
enum | E_GraphicType { GT_invalid , GT_unknown = GT_invalid , GT_Point , GT_Multipoint , GT_Polyline , GT_Circle , GT_Ellipse , GT_last = GT_Ellipse } |
SR graphic types. More... | |
enum | E_GraphicType3D { GT3_invalid , GT3_unknown = GT3_invalid , GT3_Point , GT3_Multipoint , GT3_Polyline , GT3_Polygon , GT3_Ellipse , GT3_Ellipsoid , GT3_last = GT3_Ellipsoid } |
SR graphic types (3D). More... | |
enum | E_TemporalRangeType { TRT_invalid , TRT_unknown = TRT_invalid , TRT_Point , TRT_Multipoint , TRT_Segment , TRT_Multisegment , TRT_Begin , TRT_End , TRT_last = TRT_End } |
SR temporal range types. More... | |
enum | E_ContinuityOfContent { COC_invalid , COC_Separate , COC_Continuous , COC_last = COC_Continuous } |
SR continuity of content flag. More... | |
enum | E_PreliminaryFlag { PF_invalid , PF_Preliminary , PF_Final , PF_last = PF_Final } |
SR document preliminary flag. More... | |
enum | E_CompletionFlag { CF_invalid , CF_Partial , CF_Complete , CF_last = CF_Complete } |
SR document completion flag. More... | |
enum | E_VerificationFlag { VF_invalid , VF_Unverified , VF_Verified , VF_last = VF_Verified } |
SR document verification flag. More... | |
enum | E_CharacterSet { CS_invalid , CS_unknown = CS_invalid , CS_ASCII , CS_default = CS_ASCII , CS_Latin1 , CS_Latin2 , CS_Latin3 , CS_Latin4 , CS_Cyrillic , CS_Arabic , CS_Greek , CS_Hebrew , CS_Latin5 , CS_Thai , CS_Japanese , CS_Korean , CS_ChineseISO , CS_ChineseGB18030 , CS_ChineseGBK , CS_UTF8 , CS_last = CS_UTF8 } |
Specific character set. More... | |
enum | E_CodeValueType { CVT_auto , CVT_Short , CVT_Long , CVT_URN } |
Code value type. More... | |
enum | E_AddMode { AM_afterCurrent , AM_beforeCurrent , AM_belowCurrent , AM_belowCurrentBeforeFirstChild } |
Add node mode. More... | |
static const size_t | CB_maskPrintFlags |
bit mask (filter) for valid print flags (see PF_xxx) | |
static const size_t | CB_maskReadFlags |
bit mask (filter) for valid read flags (see RF_xxx) | |
virtual | ~DSRTypes () |
destructor. More... | |
static const char * | documentTypeToSOPClassUID (const E_DocumentType documentType) |
convert SR document type to SOP class UID More... | |
static const char * | documentTypeToModality (const E_DocumentType documentType) |
convert SR document type to modality More... | |
static const char * | documentTypeToReadableName (const E_DocumentType documentType) |
convert SR document type to readable name. More... | |
static const char * | documentTypeToDocumentTitle (const E_DocumentType documentType, OFString &documentTitle) |
convert SR document type to document title. More... | |
static OFBool | requiresEnhancedEquipmentModule (const E_DocumentType documentType) |
check whether a given SR document type requires the Enhanced General Equipment Module More... | |
static OFBool | requiresTimezoneModule (const E_DocumentType documentType) |
check whether a given SR document type requires the Timezone Module More... | |
static OFBool | requiresSynchronizationModule (const E_DocumentType documentType) |
check whether a given SR document type requires the Synchronization Module More... | |
static OFBool | usesSRDocumentSeriesModule (const E_DocumentType documentType) |
check whether a given SR document type uses the SR Document Series Module (instead of the Key Object Document Series Module) More... | |
static OFBool | usesKeyObjectDocumentSeriesModule (const E_DocumentType documentType) |
check whether a given SR document type uses the Key Object Document Series Module (instead of the SR Document Series Module) More... | |
static OFBool | usesSRDocumentGeneralModule (const E_DocumentType documentType) |
check whether a given SR document type uses the SR Document General Module (instead of the Key Object Document Module) More... | |
static OFBool | usesKeyObjectDocumentModule (const E_DocumentType documentType) |
check whether a given SR document type uses the Key Object Document Module (instead of the SR Document General Module) More... | |
static const char * | relationshipTypeToDefinedTerm (const E_RelationshipType relationshipType) |
convert relationship type to DICOM defined term More... | |
static const char * | relationshipTypeToReadableName (const E_RelationshipType relationshipType) |
convert relationship type to readable name. More... | |
static const char * | valueTypeToDefinedTerm (const E_ValueType valueType) |
convert value type to DICOM defined term More... | |
static const char * | valueTypeToXMLTagName (const E_ValueType valueType) |
convert value type to XML tag name More... | |
static const char * | valueTypeToReadableName (const E_ValueType valueType) |
convert value type to readable name. More... | |
static const char * | presentationStateTypeToShortName (const E_PresentationStateType pstateType) |
convert presentation state type to short name. More... | |
static const char * | graphicTypeToEnumeratedValue (const E_GraphicType graphicType) |
convert graphic type to DICOM enumerated value More... | |
static const char * | graphicTypeToReadableName (const E_GraphicType graphicType) |
convert graphic type to readable name. More... | |
static const char * | graphicType3DToEnumeratedValue (const E_GraphicType3D graphicType) |
convert graphic type (3D) to DICOM enumerated value More... | |
static const char * | graphicType3DToReadableName (const E_GraphicType3D graphicType) |
convert graphic type (3D) to readable name. More... | |
static const char * | temporalRangeTypeToEnumeratedValue (const E_TemporalRangeType temporalRangeType) |
convert temporal range type to DICOM enumerated value More... | |
static const char * | temporalRangeTypeToReadableName (const E_TemporalRangeType temporalRangeType) |
convert temporal range type to readable name. More... | |
static const char * | continuityOfContentToEnumeratedValue (const E_ContinuityOfContent continuityOfContent) |
convert continuity of content flag to DICOM enumerated value More... | |
static const char * | preliminaryFlagToEnumeratedValue (const E_PreliminaryFlag preliminaryFlag) |
convert preliminary flag to DICOM enumerated value More... | |
static const char * | completionFlagToEnumeratedValue (const E_CompletionFlag completionFlag) |
convert completion flag to DICOM enumerated value More... | |
static const char * | verificationFlagToEnumeratedValue (const E_VerificationFlag verificationFlag) |
convert verification flag to DICOM enumerated value More... | |
static const char * | characterSetToDefinedTerm (const E_CharacterSet characterSet) |
convert character set to DICOM defined term More... | |
static const char * | characterSetToHTMLName (const E_CharacterSet characterSet) |
convert character set to HTML name. More... | |
static const char * | characterSetToXMLName (const E_CharacterSet characterSet) |
convert character set to XML name. More... | |
static E_DocumentType | sopClassUIDToDocumentType (const OFString &sopClassUID) |
convert SOP class UID to SR document type More... | |
static E_RelationshipType | definedTermToRelationshipType (const OFString &definedTerm) |
convert DICOM defined term to relationship type More... | |
static E_ValueType | definedTermToValueType (const OFString &definedTerm) |
convert DICOM defined term to value type More... | |
static E_PresentationStateType | sopClassUIDToPresentationStateType (const OFString &sopClassUID) |
convert SOP class UID to presentation state type More... | |
static E_ValueType | xmlTagNameToValueType (const OFString &xmlTagName) |
convert XML tag name to value type More... | |
static E_GraphicType | enumeratedValueToGraphicType (const OFString &enumeratedValue) |
convert DICOM enumerated value to graphic type More... | |
static E_GraphicType3D | enumeratedValueToGraphicType3D (const OFString &enumeratedValue) |
convert DICOM enumerated value to graphic type (3D) More... | |
static E_TemporalRangeType | enumeratedValueToTemporalRangeType (const OFString &enumeratedValue) |
convert DICOM enumerated value to temporal range type More... | |
static E_ContinuityOfContent | enumeratedValueToContinuityOfContent (const OFString &enumeratedValue) |
convert DICOM enumerated value to continuity of content flag More... | |
static E_PreliminaryFlag | enumeratedValueToPreliminaryFlag (const OFString &enumeratedValue) |
convert DICOM enumerated value to preliminary flag More... | |
static E_CompletionFlag | enumeratedValueToCompletionFlag (const OFString &enumeratedValue) |
convert DICOM enumerated value to completion flag More... | |
static E_VerificationFlag | enumeratedValueToVerificationFlag (const OFString &enumeratedValue) |
convert DICOM enumerated value to verification flag More... | |
static E_CharacterSet | definedTermToCharacterSet (const OFString &definedTerm) |
convert DICOM defined term to character set. More... | |
static OFBool | isDocumentTypeSupported (const E_DocumentType documentType) |
check whether specified SR document type is supported by this library More... | |
static const OFString & | currentDate (OFString &dateString) |
get current date in DICOM 'DA' format. More... | |
static const OFString & | currentTime (OFString &timeString) |
get current time in DICOM 'TM' format. More... | |
static const OFString & | currentDateTime (OFString &dateTimeString) |
get current date and time in DICOM 'DT' format. More... | |
static const OFString & | localTimezone (OFString &timezoneString) |
get local timezone in DICOM format. More... | |
static const OFString & | dicomToReadableDate (const OFString &dicomDate, OFString &readableDate) |
convert DICOM date string to readable format. More... | |
static const OFString & | dicomToReadableTime (const OFString &dicomTime, OFString &readableTime) |
convert DICOM time string to readable format. More... | |
static const OFString & | dicomToReadableDateTime (const OFString &dicomDateTime, OFString &readableDateTime) |
convert DICOM date time string to readable format. More... | |
static const OFString & | dicomToReadablePersonName (const OFString &dicomPersonName, OFString &readablePersonName) |
convert DICOM person name to readable format. More... | |
static const OFString & | dicomToXMLPersonName (const OFString &dicomPersonName, OFString &xmlPersonName, const OFBool writeEmptyValue=OFFalse) |
convert DICOM person name to XML format. More... | |
static const char * | numberToString (const size_t number, char *stringValue) |
convert unsigned integer number to character string More... | |
static size_t | stringToNumber (const char *stringValue) |
convert string to unsigned integer number More... | |
static const OFString & | convertToPrintString (const OFString &sourceString, OFString &printString) |
convert character string to print string. More... | |
static const OFString & | convertToHTMLString (const OFString &sourceString, OFString &markupString, const size_t flags=0, const OFBool newlineAllowed=OFFalse) |
convert character string to HTML mnenonic string. More... | |
static const OFString & | convertToXMLString (const OFString &sourceString, OFString &markupString) |
convert character string to XML mnenonic string. More... | |
static OFBool | checkForValidReference (const OFString &stringValue) |
check string for valid reference (as used for by-reference relationships). More... | |
static DSRIODConstraintChecker * | createIODConstraintChecker (const E_DocumentType documentType) |
create specified SR IOD content relationship constraint checker object. More... | |
static DSRDocumentTreeNode * | createDocumentTreeNode (const E_RelationshipType relationshipType, const E_ValueType valueType) |
create specified document tree node. More... | |
static OFCondition | addElementToDataset (OFCondition &result, DcmItem &dataset, DcmElement *delem, const OFString &vm, const OFString &type, const char *moduleName=NULL) |
add given element to the dataset. More... | |
static void | removeAttributeFromSequence (DcmSequenceOfItems &sequence, const DcmTagKey &tagKey) |
remove given attribute from the sequence. More... | |
static OFCondition | getElementFromDataset (DcmItem &dataset, DcmElement &delem) |
get element from dataset More... | |
static const char * | getStringValueFromElement (const DcmElement &delem) |
get string value from element More... | |
static const OFString & | getStringValueFromElement (const DcmElement &delem, OFString &stringValue) |
get string value from element. More... | |
static OFCondition | getStringValueFromElement (const DcmElement &delem, OFString &stringValue, const signed long pos) |
get string value from element More... | |
static const OFString & | getPrintStringFromElement (const DcmElement &delem, OFString &stringValue) |
get string value from element and convert to "print" format. More... | |
static const OFString & | getMarkupStringFromElement (const DcmElement &delem, OFString &stringValue, const OFBool convertNonASCII=OFFalse) |
get string value from element and convert to HTML/XML. More... | |
static OFCondition | getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue, const signed long pos=0) |
get string value from dataset More... | |
static OFCondition | putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue) |
put string value to dataset More... | |
static OFBool | checkElementValue (DcmElement *delem, const DcmTagKey &tagKey, const OFString &vm, const OFString &type, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL, const OFBool acceptViolation=OFFalse) |
check element value for correct value multiplicity and type. More... | |
static OFBool | checkElementValue (DcmElement &delem, const OFString &vm, const OFString &type, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL, const OFBool acceptViolation=OFFalse) |
check element value for correct value multiplicity and type. More... | |
static OFCondition | getAndCheckElementFromDataset (DcmItem &dataset, DcmElement &delem, const OFString &vm, const OFString &type, const char *moduleName=NULL, const OFBool acceptViolation=OFFalse) |
get element from dataset and check it for correct value multiplicity and type. More... | |
static OFCondition | getAndCheckStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue, const OFString &vm, const OFString &type, const char *moduleName=NULL, const OFBool acceptViolation=OFFalse) |
get string value from dataset and check it for correct value multiplicity and type. More... | |
static void | printInvalidContentItemMessage (const char *action, const DSRDocumentTreeNode *node, const char *location=NULL) |
print the warning message that the current content item is invalid/incomplete. More... | |
static void | printContentItemErrorMessage (const char *action, const OFCondition &result, const DSRDocumentTreeNode *node, const char *location=NULL) |
print an error message for the current content item. More... | |
static void | printUnknownValueWarningMessage (const char *valueName, const char *readValue=NULL, const char *action="Reading") |
print a warning message that an unknown/unsupported value has been determined More... | |
static OFBool | writeStringValueToXML (STD_NAMESPACE ostream &stream, const OFString &stringValue, const OFString &tagName, const OFBool writeEmptyValue=OFFalse) |
write string value to XML output stream. More... | |
static OFBool | writeStringFromElementToXML (STD_NAMESPACE ostream &stream, DcmElement &delem, const OFString &tagName, const OFBool writeEmptyValue=OFFalse) |
write string value from DICOM element to XML output stream. More... | |
static size_t | createHTMLAnnexEntry (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, const OFString &referenceText, size_t &annexNumber, const size_t flags=0) |
create an HTML annex entry with hyperlinks. More... | |
static size_t | createHTMLFootnote (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &footnoteStream, size_t &footnoteNumber, const size_t nodeID, const size_t flags=0) |
create an HTML footnote with hyperlinks More... | |
static OFCondition | appendStream (STD_NAMESPACE ostream &mainStream, OFOStringStream &tempStream, const char *heading=NULL) |
append one output stream to another. More... | |
General purpose class hiding global functions, constants and types from the global namespace.
Some of them might be moved to 'ofstd' later on. All functions and constants are static and can, therefore, be accessed without creating an instance of this class.
enum DSRTypes::E_AddMode |
Specific character set.
Code value type.
Enumerator | |
---|---|
CVT_auto | determine code value type automatically |
CVT_Short | short code value (VR=SH) |
CVT_Long | long code value (VR=UC) |
CVT_URN | URN code value (VR=UR) |
SR document types (DICOM IOD)
SR graphic types.
Used for content item SCOORD.
SR graphic types (3D).
Used for content item SCOORD3D.
Softcopy presentation state types.
Used for content item IMAGE.
SR relationship types.
SR temporal range types.
Used for content item TCOORD.
SR value types.
|
virtual |
destructor.
(only needed to avoid compiler warnings)
|
static |
add given element to the dataset.
The element is only added if 'result' is EC_Normal and the 'delem' pointer is not NULL.
result | reference to status variable (checked before adding and updated afterwards!) |
dataset | reference to DICOM dataset to which the element should be added |
delem | pointer to DICOM element which should be added. deleted if not inserted. |
vm | value multiplicity (according to the data dictionary) to be checked for. (See DcmElement::checkVM() for a list of valid values.) Interpreted as cardinality (number of items) for sequence attributes. |
type | value type (valid value: "1", "2" or something else which is not checked) |
moduleName | optional module name to be printed (default: "SR document" if NULL) |
|
static |
append one output stream to another.
mainStream | stream to which the other should be added |
tempStream | (string) stream to be added to the other |
heading | (optional) string which is added to the 'mainStream' before the 'tempStream'. This string is only added if 'tempStream' is not empty. |
|
static |
convert character set to DICOM defined term
characterSet | character set to be converted |
|
static |
convert character set to HTML name.
This HTML (IANA) name is used to specify the character set in an HTML document.
characterSet | character set to be converted |
|
static |
convert character set to XML name.
This XML name is used to specify the character set in an XML document.
characterSet | character set to be converted |
|
static |
check element value for correct value multiplicity and type.
delem | DICOM element to be checked |
vm | value multiplicity (according to the data dictionary) to be checked for. (See DcmElement::checkVM() for a list of valid values.) Interpreted as cardinality (number of items) for sequence attributes. |
type | value type (valid value: "1", "1C", "2", something else) |
searchCond | optional flag indicating the status of a previous search() call |
moduleName | optional module name to be printed (default: "SR document" if NULL) |
acceptViolation | accept certain violations regarding the VR and VM if OFTrue. A warning message will always be reported if the value in incorrect. |
|
static |
check element value for correct value multiplicity and type.
delem | pointer to DICOM element to be checked (might be NULL) |
tagKey | DICOM tag of the DICOM element the parameter 'delem' points to |
vm | value multiplicity (according to the data dictionary) to be checked for. (See DcmElement::checkVM() for a list of valid values.) Interpreted as cardinality (number of items) for sequence attributes. |
type | value type (valid value: "1", "1C", "2", something else) |
searchCond | optional flag indicating the status of a previous search() call |
moduleName | optional module name to be printed (default: "SR document" if NULL) |
acceptViolation | accept certain violations regarding the VR and VM if OFTrue. A warning message will always be reported if the value in incorrect. |
|
static |
check string for valid reference (as used for by-reference relationships).
The string should be non-empty and consist of integer numbers only separated by a "." where the first and the last character of the string are always figures (0..9). Example: 1 or 1.2.3. Both the integer number 0 and a leading 0 for the numbers are forbidden.
stringValue | character string to be checked |
|
static |
convert completion flag to DICOM enumerated value
completionFlag | completion flag to be converted |
|
static |
convert continuity of content flag to DICOM enumerated value
continuityOfContent | continuity of content flag to be converted |
|
static |
convert character string to HTML mnenonic string.
Characters with special meaning for HTML (e.g. '<' and '&') are replace by the corresponding mnenonics (e.g. "<" and "&"). If flag DSRTypes::HF_convertNonASCIICharacters is set, all characters > #127 are also converted (useful if only HTML 3.2 is supported which does not allow to specify the character set).
sourceString | source string to be converted |
markupString | reference to variable where the result should be stored |
flags | optional flags, only checking DSRTypes::HF_convertNonASCIICharacters, DSRTypes::HF_HTML32Compatibility and DSRTypes::HF_XHTML11Compatibility |
newlineAllowed | optional flag indicating whether newlines are allowed or not. If they are allowed the text "<br>" is used, "¶" otherwise. The following combinations are accepted: LF, CR, LF CR, CF LF. |
|
static |
convert character string to print string.
This method is used to convert character strings for text "print" output. Newline characters "\n" are replaced by "\\n", return characters "\r" by "\\r", etc.
sourceString | source string to be converted |
printString | reference to variable where the result should be stored |
|
static |
convert character string to XML mnenonic string.
Characters with special meaning for XML (e.g. '<' and '&') are replace by the corresponding mnenonics (e.g. "<" and "&").
sourceString | source string to be converted |
markupString | reference to variable where the result should be stored |
|
static |
create specified document tree node.
This is a shortcut and the only location where document tree nodes are created. It facilitates the introduction of new relationship/value types and the maintenance.
relationshipType | relationship type of the node to be created |
valueType | value type of the node to be created |
|
static |
create an HTML annex entry with hyperlinks.
A reference text is added to the main document and a new annex entry to the document annex with HTML hyperlinks between both. Example for a reference: '[for details see Annex 1]'
docStream | output stream used for the main document |
annexStream | output stream used for the document annex |
referenceText | optional text added to the main document (e.g. 'for details see') |
annexNumber | reference to the variable where the current annex number is stored. Value is increased automatically by 1 after the new entry has been added. |
flags | optional flag used to customize the output (see DSRTypes::HF_xxx) |
|
static |
create an HTML footnote with hyperlinks
docStream | output stream used for the main document |
footnoteStream | output stream used for the footnote text |
footnoteNumber | reference to the variable where the current footnote number is stored. Value is increased automatically by 1 after the new entry has been added. |
nodeID | unique numerical identifier of the current node for which this footnote is created. Used to create a unique name for the hyperlink. |
flags | optional flag used to customize the output (see DSRTypes::HF_xxx) |
|
static |
create specified SR IOD content relationship constraint checker object.
Please note that the created object has to be deleted by the caller.
documentType | associated SR document type for which the checker object is created |
get current date in DICOM 'DA' format.
(YYYYMMDD)
dateString | string used to store the current date. ('19000101' if current date could not be retrieved) |
get current date and time in DICOM 'DT' format.
(YYYYMMDDHHMMSS) The optional UTC notation (e.g. +0100) as well as the optional fractional second part are currently not supported.
dateTimeString | string used to store the current date and time ('19000101000000' if current date/time could not be retrieved) |
get current time in DICOM 'TM' format.
(HHMMSS)
timeString | string used to store the current time ('000000' if current time could not be retrieved) |
|
static |
convert DICOM defined term to character set.
An empty defined term is mapped to DSRTypes::CS_default (which is ASCII).
definedTerm | defined term to be converted |
|
static |
convert DICOM defined term to relationship type
definedTerm | defined term to be converted |
|
static |
convert DICOM defined term to value type
definedTerm | defined term to be converted |
|
static |
convert DICOM date string to readable format.
The ISO format "YYYY-MM-DD" is used for the readable format.
dicomDate | date in DICOM DA format (YYYYMMDD) |
readableDate | reference to variable where the resulting string is stored |
|
static |
convert DICOM date time string to readable format.
The format "YYYY-MM-DD, HH:MM" or "YYYY-MM-DD, HH:MM:SS" is used for the readable format.
dicomDateTime | time in DICOM DT format (YYYYMMDDHHMMSS...). Possible suffixes (fractional second or UTC notation) are currently ignored. |
readableDateTime | reference to variable where the resulting string is stored |
|
static |
convert DICOM person name to readable format.
The format "<prefix> <first_name> <middle_name> <last_name>, <suffix>" is used for the readable format. Please note that only the first component group (characters before the first '=') of the DICOM person name is used - see DcmPersonName::getNameComponents() for details.
dicomPersonName | person name in DICOM PN format (ln^fn^mn^p^s) |
readablePersonName | reference to variable where the resulting string is stored |
|
static |
convert DICOM time string to readable format.
The ISO format "HH:MM" or "HH:MM:SS" (if seconds are available) is used for the readable format.
dicomTime | time in DICOM TM format (HHMM or HHMMSS...) |
readableTime | reference to variable where the resulting string is stored |
|
static |
convert DICOM person name to XML format.
The tags <prefix>, <first>, <middle>, <last> and <suffix> are used for the XML format of a person name. The string is automatically converted to the markup notation (see convertToMarkupString()). Two tags are separated by a newline. Please note that only the first component group (characters before the first '=') of the DICOM person name is used - see DcmPersonName::getNameComponents() for details.
dicomPersonName | person name in DICOM PN format (ln^fn^mn^p^s) |
xmlPersonName | reference to variable where the resulting string is stored |
writeEmptyValue | optional flag indicating whether an empty value should be written |
|
static |
convert SR document type to document title.
This document title is used for printing/rendering.
documentType | SR document type to be converted |
documentTitle | reference to variable where the resulting string is stored |
|
static |
convert SR document type to modality
documentType | SR document type to be converted |
|
static |
convert SR document type to readable name.
Such a readable name is better suited for printing/rendering.
documentType | SR document type to be converted |
|
static |
convert SR document type to SOP class UID
documentType | SR document type to be converted |
|
static |
convert DICOM enumerated value to completion flag
enumeratedValue | enumerated value to be converted |
|
static |
convert DICOM enumerated value to continuity of content flag
enumeratedValue | enumerated value to be converted |
|
static |
convert DICOM enumerated value to graphic type
enumeratedValue | enumerated value to be converted |
|
static |
convert DICOM enumerated value to graphic type (3D)
enumeratedValue | enumerated value to be converted |
|
static |
convert DICOM enumerated value to preliminary flag
enumeratedValue | enumerated value to be converted |
|
static |
convert DICOM enumerated value to temporal range type
enumeratedValue | enumerated value to be converted |
|
static |
convert DICOM enumerated value to verification flag
enumeratedValue | enumerated value to be converted |
|
static |
get element from dataset and check it for correct value multiplicity and type.
dataset | DICOM dataset from which the element should be retrieved. (Would be 'const' if the methods from 'dcmdata' would also be 'const'.) |
delem | DICOM element used to store the value (always creates a copy!) |
vm | value multiplicity (according to the data dictionary) to be checked for. (See DcmElement::checkVM() for a list of valid values.) Interpreted as cardinality (number of items) for sequence attributes. |
type | value type (valid value: "1", "1C", "2", something else which is not checked) |
moduleName | optional module name to be printed (default: "SR document" if NULL) |
acceptViolation | accept certain violations regarding the VR and VM if OFTrue. A warning message will always be reported if the value in incorrect. |
|
static |
get string value from dataset and check it for correct value multiplicity and type.
dataset | DICOM dataset from which the element should be retrieved. (Would be 'const' if the methods from 'dcmdata' would also be 'const'.) |
tagKey | DICOM tag specifying the attribute from which the string should be retrieved |
stringValue | reference to variable in which the result should be stored. (This parameter is automatically cleared if the tag could not be found. It is not cleared if the retrieved string is invalid, e.g. violates VR or VM definition.) |
vm | value multiplicity (according to the data dictionary) to be checked for. (See DcmElement::checkVM() for a list of valid values.) Interpreted as cardinality (number of items) for sequence attributes. |
type | value type (valid value: "1", "1C", "2", something else which is not checked) |
moduleName | optional module name to be printed (default: "SR document" if NULL) |
acceptViolation | accept certain violations regarding the VR and VM if OFTrue. A warning message will always be reported if the value in incorrect. |
|
static |
get element from dataset
dataset | reference to DICOM dataset from which the element should be retrieved. (Would be 'const' if the methods from 'dcmdata' would also be 'const'.) |
delem | reference to DICOM element which should be retrieved. The return value is also stored in this parameter. |
|
static |
get string value from element and convert to HTML/XML.
Please note that only the first element value is retrieved (in case of multiple values).
delem | DICOM element from which the string value should be retrieved |
stringValue | reference to variable in which the result should be stored |
convertNonASCII | convert non-ASCII characters (> #127) to numeric value (&#nnn;) if OFTrue |
|
static |
get string value from element and convert to "print" format.
Please note that only the first element value is retrieved (in case of multiple values).
delem | DICOM element from which the string value should be retrieved |
stringValue | reference to variable in which the result should be stored |
|
static |
get string value from dataset
dataset | DICOM dataset from which the string should be retrieved. (Would be 'const' if the methods from 'dcmdata' would also be 'const'.) |
tagKey | DICOM tag specifying the attribute from which the string should be retrieved |
stringValue | reference to variable in which the result should be stored (This parameter is automatically cleared if the tag could not be found.) |
pos | index of the value to get (0..vm-1), -1 for all components |
|
static |
get string value from element
delem | DICOM element from which the string value should be retrieved |
|
static |
get string value from element.
Please note that only the first element value is retrieved (in case of multiple values).
delem | DICOM element from which the string value should be retrieved |
stringValue | reference to variable where the result should be stored |
|
static |
get string value from element
delem | DICOM element from which the string value should be retrieved |
stringValue | reference to variable in which the result should be stored (This parameter is automatically cleared if an error occurs.) |
pos | index of the value to get (0..vm-1), -1 for all components |
|
static |
convert graphic type (3D) to DICOM enumerated value
graphicType | graphic type (3D) to be converted |
|
static |
convert graphic type (3D) to readable name.
Such a readable name is better suited for printing/rendering.
graphicType | graphic type (3D) to be converted |
|
static |
convert graphic type to DICOM enumerated value
graphicType | graphic type to be converted |
|
static |
convert graphic type to readable name.
Such a readable name is better suited for printing/rendering.
graphicType | graphic type to be converted |
|
static |
check whether specified SR document type is supported by this library
documentType | SR document type to be checked |
get local timezone in DICOM format.
(&ZZXX)
timezoneString | string used to store the local timezone ('+0000' if timezone could not be retrieved) |
|
static |
convert unsigned integer number to character string
number | unsigned integer number to be converted |
stringValue | character string used to store the result |
|
static |
convert preliminary flag to DICOM enumerated value
preliminaryFlag | preliminary flag to be converted |
|
static |
convert presentation state type to short name.
Such a short name (e.g. "GSPS") is better suited for printing/rendering than a UID.
pstateType | presentation state type to be converted |
|
static |
print an error message for the current content item.
The value type (for DEBUG mode also the node ID) is added if the 'node' if specified.
action | text describing the current action (e.g. 'Reading'), 'Processing' if NULL |
result | status used to print more information on the error (no message if EC_Normal) |
node | pointer to document tree node for which the message should be printed |
location | position of the affected content item (e.g. '1.2.3', not printed if NULL) |
|
static |
print the warning message that the current content item is invalid/incomplete.
The value type (for DEBUG mode also the node ID) is added if the 'node' if specified.
action | text describing the current action (e.g. 'Reading'), 'Processing' if NULL |
node | pointer to document tree node for which the message should be printed |
location | position of the affected content item (e.g. '1.2.3', not printed if NULL) |
|
static |
print a warning message that an unknown/unsupported value has been determined
valueName | name of the unknown/unsupported value |
readValue | value that has been read (optional) |
action | text describing the current action (default: 'Reading'), 'Processing' if NULL |
|
static |
put string value to dataset
dataset | reference to DICOM dataset to which the string should be put. |
tag | DICOM tag specifying the attribute to which the string should be put |
stringValue | character string specifying the value to be set |
allowEmpty | allow empty element to be inserted if OFTrue. Do not insert empty element otherwise. |
|
static |
convert relationship type to DICOM defined term
relationshipType | relationship type to be converted |
|
static |
convert relationship type to readable name.
Such a readable name is better suited for printing/rendering.
relationshipType | relationship type to be converted |
|
static |
remove given attribute from the sequence.
All occurrences of the attribute in all items of the sequence are removed.
sequence | reference to DICOM sequence from which the attribute should be removed |
tagKey | DICOM tag specifying the attribute which should be removed |
|
static |
check whether a given SR document type requires the Enhanced General Equipment Module
documentType | SR document type to be checked |
|
static |
check whether a given SR document type requires the Synchronization Module
documentType | SR document type to be checked |
|
static |
check whether a given SR document type requires the Timezone Module
documentType | SR document type to be checked |
|
static |
convert SOP class UID to SR document type
sopClassUID | SOP class UID to be converted |
|
static |
convert SOP class UID to presentation state type
sopClassUID | SOP class UID to be converted |
|
static |
convert string to unsigned integer number
stringValue | character string to be converted |
Referenced by DSRTreeNodeCursor< T >::gotoNode().
|
static |
convert temporal range type to DICOM enumerated value
temporalRangeType | temporal range type to be converted |
|
static |
convert temporal range type to readable name.
Such a readable name is better suited for printing/rendering.
temporalRangeType | temporal range type to be converted |
|
static |
check whether a given SR document type uses the Key Object Document Module (instead of the SR Document General Module)
documentType | SR document type to be checked |
|
static |
check whether a given SR document type uses the Key Object Document Series Module (instead of the SR Document Series Module)
documentType | SR document type to be checked |
|
static |
check whether a given SR document type uses the SR Document General Module (instead of the Key Object Document Module)
documentType | SR document type to be checked |
|
static |
check whether a given SR document type uses the SR Document Series Module (instead of the Key Object Document Series Module)
documentType | SR document type to be checked |
|
static |
convert value type to DICOM defined term
valueType | value type to be converted |
|
static |
convert value type to readable name.
Such a readable name is better suited for printing/rendering.
valueType | value type to be converted |
|
static |
convert value type to XML tag name
valueType | value type to be converted |
|
static |
convert verification flag to DICOM enumerated value
verificationFlag | verification flag to be converted |
|
static |
write string value from DICOM element to XML output stream.
The output looks like this: "<" tagName ">" stringValue "</" tagName ">" For elements with DICOM VR=PN the function dicomToXMLPersonName() is used internally.
stream | output stream to which the XML document is written |
delem | DICOM element from which the value is retrieved |
tagName | name of the XML tag used to surround the string value |
writeEmptyValue | optional flag indicating whether an empty value should be written |
|
static |
write string value to XML output stream.
The output looks like this: "<" tagName ">" stringValue "</" tagName ">"
stream | output stream to which the XML document is written |
stringValue | string value to be written |
tagName | name of the XML tag used to surround the string value |
writeEmptyValue | optional flag indicating whether an empty value should be written |
|
static |
convert XML tag name to value type
xmlTagName | XML tag name to be converted |