DICOMGRAPHICOBJECT (original) (raw)

Summary

The DICOMGRAPHICOBJECT describes the attributes of a "Graphic Annotation" object.

Syntax

typedef struct tagDICOMGRAPHICOBJECT { [L_UINT](../../main/api/leadtools-basic-data-types.html) uStructSize; /* size of this structure */ [L_TCHAR](../../main/api/leadtools-basic-data-types.html) *pszLayerName; /* pointer to the "Graphic Layer" attribute */ [L_UINT](../../main/api/leadtools-basic-data-types.html) uType; /* value of the "Graphic Type" */ [L_UINT](../../main/api/leadtools-basic-data-types.html) uUnits; /* value of the "Graphic Annotation Units" */ [L_BOOL](../../main/api/leadtools-basic-data-types.html) bFilled; /* value that indicates the "Graphic Filled" */ [L_INT16](../../main/api/leadtools-basic-data-types.html) nPointCount; /* value that indicates the "Number of Graphic Points" */ [pDICOMANNPOINT](dicomannpoint.html) pAnnPoints; /* pointer to an array of [DICOMANNPOINT](dicomannpoint.html) structures */ [L_VOID](../../main/api/leadtools-basic-data-types.html) *pReserved; [L_UINT](../../main/api/leadtools-basic-data-types.html) uCompoundGraphicInstanceId; [L_UINT](../../main/api/leadtools-basic-data-types.html) uOptions; [pDICOMLINESTYLE](../api/dicomlinestyle.html) pLineStyle; [pDICOMFILLSTYLE](../api/dicomfillstyle.html) pFillStyle; [L_UINT](../../main/api/leadtools-basic-data-types.html) uGraphicGroupId; } DICOMGRAPHICOBJECT, *pDICOMGRAPHICOBJECT;

Members

uStructSize

The size of the structure (use sizeof (DICOMGRAPHICOBJECT)).

pszLayerName

Pointer to the "Graphic Layer" (0070,0002) attribute value in the "Graphic Annotation Sequence" (0070,0001)

uType

The value of the attribute "Graphic Type" (0070,0023) in the "Graphic Annotation Module". Enumerated values are:

Value	Meaning
DICANN_TYPE_POINT	[0x00000001] "POINT".
DICANN_TYPE_POLYLINE	[0x00000002] "POLYLINE".
DICANN_TYPE_INTERPOLATED	[0x00000003] "INTERPOLATED".
DICANN_TYPE_CIRCLE	[0x00000004] "CIRCLE".
DICANN_TYPE_ELLIPSE	[0x00000005] "ELLIPSE".

uUnits

The value of the attribute "Graphic Annotation Units" (0070,0005) in the "Graphic Annotation Module". Enumerated values are:

Value	Meaning
DICANN_UNIT_PIXEL	[0x00000001] "PIXEL".
DICANN_UNIT_DISPLAY	[0x00000002] "DISPLAY".

bFilled

Boolean variable, which represents the attribute "Graphic Filled" (0070,0024).

Value	Meaning
TRUE	Y = yes
FALSE	N = no

nPointCount

The value of the attribute "Number of Graphic Points" (0070,0021) in the "Graphic Annotation Module".

pAnnPoints

Pointer to an array of DICOMANNPOINT structures, which represent the points of the graphical object. This member is based on the "Graphic Data" (0070,0022) attribute in the "Graphic Annotation Module".

pReserved

Reserved for internal use -- Pass 0.

uCompoundGraphicInstanceId

O TAG_COMPOUND_GRAPHIC_INSTANCE_ID

uOptions

DICANN_OPTIONS_NONE, DICANN_OPTIONS_LINE_STYLE, DICANN_OPTIONS_FILL_STYLE

pLineStyle

TAG_LINE_STYLE_SEQUENCE

pFillStyle

TAG_FILL_STYLE_SEQUENCE

uGraphicGroupId

TAG_GRAPHIC_GROUP_ID

Comments

The members of this structure are based on some of the attributes of the "Graphic Annotation Module", please see "Graphic Annotation Module Attributes" in the DICOM standard for more details.

Special note about the following members: pszLayerName and pAnnPoints:

When you call a function, which updates this structure (ex. LDicomDS::GetGraphicObjectInfo), LEADTOOLS will fill these members with pointers to the internal memory, which LEADTOOLS manages. You must not free these pointers. When you call a function, which updates internal data from the structure you provide (ex. LDicomDS::SetGraphicObjectInfo), LEADTOOLS expects you to fill these members with pointers to memory that you have allocated and that you manage. You must free these pointers when they are no longer needed.