DicomDataSet Class Members
In This Topic
The following tables list the members exposed by DicomDataSet.
Public Constructors
Public Fields
| Name | Description |
 | CompressedFrameStream |
User-defined function to set output stream for compressed frame. This is suitable for writing out large compressed frames with Basic Offset Table.
|
Top
Public Properties
| Name | Description |
 | AccessionNumber | The Accession Number |
 | CacheMode |
Controls how the pixel data is cached
|
 | Children | Holds the hierarchical directory structure for DICOM directory files |
 | Command | The full command dataset received |
 | Count | Number of Attributes held in the DataSet |
 | DateOfBirth | Date of birth of the patient |
  | DefaultValidationTypes | The default DicomObjects.Enums.ValidationTypes to apply to newly created DicomDataSet objects |
 | Identifer |
Returns the underlying DataSet which contains the list of attributes to be
matched, as specified in the DICOM standard.
|
 | InstanceUID |
Unique identifier for the four levels of the DICOM Query/Retrieve
hierarchy
|
 | Item | Overloaded. Note: C# syntax for the "Item" property is wrongly represented in a VB.NET syntax. This is a bug in the help file generator, and will be corrected in a later version of our help file. |
 | Name | The Name of the patient |
 | OriginalTS | Returns the Transfer syntax with which the object was originally received or read. |
 | Overrides |
Image-specific list of unusual behaviours (e.g. to cope with faulty images)
|
 | OverrideTS |
A means to override an incorrect transfer syntax
|
 | PatientID | The Patient ID |
 | PixelsPerFrame |
The number of pixels per frame
|
 | RawPixels | Accesses the raw pixel data as an array |
 | SamplesPerFrame |
The number of samples per frame
|
 | SeriesDescription | Descriptions for the series |
 | SeriesUID |
Unique identifier for the four levels of the DICOM Query/Retrieve
hierarchy
|
 | Sex | Sex of the patient |
 | SOPClass | SOP class of the DicomDataSet. |
 | StudyDescription | Description for the study |
 | StudyUID |
Unique identifier for the four levels of the DICOM Query/Retrieve
hierarchy
|
 | Tag | A general purpose Tag for developer use |
 | UncompressedPI |
Gets the Photometric Interpretation of the uncompressed Image data.
|
 | ValidationDataSet |
Assign a Validation DataSet to this property would override the DataSet's
Validation scheme. This is mainly used for validation of CharacterSet.
|
 | ValidationTypes | Gets or sets the current validation type. |
Top
Public Methods
| Name | Description |
 | Add | Overloaded. Creates and adds data elements to DicomDataSet |
 | AddByReference | Overloaded.
Add byte[] as attribute value to avoid copying large data
|
 | AddPixelData | Adds pixel data to DicomDataSet |
 | AddToDirectory | Overloaded. Simplified DICOMDIR creation |
 | ChangeCharacterSet |
Change the specific Character Set of a DICOM dataset. All applicable attributes will have its data re-encoded by
the new character set
|
 | ChangeToDecompressed |
Simulate the effect of writing out as a Decompressed Image
|
 | Clear |
Clear the DicomDataSet data
|
 | Clone | Overloaded. Returns a copy of the DicomDataSet |
 | DecompressAll | Causes all the frames of an image to be decompressed. |
 | Dispose | Release the resources used by the DicomDataSet object |
 | FindAttribute |
Locate an attribute within either a top level dataset, or within one of the functional group macros
|
 | ForEachAttribute |
Recursively perform an action on every attribute within the dataset
|
 | FrameSubSet |
Generates a new DicomDataSet as a subset of the current instance as described in supplement 119
|
 | FunctionalGroupDataSet | Overloaded. Locate the required functional group within a DicomDataSet |
 | FunctionalGroupOrRootLevelAttribute | Overloaded. Return the required DicomAttribute within a specified functional group within a DicomDataSet If DicomAttribute is not present in the specified DicomDataSet, it searches amongst the root level attributes |
 | GetAllBulkData |
Load All Bulk data for attributes
|
 | GetAllURIBulkData |
Load Bulk data from URI, getting data from web calls
|
 | GetMinAndMax | Overloaded. Find the maximum and minimum pixel data values in the pixel data |
 | GetPixelStream |
Returns the raw pixel data as a Stream object for a specific frame
|
 | ImportPixelData |
Direct import of compressed pixel data
|
 | IsPresentationStateFor | Overloaded. Indicates if the PresentationState is for the specified DicomImage |
 | MergeBulkData |
Load Bulk data for all attributes, getting data from a method, based on the URI
|
 | Read | Overloaded. Reads from a standard Stream, with specific reading behaviour |
 | ReadJson |
Read DICOM data from a Json Stream
|
 | ReadURL |
Reads DataSet from Web Address
|
 | ReadXml |
Read DICOM data from an XML Stream
|
 | Remove | Overloaded. Removes an attribute from the DataSet |
 | RemovePrivateAttributes |
Remove private attributes
|
 | Send | Overloaded. Sends a DicomDataSet to a remote DICOM application |
 | SetDicomCodec |
Specify a "DICOM" codec
|
 | SetNonDicomCodec |
Specify a non-DICOM source (e.g. AVI) as a source of frame data
|
 | SetPlanarConfiguration | Sets the planar configuration in DicomDataSet |
 | SimplifyOverlays |
Decompress the data, and move any overlays which are encoded with the pixel data (a
method deprecated in DICOM many years ago) to stand-along overlay data in 60xx,3000.
|
 | Validate |
Validate all DicomAttributes within the DicomDataset
|
 | ValidateAll | [NEW] Validate all DicomAttributes within the DicomDataset based on the specified ValidationOptions. |
 | Value | Overloaded. Returns the value of the specified Data Element |
 | Write | Overloaded.
Writes the dataset to an external DICOM file, a system IO stream or a byte
array etc.
|
 | WriteJson |
Write the DICOM data into an Json Stream
|
 | WriteXml |
Write the DICOM data into an XML Stream
|
Top
See Also