Leadtools.Dicom Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.10.31
DicomDataSet Class Members
See Also  Properties  Methods 
Leadtools.Dicom Namespace : DicomDataSet Class


The following tables list the members exposed by DicomDataSet.

Public Constructors

 NameDescription
Public ConstructorDicomDataSet ConstructorOverloaded.  Initializes a new instance of the DicomDataSet class.  
Top

Public Properties

 NameDescription
Public PropertyDefaultJpeg2000Options Gets the default JPEG 2000 compression options.  
Public PropertyInformationClass Gets the IOD class of the Data Set.  
Public PropertyInformationCommand Gets the command associated with the Command Set.  
Public PropertyInformationFlags Gets the Meta-header flags and Transfer Syntax flags that indicate the file characteristics.  
Public PropertyIsRequestCommand Gets or sets a value indicating whether the Command Set is a request or a response.  
Public PropertyJpeg2000Options Gets or sets the JPEG 2000 compression options.  
Public PropertyLayerCount Gets the number of the Graphic Layers.  
Public PropertyModuleCount Gets the number of modules in the entire Data Set.  
Public PropertyOverlayCount Gets the number of overlays in the Data Set.  
Public PropertyVoiLutCount Gets the number of items under the VOI LUT Sequence (0028,3010).  
Public PropertyWaveformGroupCount Gets the number of waveform multiplex groups that are included in the dataset.  
Public PropertyWindowCount Gets the number of values under the window center element.  
Top

Public Methods

 NameDescription
Public MethodAddLayerImageReference Adds a new item under the "Referenced Image Sequence" for the specified item under the "Graphic Annotation Sequence".  
Public MethodAddPresentationStateImageReferenceOverloaded.  Adds a new item to the "Referenced Image Sequence" under the "Presentation State Module".  
Public MethodAddWaveformGroup Adds a new waveform group to the Data Set.  
Public MethodChangeTransferSyntax Changes the Transfer Syntax of the Data Set.  
Public MethodCopy Copies the data elements from one Data Set to another.  
Public MethodCreateGraphicAnnSQItem Adds a new item under the "Graphic Annotation Sequence".  
Public MethodCreateGraphicObject Creates a new graphic annotation object.  
Public MethodCreateLayer Adds a new item under the "Graphic Layer Sequence" (0070,0060) in the Graphic Layer Module".  
Public MethodCreateSignature Creates a Digital Signature in the Data Set.  
Public MethodCreateTextObject Creates a new text annotation object.  
Public MethodDeleteElement Deletes the specified item from the Data Set.  
Public MethodDeleteImage Deletes one or more images from a Pixel Data element.  
Public MethodDeleteKey Deletes the specified key element from the Dicom Dir Data Set.  
Public MethodDeleteModalityLut Deletes all the elements that describe the Modality LUT.  
Public MethodDeleteModule Deletes a module from the Data Set.  
Public MethodDeleteOverlay Deletes all the elements that describe an overlay.  
Public MethodDeletePaletteColorLut Deletes all the elements that describe the "Palette Color Lookup Table".  
Public MethodDeleteSignature Removes one or all Digital Signatures from the Data Set.  
Public MethodDeleteVoiLut Deletes all the elements that describe a VOI LUT.  
Public MethodDeleteWaveformGroup Deletes a waveform group from the dataset.  
Public MethodDeleteWindow Deletes all the elements that describe "window center" and "window width".  
Public MethodDisposeOverloaded.  Releases all resources used by the DicomDataSet.  
Public MethodExistsElement Determines whether the specified object is valid.  
Public MethodFindFirstElementOverloaded.  Returns the first item in the Data Set with the specified Tag.  
Public MethodFindFirstGraphicAnnSQItem Retrieves the first item under the "Graphic Annotation Sequence" (0070,0001) in the "Graphic Annotation Module".  
Public MethodFindFirstKeyOverloaded.  Returns the first item in the Dicom Dir Data Set with the specified key element type.  
Public MethodFindFirstPresentationStateReferencedSeriesItem Retrieves the first item under the "Referenced Series Sequence" (0008,1115) in the "Presentation State Module".  
Public MethodFindLastElementOverloaded.  Returns the last item in the Data Set with the specified Tag.  
Public MethodFindLastKeyOverloaded.  Returns the last item in the Dicom Dir Data Set with the specified key element type.  
Public MethodFindModule Returns a DicomModule object that contains information about the specified module.  
Public MethodFindModuleByIndex Returns a DicomModule object that contains information about the module, on Level 0, at the specified index.  
Public MethodFindNextElement Returns the next item in the Data Set with a specific Tag.  
Public MethodFindNextGraphicAnnSQItem Retrieves the next item under the "Graphic Annotation Sequence" (0070,0001) in the "Graphic Annotation Module".  
Public MethodFindNextKey Returns the next item in the Dicom Dir Data Set with a specific key element type.  
Public MethodFindNextPresentationStateReferencedSeriesItem Retrieves the next item under the "Referenced Series Sequence" (0008,1115) in the "Presentation State Module".  
Public MethodFindPreviousElement Returns the previous item in the Data Set with a specific Tag.  
Public MethodFindPreviousKey Returns the previous item in the Dicom Dir Data Set with a specific key element type.  
Public MethodFindSignature Returns the Digital Signatures Sequence Item that corresponds to the Digital Signature that has the specified Digital Signature UID, if found in the Data Set.  
Public MethodFreeElementValue Frees the memory for a value.  
Public MethodGetAgeValue Returns an array of DicomAgeValue objects, that contains age information stored in the Value Field of the specified element.  
Public MethodGetBinaryValueOverloaded.  Updates a buffer with the binary value of the specified data element.  
Public MethodGetByteValue Returns an array of byte values, stored in the Value Field, of the specified element.  
Public MethodGetByteValuePtr Returns a pointer to a byte value, stored in the Value Field, of the specified element.  
Public MethodGetChildElement Returns the item in the Data Set that is the first child of the specified item.  
Public MethodGetChildKey Returns the item in the Dicom Dir Data Set that is the first child of the specified item.  
Public MethodGetConvertValue Converts the value of an element to a string.  
Public MethodGetDateRangeValue Returns a DicomDateRangeValue structure that contains date range information for the specified element.  
Public MethodGetDateTimeValue Returns an array of DicomDateTimeValue objects, that contains date-time information stored in the Value Field of the specified element.  
Public MethodGetDateValue Returns an array of DicomDateValue objects, that contains date information stored in the Value Field of the specified element.  
Public MethodGetDoubleValue Returns an array of double values, stored in the Value Field, of the specified element.  
Public MethodGetDoubleValuePtr Returns a pointer to a double value, stored in the Value Field, of the specified element.  
Public MethodGetElementLevel Returns a value that indicates the level at which the specified element is located within the Data Set.  
Public MethodGetElementValueCount Returns the number of values stored in the Value Field of the specified element.  
Public MethodGetFirstElement Returns the first item in the Data Set.  
Public MethodGetFirstKey Returns the first item in the Dicom Dir Data Set.  
Public MethodGetFloatValue Returns an array of float values, stored in the Value Field, of the specified element.  
Public MethodGetFloatValuePtr Returns a pointer to a float value, stored in the Value Field, of the specified element.  
Public MethodGetGraphicObjectCount Retrieves the number of graphical annotation objects in a certain "Graphic Annotation Sequence" (0070,0001) item.  
Public MethodGetGraphicObjectInformation Gets the attributes of the specified graphic annotation object.  
Public MethodGetGraphicObjElement Gets the item element of the specified graphic annotation object.  
Public MethodGetGraphicObjPointCount Retrieves number of points that represents a graphical annotation object.  
Public MethodGetImage Gets the image of a Pixel Data element.  
Public MethodGetImageCount Gets the number of frames in a Pixel Data element.  
Public MethodGetImageInformation Retrieves information about the specified image.  
Public MethodGetImages Gets the images of a Pixel Data element.  
Public MethodGetIntValue Returns an array of integer values, stored in the Value Field, of the specified element.  
Public MethodGetIntValuePtr Returns a pointer to a long value, stored in the Value Field, of the specified data element.  
Public MethodGetKeyValue Returns the key element type of the specified key element.  
Public MethodGetKeyValuePtr Returns the key element type of the specified key element.  
Public MethodGetKeyValueString Returns the key element type of the specified key element.  
Public MethodGetLastElement Returns the last item in the Data Set.  
Public MethodGetLastKey Returns the last item in the Dicom Dir Data Set.  
Public MethodGetLayerElementByIndex Gets the item element of the specified graphic layer.  
Public MethodGetLayerElementByName Gets the item element of the specified graphic layer.  
Public MethodGetLayerGraphicObjectCount Retrieves the number of graphical annotation objects, which correspond to the specified item under the "Graphic Annotation Sequence" (0070,0001).  
Public MethodGetLayerImageReferenceCount Retrieves the number of referenced images, which correspond to the specified item under the "Graphic Annotation Sequence" (0070,0001).  
Public MethodGetLayerImageReferenceElement Gets the item element of the specified SOP instance under the "Referenced Image Sequence" (0008,1140) in the specified "Graphic Annotation Sequence" (0070,0001) item.  
Public MethodGetLayerImageReferenceSOPInstance Retrieves the SOP Instance UID for a referenced image (SOP Instance) under the "Referenced Image Sequence" in a certain graphic annotation item inside the "Graphic Annotation Module".  
Public MethodGetLayerIndex Retrieves the index of the layer with the specified name.  
Public MethodGetLayerInformation Retrieves the attributes of a layer at the specified index.  
Public MethodGetLayerName Retrieves the value of the "Graphic Layer" element under one of the items under the "Graphic Annotation Sequence" in the "Graphic Annotation Module".  
Public MethodGetLayerTextObjectCount Retrieves number of text annotation objects, which correspond to the specified item under the "Graphic Annotation Sequence" (0070,0001).  
Public MethodGetLongValue Returns a pointer to a 64 long value, stored in the Value Field, of the specified element.  
Public MethodGetMacAlgorithm Returns the Message Authentication Code (MAC) Algorithm (0400,0015) used in the creation of the specified Digital Signature.  
Public MethodGetMacTransferSyntax Returns the Message Authentication Code (MAC) Calculation Transfer Syntax UID (0400,0010) used in the creation of the specified Digital Signature.  
Public MethodGetModalityLutAttributes Retrieves the attributes that describe the Modality LUT.  
Public MethodGetModalityLutData Retrieves "LUT Data" for a "Modality LUT Sequence".  
Public MethodGetNextElement Returns the item in the Data Set that immediately follows the specified item.  
Public MethodGetNextKey Returns the item in the Dicom Dir Data Set that immediately follows the specified item.  
Public MethodGetOverlayActivationLayer Retrieves the "Overlay Activation Layer".  
Public MethodGetOverlayAttributes Retrieves the attributes of the overlay at the specified index.  
Public MethodGetOverlayGroupNumber Gets the overlay group number.  
Public MethodGetOverlayImage Retrieves the "Overlay Data" (60xx,3000) for the specified overlay index.  
Public MethodGetOverlayImages Loads the image(s) with frames from the "Overlay Data" (60xx, 3000) element.  
Public MethodGetPaletteColorLutAttributes Retrieves the attributes that describe the "Palette Color Lookup Table".  
Public MethodGetPaletteColorLutData Retrieves red, green or blue "Palette Color Lookup Table Data".  
Public MethodGetParentElement Returns the item in the Data Set that is the parent of the specified item.  
Public MethodGetParentKey Returns the item in the Dicom Dir Data Set that contains the parent of the specified item.  
Public MethodGetPreambleOverloaded.  Gets the contents of the file’s preamble.  
Public MethodGetPresentationStateImageReference Retrieves the item element, which represents a referenced image (SOP Instance) under the "Referenced Image Sequence" in the "Presentation State Module".  
Public MethodGetPresentationStateImageReferenceCount Retrieves number of images (SOP Instances) that are referenced in an item under the "Referenced Series Sequence" (0008,1115) in the "Presentation State Module".  
Public MethodGetPresentationStateImageReferenceSOPInstance Retrieves the SOP Instance UID for a referenced image (SOP Instance) under the "Referenced Image Sequence" in the "Presentation State Module".  
Public MethodGetPresentationStateInformation Retrieves the attributes of the "Presentation State Module".  
Public MethodGetPreviousElement Returns the item in the Data Set that immediately precedes the specified item.  
Public MethodGetPreviousKey Returns the item in the Dicom Dir Data Set that immediately precedes the specified item.  
Public MethodGetRootElement Returns the root element of the specified item.  
Public MethodGetRootKey Returns the root of the specified item.  
Public MethodGetShortValue Returns an array of short values, stored in the Value Field, of the specified element.  
Public MethodGetShortValuePtr Returns a pointer to a short value, stored in the Value Field, of the specified element.  
Public MethodGetSignature Returns the Digital Signatures Sequence Item that corresponds to the Digital Signature at the specified index.  
Public MethodGetSignatureDateTime Returns the Digital Signature DateTime (0400,0105) of the specified Digital Signature.  
Public MethodGetSignaturesCount Returns the number of Digital Signatures in the main Data Set or in an item of a sequence of items.  
Public MethodGetSignatureUID Returns the Digital Signature UID (0400,0100) of the specified Digital Signature.  
Public MethodGetSignedElement Returns the signed Data Element at the specified index.  
Public MethodGetSignedElementsCount Returns the number of Data Elements covered by the specified Digital Signature.  
Public MethodGetStringValue Returns a string value, stored in the Value Field, of the specified element.  
Public MethodGetStringValuePtr Returns a pointer to a string value, stored in the Value Field, of the specified element.  
Public MethodGetTextObjectCount Retrieves the number of text annotation objects in the specified "Graphic Annotation Sequence" (0070,0001) item.  
Public MethodGetTextObjectInformation Gets the attributes of a text annotation object.  
Public MethodGetTextObjElement Gets the item element of the specified text annotation object.  
Public MethodGetTimeRangeValue Returns a DicomTimeRangeValue structure that contains time range information for the specified element.  
Public MethodGetTimeValue Returns an array of DicomTimeValue objects, that contains time information stored in the Value Field of the specified element.  
Public MethodGetVoiLut Retrieves the attributes that describe the VOI LUT.  
Public MethodGetVoiLutData Retrieves "LUT Data" for an item under "VOI LUT Sequence".  
Public MethodGetWaveformGroup Gets a waveform group from the dataset.  
Public MethodGetWindow Retrieves the attributes that describe the "Window Center" and "Window Width".  
Public MethodInitialize Creates the Data Set object, inserting the appropriate elements for the specified class.  
Public MethodInitializeCommandSet Creates the Command Set and inserts the elements for the specified command.  
Public MethodInsertElementOverloaded.  Inserts a new element in the Data Set.  
Public MethodInsertImage Inserts an image in a Pixel Data element.  
Public MethodInsertImages Inserts image(s) in a Pixel Data element.  
Public MethodInsertKeyOverloaded.  Inserts a new key element in the Dicom Dir Data Set.  
Public MethodInsertModule Inserts a new module in the Data Set.  
Public MethodIsOverlayInDataSet Determines whether the overlay data exists inside this Data Set or inside another Data Set.  
Public MethodIsVolatileElement Determines whether the specified element is volatile.  
Public MethodLoadOverloaded.  Loads a Data Set.  
Public MethodRemoveAllGraphicObjects Removes all graphical annotation objects under the specified "Graphic Annotation Sequence" (0070,0001) item.  
Public MethodRemoveAllImageReferences Removes all the referenced images from the "Referenced Image Sequence" in all Graphic Annotation Sequence items.  
Public MethodRemoveAllImageReferencesFromLayer Removes all the referenced images from the "Referenced Image Sequence" in the specified "Graphic Annotation Sequence" item.  
Public MethodRemoveAllLayers Removes all layers under the "Graphic Layer Module".  
Public MethodRemoveAllPresentationStateImageReferences Removes all "Referenced Image Sequence(s)", which belong to the "Referenced Series Sequence" under the "Presentation State Module".  
Public MethodRemoveAllTextObjects Removes all text annotation objects under the specified "Graphic Annotation Sequence" (0070,0001) item.  
Public MethodRemoveGraphicObject Removes the graphic annotation object at the specified index.  
Public MethodRemoveImageReferenceFromLayer Removes a referenced image from the "Referenced Image Sequence" in the specified "Graphic Annotation Sequence" item.  
Public MethodRemoveLayerByIndex Deletes all the elements that describe a layer.  
Public MethodRemoveLayerByName Deletes all the elements that describe a layer.  
Public MethodRemoveLayerGraphicObjects Removes all graphical annotation objects, which correspond to the specified item under the "Graphic Annotation Sequence" (0070,0001) in the "Graphic Annotation Module".  
Public MethodRemoveLayerTextObjects Removes all text annotation objects, which correspond to the specified item under the "Graphic Annotation Sequence" (0070,0001) in the "Graphic Annotation Module".  
Public MethodRemovePresentationStateImageReference Removes an item from the "Referenced Image Sequence" under the "Presentation State Module".  
Public MethodRemoveTextObject Removes the text annotation object at the specified index.  
Public MethodReset Removes all items from the Data Set.  
Public MethodSave Saves the Data Set to the specified file.  
Public MethodSaveCertificate Saves the signer’s digital certificate associated with the specified Digital Signature to a file.  
Public MethodSetAgeValue Sets the Age value(s) of a Data Element.  
Public MethodSetBinaryValueOverloaded.  Sets the binary value of an element.  
Public MethodSetByteValueOverloaded.  Sets the character value(s) of a Data Element.  
Public MethodSetConvertValue Converts a string and sets the value of an element.  
Public MethodSetConvertValuePtr Converts a string and sets the value of an element.  
Public MethodSetDateRangeValue Sets the Date range value(s) of a Data Element.  
Public MethodSetDateTimeValue Sets the Date-Time value(s) of a Data Element.  
Public MethodSetDateValue Sets the Date value(s) of a Data Element.  
Public MethodSetDoubleValueOverloaded.  Sets the double value(s) of a Data Element.  
Public MethodSetFloatValueOverloaded.  Sets the float value(s) of a Data Element.  
Public MethodSetGraphicObjectInformation Updates the attributes of a graphic annotation object.  
Public MethodSetImage Replaces the image(s) in a Pixel Data element.  
Public MethodSetImages Replaces the images in a Pixel Data element.  
Public MethodSetIntValueOverloaded.  Sets the integer value(s) of a Data Element.  
Public MethodSetLayerInformation Sets layer attributes for the layer at the specified index.  
Public MethodSetLayerName Sets the value of the "Graphic Layer" element under one of the items under the "Graphic Annotation Sequence" in the "Graphic Annotation Module".  
Public MethodSetModalityLut Sets the attributes that describe the Modality LUT.  
Public MethodSetOverlayAttributes Sets overlay attributes for a certain index.  
Public MethodSetOverlayImage Sets the "Overlay Data" (60xx,3000) for a certain overlay index.  
Public MethodSetOverlayImages Sets the "Overlay Data" (60xx,3000) for the specified overlay index.  
Public MethodSetPaletteColorLutAttributes Sets the attributes that describe the "Palette Color Lookup Table".  
Public MethodSetPaletteColorLutData Sets red, green or blue "Palette Color Lookup Table" data.  
Public MethodSetPreambleOverloaded.  Sets the contents of the file's preamble.  
Public MethodSetPresentationStateInformation Sets the attributes of the "Presentation State Module".  
Public MethodSetShortValueOverloaded.  Sets the short value(s) of a Data Element.  
Public MethodSetStringValueOverloaded.  Sets the string value(s) of a Data Element.  
Public MethodSetStringValuePtr Sets the string value(s) of a Data Element.  
Public MethodSetTextObjectInformation Updates the attributes of a text annotation object.  
Public MethodSetTimeRangeValue Sets the Time range value(s) of a Data Element.  
Public MethodSetTimeValue Sets the Time value(s) of a Data Element.  
Public MethodSetVoiLut Sets the attributes that describe the VOI LUT.  
Public MethodSetWindow Sets the attributes that describe the "Window Center" and "Window Width".  
Public MethodVerifySignature Verifies Digital Signatures in the Data Set.  
Top

Protected Methods

 NameDescription
Protected MethodFinalizeOverridden.  This member overrides Finalize.  
Top

See Also

Leadtools.Dicom requires a Medical toolkit license and unlock key. For more information, refer to: Raster Pro/Document/Medical Features