Error processing SSI file
LEADTOOLS Medical (Leadtools.Dicom assembly)

Show in webframe

DicomDataSet Class Members

Show in webframe
Properties  Methods 





The following tables list the members exposed by DicomDataSet.

Public Constructors
 NameDescription
DicomDataSet ConstructorOverloaded.   
Top
Public Properties
 NameDescription
DefaultJpeg2000OptionsGets the default JPEG 2000 compression options.  
GetValueResultHolds the result after a call to GetValue  
InformationClassGets the IOD class of the Data Set.  
InformationCommandGets the command associated with the Command Set.  
InformationFlagsGets the Meta-header flags and Transfer Syntax flags that indicate the file characteristics.  
InsertElementAndSetValueResultHolds the result after a call to InsertElementAndSetValue  
IsRequestCommandGets or sets a value indicating whether the Command Set is a request or a response.  
Jpeg2000OptionsGets or sets the JPEG 2000 compression options.  
LayerCountGets the number of the Graphic Layers.  
ModuleCountGets the number of modules in the entire Data Set.  
OverlayCountGets the number of overlays in the Data Set.  
VoiLutCountGets the number of items under the VOI LUT Sequence (0028,3010).  
WaveformGroupCountGets the number of waveform multiplex groups that are included in the dataset.  
Top
Public Methods
 NameDescription
AddLayerImageReferenceAdds a new item under the "Referenced Image Sequence" for the specified item under the "Graphic Annotation Sequence".  
AddPresentationStateImageReferenceOverloaded. Adds a new item to the "Referenced Image Sequence" under the "Presentation State Module" from a disk file.  
AddWaveformGroupAdds a new waveform group to the Data Set.  
BeginEditItemOverloaded. Used to edit an existing item, or create a new item in a DICOM sequence  
BeginEditSequenceOverloaded. Used to create a new DICOM sequence, or edit an existing DICOM sequence  
BeginReadItemOverloaded. Used to read an existing item from a DICOM sequence  
BeginReadSequenceOverloaded. Used to read values from an existing DICOM sequence  
ChangeTransferSyntaxOverloaded. Changes the Transfer Syntax of the Data Set.  
CopyOverloaded. Copies the data elements from one Data Set to another.  
CreateCompoundGraphicCreates a new compound graphic annotation.  
CreateGraphicAnnSQItemAdds a new item under the "Graphic Annotation Sequence".  
CreateGraphicObjectCreates a new graphic annotation object.  
CreateLayerAdds a new item under the "Graphic Layer Sequence" (0070,0060) in the Graphic Layer Module".  
CreatePrivateCreatorDataElementCreates a Private Creator Data Element to reserve private data elements.  
CreateSignatureCreates a Digital Signature in the Data Set.  
CreateTextObjectCreates a new text annotation object.  
DeleteElementDeletes the specified item from the Data Set.  
DeleteImageOverloaded. Deletes one or more images from a Pixel Data element.  
DeleteKeyDeletes the specified key element from the Dicom Dir Data Set.  
DeleteModalityLutOverloaded. Deletes all the elements that describe the Modality LUT.  
DeleteModuleDeletes a module from the Data Set.  
DeleteOverlayDeletes all the elements that describe an overlay.  
DeletePaletteColorLutDeletes all the elements that describe the "Palette Color Lookup Table".  
DeleteSignatureRemoves one or all Digital Signatures from the Data Set.  
DeleteVoiLutDeletes all the elements that describe a VOI LUT.  
DeleteWaveformGroupDeletes a waveform group from the dataset.  
DeleteWindowOverloaded. Deletes all the elements that describe "window center" and "window width".  
DisposeOverloaded. Releases all resources used by the DicomDataSet.  
EndEditItemFinalizes the changes when creating or editing an item in a DICOM sequence  
EndEditSequenceFinalizes the changes when creating or editing a DICOM sequence  
EndReadItemFinalizes the read when reading an item from a DICOM sequence  
EndReadSequenceFinalizes the read when reading a DICOM sequence  
ExistsElementDetermines whether the specified object is valid.  
FindFirstDescendantFinds the first descendant of a parentElement with the specified tag.  
FindFirstElementReturns the first item in the Data Set with the specified Tag.  
FindFirstGraphicAnnSQItemRetrieves the first item under the "Graphic Annotation Sequence" (0070,0001) in the "Graphic Annotation Module".  
FindFirstKeyOverloaded. Returns the first item in the Dicom Dir Data Set with the specified key element type.  
FindFirstPresentationStateReferencedSeriesItemRetrieves the first item under the "Referenced Series Sequence" (0008,1115) in the "Presentation State Module".  
FindFirstPrivateCreatorDataElementReturns the Private Creator Data Element that matches the search constraints.  
FindFirstPrivateElementReturns the first existing private element that is reserved by privateCreatorDataElement.  
FindLastElementReturns the last item in the Data Set with the specified Tag.  
FindLastKeyOverloaded. Returns the last item in the Dicom Dir Data Set with the specified key element type.  
FindModuleReturns a DicomModule object that contains information about the specified module.  
FindModuleByIndexReturns a DicomModule object that contains information about the module, on Level 0, at the specified index.  
FindNextDescendantFinds the next descendant of parentElement with the specified tag  
FindNextElementReturns the next item in the Data Set with a specific Tag.  
FindNextGraphicAnnSQItemRetrieves the next item under the "Graphic Annotation Sequence" (0070,0001) in the "Graphic Annotation Module".  
FindNextKeyReturns the next item in the Dicom Dir Data Set with a specific key element type.  
FindNextPresentationStateReferencedSeriesItemRetrieves the next item under the "Referenced Series Sequence" (0008,1115) in the "Presentation State Module".  
FindNextPrivateCreatorDataElementReturns the next Private Creator Data Element that matches the search constraints.  
FindNextPrivateElementReturns the next existing private element that is reserved by privateCreatorDataElement.  
FindPreviousElementReturns the previous item in the Data Set with a specific Tag.  
FindPreviousKeyReturns the previous item in the Dicom Dir Data Set with a specific key element type.  
FindSignatureReturns the Digital Signatures Sequence Item that corresponds to the Digital Signature that has the specified Digital Signature UID, if found in the Data Set.  
FreeElementValueFrees the memory for a value.  
GetAgeValueOverloaded. Gets an array of DicomAgeValue objects, that contain age information stored in the Value Field of the specified element.  
GetBinaryValueOverloaded. Updates a buffer with the binary value of the specified data element.  
GetByteValueOverloaded. Gets an array of byte values that is stored in the Value Field of the specified element.  
GetByteValuePtrOverloaded. Returns a pointer to a byte value that is stored in the Value Field of the specified element.  
GetChildElementReturns the item in the Data Set that is the first child of the specified item.  
GetChildKeyReturns the item in the Dicom Dir Data Set that is the first child of the specified item.  
GetCompoundGraphicCountRetrieves the number of compound graphic annotation objects in a certain "Graphic Annotation Sequence" (0070,0001) item.  
GetCompoundGraphicElementGets the Compound Graphic Sequence item element of the specified graphic annotation object.  
GetCompoundGraphicInformationGets the attributes of the specified compound graphic annotation.  
GetCompoundGraphicMajorTickCountRetrieves number of items in the "Major Ticks Sequence" (0070,0287) of a compound graphic.  
GetCompoundGraphicPointCountRetrieves number of points that represents a compound graphic annotation object.  
GetConvertValueConverts the value of an element to a string.  
GetDateRangeValueGets a DicomDateRangeValue structure that contains date range information for the specified element.  
GetDateTimeValueOverloaded. Gets an array of DicomDateTimeValue objects, that contain date-time information stored in the Value Field of the specified element.  
GetDateValueOverloaded. Gets an array of DicomDateValue objects, that contains date information stored in the Value Field of the specified element.  
GetDoubleValueOverloaded. Returns an array of double values, stored in the Value Field, of the specified element.  
GetDoubleValueExtOverloaded. Returns an array of numeric values that are stored in the Value Field of the specified element.  
GetDoubleValuePtrOverloaded. Returns a pointer to a double value, stored in the Value Field, of the specified element.  
GetElementLevelReturns a value that indicates the level at which the specified element is located within the Data Set.  
GetElementValueCountGets the number of values stored in the Value Field of the specified element.  
GetEncapsulatedDocumentOverloaded. Retrieves an encapsulated document and corresponding DICOM elements from a DICOM data set and output the results to a disk file.  
GetFirstElementReturns the first item in the Data Set.  
GetFirstKeyReturns the first item in the Dicom Dir Data Set.  
GetFloatValueOverloaded. Returns an array of float values that are stored in the Value Field of the specified element.  
GetFloatValuePtrOverloaded. Gets a pointer to a float value that is stored in the Value Field of the specified element.  
GetGraphicObjectCountRetrieves the number of graphical annotation objects in a certain "Graphic Annotation Sequence" (0070,0001) item.  
GetGraphicObjectInformationGets the attributes of the specified graphic annotation object.  
GetGraphicObjElementGets the item element of the specified graphic annotation object.  
GetGraphicObjPointCountRetrieves number of points that represents a graphical annotation object.  
GetImageOverloaded. Gets the image of a Pixel Data element.  
GetImageCountGets the number of frames in a Pixel Data element.  
GetImageInformationRetrieves information about the specified image.  
GetImagesOverloaded. Gets the images of a Pixel Data element.  
GetIntValueOverloaded. Returns an array of integer values, stored in the Value Field, of the specified element.  
GetIntValuePtrOverloaded. Returns a pointer to a long value, stored in the Value Field, of the specified data element.  
GetKeyValueGets the key element type of the specified key element.  
GetKeyValuePtrGets the key element type of the specified key element.  
GetKeyValueStringGets the key element type of the specified key element.  
GetLastElementReturns the last item in the Data Set.  
GetLastKeyReturns the last item in the Dicom Dir Data Set.  
GetLayerElementByIndexGets the item element of the specified graphic layer.  
GetLayerElementByNameGets the item element of the specified graphic layer.  
GetLayerGraphicObjectCountRetrieves the number of graphical annotation objects, which correspond to the specified item under the "Graphic Annotation Sequence" (0070,0001).  
GetLayerImageReferenceCountRetrieves the number of referenced images, which correspond to the specified item under the "Graphic Annotation Sequence" (0070,0001).  
GetLayerImageReferenceElementGets the item element of the specified SOP instance under the "Referenced Image Sequence" (0008,1140) in the specified "Graphic Annotation Sequence" (0070,0001) item.  
GetLayerImageReferenceSOPInstanceRetrieves 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".  
GetLayerIndexRetrieves the index of the layer with the specified name.  
GetLayerInformationRetrieves the attributes of a layer at the specified index.  
GetLayerNameRetrieves the value of the "Graphic Layer" element under one of the items under the "Graphic Annotation Sequence" in the "Graphic Annotation Module".  
GetLayerTextObjectCountRetrieves number of text annotation objects, which correspond to the specified item under the "Graphic Annotation Sequence" (0070,0001).  
GetLongValueOverloaded. Gets a pointer to a Int64 value that is stored in the Value Field of the specified element.  
GetMacAlgorithmReturns the Message Authentication Code (MAC) Algorithm (0400,0015) used in the creation of the specified Digital Signature.  
GetMacTransferSyntaxReturns the Message Authentication Code (MAC) Calculation Transfer Syntax UID (0400,0010) used in the creation of the specified Digital Signature.  
GetModalityLutAttributesOverloaded. Retrieves the attributes that describe the Modality LUT.  
GetModalityLutDataRetrieves "LUT Data" for a "Modality LUT Sequence".  
GetNextElementReturns the item in the Data Set that immediately follows the specified item.  
GetNextKeyReturns the item in the Dicom Dir Data Set that immediately follows the specified item.  
GetNextUnusedPrivateTagReturns the next available unused tag reserved by the Private Creator Data Element.  
GetNextUnusedPrivateTagReturns the next available unused tag reserved by the Private Creator Data Element.  
GetOverlayActivationLayerRetrieves the "Overlay Activation Layer".  
GetOverlayAttributesRetrieves the attributes of the overlay at the specified index.  
GetOverlayGroupNumberGets the overlay group number.  
GetOverlayImageRetrieves the "Overlay Data" (60xx,3000) for the specified overlay index.  
GetOverlayImagesOverloaded. Loads the image(s) with frames from the "Overlay Data" (60xx, 3000) element.  
GetPaletteColorLutAttributesRetrieves the attributes that describe the "Palette Color Lookup Table".  
GetPaletteColorLutDataRetrieves red, green or blue "Palette Color Lookup Table Data".  
GetParentElementReturns the item in the Data Set that is the parent of the specified item.  
GetParentKeyReturns the item in the Dicom Dir Data Set that contains the parent of the specified item.  
GetPreambleOverloaded. Gets the contents of the file's preamble.  
GetPresentationStateImageReferenceRetrieves the item element, which represents a referenced image (SOP Instance) under the "Referenced Image Sequence" in the "Presentation State Module".  
GetPresentationStateImageReferenceCountRetrieves number of images (SOP Instances) that are referenced in an item under the "Referenced Series Sequence" (0008,1115) in the "Presentation State Module".  
GetPresentationStateImageReferenceSOPInstanceRetrieves the SOP Instance UID for a referenced image (SOP Instance) under the "Referenced Image Sequence" in the "Presentation State Module".  
GetPresentationStateInformationRetrieves the attributes of the "Presentation State Module".  
GetPreviousElementReturns the item in the Data Set that immediately precedes the specified item.  
GetPreviousKeyReturns the item in the Dicom Dir Data Set that immediately precedes the specified item.  
GetRootElementReturns the root element of the specified item.  
GetRootKeyReturns the root of the specified item.  
GetShortValueOverloaded. Returns an array of short values, stored in the Value Field, of the specified element.  
GetShortValuePtrOverloaded. Returns a pointer to a short value, stored in the Value Field, of the specified element.  
GetSignatureReturns the Digital Signatures Sequence Item that corresponds to the Digital Signature at the specified index.  
GetSignatureDateTimeReturns the Digital Signature DateTime (0400,0105) of the specified Digital Signature.  
GetSignaturesCountReturns the number of Digital Signatures in the main Data Set or in an item of a sequence of items.  
GetSignatureUIDReturns the Digital Signature UID (0400,0100) of the specified Digital Signature.  
GetSignedElementReturns the signed Data Element at the specified index.  
GetSignedElementsCountReturns the number of Data Elements covered by the specified Digital Signature.  
GetStringValueGets a string value that is stored in the Value Field of the specified element.  
GetStringValuePtrGets a pointer to a string value that is stored in the Value Field of the specified element.  
GetTextObjectCountRetrieves the number of text annotation objects in the specified "Graphic Annotation Sequence" (0070,0001) item.  
GetTextObjectInformationGets the attributes of a text annotation object.  
GetTextObjElementGets the item element of the specified text annotation object.  
GetTimeRangeValueGets a DicomTimeRangeValue structure that contains time range information for the specified element.  
GetTimeValueOverloaded. Gets an array of DicomTimeValue objects, that contain time information stored in the Value Field of the specified element.  
GetValueOverloaded. Returns the value of a DICOM element  
GetVoiLutRetrieves the attributes that describe the VOI LUT.  
GetVoiLutDataRetrieves "LUT Data" for an item under "VOI LUT Sequence".  
GetWaveformGroupGets a waveform group from the dataset.  
GetWindowOverloaded. Retrieves the attributes that describe the "Window Center" and "Window Width".  
GetWindowCountGets the number of values under the window center element.  
InitializeOverloaded. Creates the Data Set object, inserting the appropriate elements for the specified class.  
InitializeCommandSetCreates the Command Set and inserts the elements for the specified command.  
InsertElementInserts a new element in the Data Set.  
InsertElementAndSetValueOverloaded. Finds or inserts (if not found) an element in the data set and sets the value of the element  
InsertImageInserts an image in a Pixel Data element.  
InsertImagesInserts image(s) in a Pixel Data element.  
InsertKeyOverloaded. Inserts a new key element in the Dicom Dir Data Set.  
InsertModuleInserts a new module in the Data Set.  
IsOverlayInDataSetDetermines whether the overlay data exists inside this Data Set or inside another Data Set.  
IsVolatileElementDetermines whether the specified element is volatile.  
LoadOverloaded. Loads a Data Set from a disk file, stream or buffer.  
LoadAsyncOverloaded. Loads a Data Set from a disk file.  
loadAsyncLoads a file from an ILeadStream asynchronously.  
RemoveAllCompoundGraphicsRemoves all compound graphic annotation objects under the specified "Graphic Annotation Sequence" (0070,0001) item.  
RemoveAllGraphicObjectsRemoves all graphical annotation objects under the specified "Graphic Annotation Sequence" (0070,0001) item.  
RemoveAllImageReferencesRemoves all the referenced images from the "Referenced Image Sequence" in all Graphic Annotation Sequence items.  
RemoveAllImageReferencesFromLayerRemoves all the referenced images from the "Referenced Image Sequence" in the specified "Graphic Annotation Sequence" item.  
RemoveAllLayersRemoves all layers under the "Graphic Layer Module".  
RemoveAllPresentationStateImageReferencesRemoves all "Referenced Image Sequence(s)", which belong to the "Referenced Series Sequence" under the "Presentation State Module".  
RemoveAllTextObjectsRemoves all text annotation objects under the specified "Graphic Annotation Sequence" (0070,0001) item.  
RemoveCompoundGraphicRemoves the compound graphic annotation at the specified index.  
RemoveGraphicObjectRemoves the graphic annotation object at the specified index.  
RemoveImageReferenceFromLayerRemoves a referenced image from the "Referenced Image Sequence" in the specified "Graphic Annotation Sequence" item.  
RemoveLayerByIndexDeletes all the elements that describe a layer.  
RemoveLayerByNameDeletes all the elements that describe a layer.  
RemoveLayerGraphicObjectsRemoves all graphical annotation objects, which correspond to the specified item under the "Graphic Annotation Sequence" (0070,0001) in the "Graphic Annotation Module".  
RemoveLayerTextObjectsRemoves all text annotation objects, which correspond to the specified item under the "Graphic Annotation Sequence" (0070,0001) in the "Graphic Annotation Module".  
RemovePresentationStateImageReferenceRemoves an item from the "Referenced Image Sequence" under the "Presentation State Module".  
RemoveTextObjectRemoves the text annotation object at the specified index.  
RemoveType3EmptyElementsDeletes type 3 empty elements from the dataset  
ResetRemoves all items from the Data Set.  
SaveOverloaded. Saves a Data Set to a disk file or stream.  
SaveAsyncOverloaded. Saves the Data Set to a stream.  
saveAsyncSaves the Data Set to a stream.  
SaveCertificateSaves the signer's digital certificate associated with the specified Digital Signature to a file.  
SetAgeValueSets the Age values of a Data Element.  
SetBinaryValueOverloaded. Sets the binary value of an element.  
SetByteValueOverloaded. Sets the character value(s) of a Data Element.  
SetCompoundGraphicInformationUpdates the attributes of a compound graphic.  
SetConvertValueOverloaded. Converts a string and sets the value of an element.  
SetConvertValuePtrOverloaded. Converts a string and sets the value of an element.  
SetDateRangeValueSets the Date range values of a Data Element.  
SetDateTimeValueOverloaded. Sets the Date-Time values of a Data Element.  
SetDateValueOverloaded. Sets the Date values of a Data Element.  
SetDoubleValueOverloaded. Sets the double value(s) of a Data Element.  
SetDoubleValueExtSets the double values, or any other numeric value representation of a Data Element.  
SetEncapsulatedDocumentOverloaded. Inserts an encapsulated document and corresponding DICOM elements into a DICOM data set in a disk file.  
SetFloatValueOverloaded. Sets the float value(s) of a Data Element.  
SetGraphicObjectInformationUpdates the attributes of a graphic annotation object.  
SetImageReplaces the image(s) in a Pixel Data element.  
SetImagesReplaces the images in a Pixel Data element.  
SetIntValueOverloaded. Sets the integer value(s) of a Data Element.  
SetLayerInformationSets layer attributes for the layer at the specified index.  
SetLayerNameSets the value of the "Graphic Layer" element under one of the items under the "Graphic Annotation Sequence" in the "Graphic Annotation Module".  
SetLongValueOverloaded. Sets the integer value(s) or short value(s) of a Data Element.  
SetModalityLutOverloaded. Sets the attributes that describe the Modality LUT.  
SetOverlayAttributesSets overlay attributes for a certain index.  
SetOverlayImageSets the "Overlay Data" (60xx,3000) for a certain overlay index.  
SetOverlayImagesSets the "Overlay Data" (60xx,3000) for the specified overlay index.  
SetPaletteColorLutAttributesSets the attributes that describe the "Palette Color Lookup Table".  
SetPaletteColorLutDataSets red, green or blue "Palette Color Lookup Table" data.  
SetPreambleOverloaded. Sets the contents of the file's preamble.  
SetPresentationStateInformationSets the attributes of the "Presentation State Module".  
SetShortValueOverloaded. Sets the short value(s) of a Data Element.  
SetStringValueOverloaded. Sets the string value(s) of a Data Element.  
SetStringValuePtrOverloaded. Sets the string value(s) of a Data Element.  
SetTextObjectInformationUpdates the attributes of a text annotation object.  
SetTimeRangeValueSets the Time range values of a Data Element.  
SetTimeValueOverloaded. Sets the Time value of a Data Element.  
SetValueSets the value(s) of a Data Element. The value can be any supported type.  
SetVoiLutSets the attributes that describe the VOI LUT.  
SetWindowOverloaded. Sets the attributes that describe the "Window Center" and "Window Width".  
TestConformanceVerifies the conformance of the Data Set.  
VerifySignatureVerifies Digital Signatures in the Data Set.  
Top
Protected Methods
 NameDescription
FinalizeThis member overrides Finalize.  
Top
See Also

Reference

DicomDataSet Class
Leadtools.Dicom Namespace
DicomEngine Class

Error processing SSI file
Leadtools.Dicom requires a Medical toolkit server license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features