C# Class Dicom.Data.DcmDataset

Show file Open project: fo-dicom/mdcm Class Usage Examples

Public Methods

Method	Description
AddElement ( Dicom.Data.DicomTag tag ) : bool
AddElement ( Dicom.Data.DicomTag tag, DicomVR vr ) : bool
AddElementWithObjectValue ( Dicom.Data.DicomTag tag, object value ) : bool
AddElementWithValue ( Dicom.Data.DicomTag tag, System.DateTime value ) : bool
AddElementWithValue ( Dicom.Data.DicomTag tag, Dicom.Data.DicomTag value ) : bool
AddElementWithValue ( Dicom.Data.DicomTag tag, DicomUID value ) : bool
AddElementWithValue ( Dicom.Data.DicomTag tag, decimal value ) : bool
AddElementWithValue ( Dicom.Data.DicomTag tag, double value ) : bool
AddElementWithValue ( Dicom.Data.DicomTag tag, int value ) : bool
AddElementWithValue ( Dicom.Data.DicomTag tag, string value ) : bool
AddElementWithValue ( Dicom.Data.DicomTag tag, ushort value ) : bool
AddElementWithValueString ( Dicom.Data.DicomTag tag, string value ) : bool
AddItem ( DcmItem item ) : void
AddReferenceSequenceItem ( Dicom.Data.DicomTag tag, DicomUID classUid, DicomUID instUid ) : void
CalculateGroupWriteLength ( ushort group, DicomTransferSyntax syntax, DicomWriteOptions options ) : uint
CalculateWriteLength ( DicomTransferSyntax syntax, DicomWriteOptions options ) : uint
ChangeTransferSyntax ( DicomTransferSyntax newTransferSyntax, DcmCodecParameters parameters ) : void
Clone ( ) : DcmDataset
ComputePixelDataMD5 ( ) : string
Contains ( Dicom.Data.DicomTag tag ) : bool
CreateOriginalAttributesSequence ( string originalAttributesSource, string modifyingSystem, string reasonForModification, IEnumerable tagsToModify ) : void	Original Attributes Sequence (0400,0561) Sequence of Items containing all attributes that were removed or replaced by other values in the main dataset. One or more Items may be permitted in this sequence.
DcmDataset ( ) : System
DcmDataset ( DicomTransferSyntax transferSyntax ) : System
DcmDataset ( long streamPosition, uint lengthInStream ) : System
DcmDataset ( long streamPosition, uint lengthInStream, DicomTransferSyntax transferSyntax ) : System
Dump ( ) : string
Dump ( StringBuilder sb, String prefix, DicomDumpOptions options ) : void
GetAE ( Dicom.Data.DicomTag tag ) : DcmApplicationEntity
GetAS ( Dicom.Data.DicomTag tag ) : DcmAgeString
GetAT ( Dicom.Data.DicomTag tag ) : DcmAttributeTag
GetCS ( Dicom.Data.DicomTag tag ) : DcmCodeString
GetDA ( Dicom.Data.DicomTag tag ) : DcmDate
GetDS ( Dicom.Data.DicomTag tag ) : DcmDecimalString
GetDT ( Dicom.Data.DicomTag tag ) : DcmDateTime
GetDateTime ( Dicom.Data.DicomTag tag, System.DateTime deflt ) : System.DateTime
GetDateTime ( Dicom.Data.DicomTag dtag, Dicom.Data.DicomTag ttag, System.DateTime deflt ) : System.DateTime
GetDateTime ( Dicom.Data.DicomTag tag, int index, System.DateTime deflt ) : System.DateTime
GetDcmTag ( Dicom.Data.DicomTag tag ) : Dicom.Data.DicomTag
GetDecimal ( Dicom.Data.DicomTag tag, decimal deflt ) : decimal
GetDouble ( Dicom.Data.DicomTag tag, double deflt ) : double
GetElement ( Dicom.Data.DicomTag tag ) : DcmElement
GetFD ( Dicom.Data.DicomTag tag ) : DcmFloatingPointDouble
GetFL ( Dicom.Data.DicomTag tag ) : DcmFloatingPointSingle
GetFloat ( Dicom.Data.DicomTag tag, float deflt ) : float
GetIS ( Dicom.Data.DicomTag tag ) : DcmIntegerString
GetInt16 ( Dicom.Data.DicomTag tag, short deflt ) : short
GetInt32 ( Dicom.Data.DicomTag tag, int deflt ) : int
GetItem ( Dicom.Data.DicomTag tag ) : DcmItem
GetLO ( Dicom.Data.DicomTag tag ) : DcmLongString
GetLT ( Dicom.Data.DicomTag tag ) : DcmLongText
GetMaskedTags ( Dicom.Data.DicomTagMask mask ) : IEnumerable
GetOB ( Dicom.Data.DicomTag tag ) : DcmOtherByte
GetOF ( Dicom.Data.DicomTag tag ) : DcmOtherFloat
GetOW ( Dicom.Data.DicomTag tag ) : DcmOtherWord
GetPN ( Dicom.Data.DicomTag tag ) : DcmPersonName
GetSH ( Dicom.Data.DicomTag tag ) : DcmShortString
GetSL ( Dicom.Data.DicomTag tag ) : DcmSignedLong
GetSQ ( Dicom.Data.DicomTag tag ) : DcmItemSequence
GetSS ( Dicom.Data.DicomTag tag ) : DcmSignedShort
GetST ( Dicom.Data.DicomTag tag ) : DcmShortText
GetString ( Dicom.Data.DicomTag tag, int index, string deflt ) : string
GetString ( Dicom.Data.DicomTag tag, string deflt ) : string
GetStringArray ( Dicom.Data.DicomTag tag, string deflt ) : string[]
GetTM ( Dicom.Data.DicomTag tag ) : DcmTime
GetUI ( Dicom.Data.DicomTag tag ) : DcmUniqueIdentifier
GetUID ( Dicom.Data.DicomTag tag ) : DicomUID
GetUInt16 ( Dicom.Data.DicomTag tag, ushort deflt ) : ushort
GetUL ( Dicom.Data.DicomTag tag ) : DcmUnsignedLong
GetUN ( Dicom.Data.DicomTag tag ) : DcmUnknown
GetUS ( Dicom.Data.DicomTag tag ) : DcmUnsignedShort
GetUT ( Dicom.Data.DicomTag tag ) : DcmUnlimitedText
GetVR ( Dicom.Data.DicomTag tag ) : DicomVR
GetValueString ( Dicom.Data.DicomTag tag ) : string
LoadDicomFields ( object obj ) : void
Merge ( DcmDataset dataset ) : void
PreloadDeferredBuffers ( ) : void
Recurse ( ) : IEnumerable	Recursively enumerates all value elements.
Remove ( Dicom.Data.DicomTag tag ) : void
Remove ( Dicom.Data.DicomTagMask mask ) : void
ReplaceAll ( Dicom.Data.DicomTag tag, object value ) : void	Recursively replaces tags with the specified value.
ReplaceUID ( Dicom.Data.DicomTag tag, DicomUID uid ) : void	Replaces UID for specified tag and all instances of UID in UI elements.
SaveDicomFields ( object obj ) : void
Search ( Dicom.Data.DicomTag tag ) : IEnumerable	Performs a recursive search for the specified tag. This function returns value elements only.
SetDateTime ( Dicom.Data.DicomTag dtag, Dicom.Data.DicomTag ttag, System.DateTime value ) : void
SetString ( Dicom.Data.DicomTag tag, string value ) : void
SetStringArray ( Dicom.Data.DicomTag tag, string values ) : void
UnloadDeferredBuffers ( ) : void

Private Methods

Method	Description
GetDefaultValue ( Type vtype, DicomFieldDefault deflt ) : object
LoadDicomFieldValue ( DcmElement elem, Type vtype, DicomFieldDefault deflt, bool udzl ) : object
SaveDicomFieldValue ( Dicom.Data.DicomTag tag, object value, bool createEmpty ) : void
SelectByteOrder ( Endian endian ) : void
SetInternalTransferSyntax ( DicomTransferSyntax ts ) : void

Method Details

AddElement() public method

public AddElement ( Dicom.Data.DicomTag tag ) : bool
tag	Dicom.Data.DicomTag
return	bool

AddElement() public method

public AddElement ( Dicom.Data.DicomTag tag, DicomVR vr ) : bool
tag	Dicom.Data.DicomTag
vr	DicomVR
return	bool

AddElementWithObjectValue() public method

public AddElementWithObjectValue ( Dicom.Data.DicomTag tag, object value ) : bool
tag	Dicom.Data.DicomTag
value	object
return	bool

AddElementWithValue() public method

public AddElementWithValue ( Dicom.Data.DicomTag tag, System.DateTime value ) : bool
tag	Dicom.Data.DicomTag
value	System.DateTime
return	bool

AddElementWithValue() public method

public AddElementWithValue ( Dicom.Data.DicomTag tag, Dicom.Data.DicomTag value ) : bool
tag	Dicom.Data.DicomTag
value	Dicom.Data.DicomTag
return	bool

AddElementWithValue() public method

public AddElementWithValue ( Dicom.Data.DicomTag tag, DicomUID value ) : bool
tag	Dicom.Data.DicomTag
value	DicomUID
return	bool

AddElementWithValue() public method

public AddElementWithValue ( Dicom.Data.DicomTag tag, decimal value ) : bool
tag	Dicom.Data.DicomTag
value	decimal
return	bool

AddElementWithValue() public method

public AddElementWithValue ( Dicom.Data.DicomTag tag, double value ) : bool
tag	Dicom.Data.DicomTag
value	double
return	bool

AddElementWithValue() public method

public AddElementWithValue ( Dicom.Data.DicomTag tag, int value ) : bool
tag	Dicom.Data.DicomTag
value	int
return	bool

AddElementWithValue() public method

public AddElementWithValue ( Dicom.Data.DicomTag tag, string value ) : bool
tag	Dicom.Data.DicomTag
value	string
return	bool

AddElementWithValue() public method

public AddElementWithValue ( Dicom.Data.DicomTag tag, ushort value ) : bool
tag	Dicom.Data.DicomTag
value	ushort
return	bool

AddElementWithValueString() public method

public AddElementWithValueString ( Dicom.Data.DicomTag tag, string value ) : bool
tag	Dicom.Data.DicomTag
value	string
return	bool

AddItem() public method

public AddItem ( DcmItem item ) : void
item	DcmItem
return	void

AddReferenceSequenceItem() public method

public AddReferenceSequenceItem ( Dicom.Data.DicomTag tag, DicomUID classUid, DicomUID instUid ) : void
tag	Dicom.Data.DicomTag
classUid	DicomUID
instUid	DicomUID
return	void

CalculateGroupWriteLength() public method

public CalculateGroupWriteLength ( ushort group, DicomTransferSyntax syntax, DicomWriteOptions options ) : uint
group	ushort
syntax	DicomTransferSyntax
options	DicomWriteOptions
return	uint

CalculateWriteLength() public method

public CalculateWriteLength ( DicomTransferSyntax syntax, DicomWriteOptions options ) : uint
syntax	DicomTransferSyntax
options	DicomWriteOptions
return	uint

ChangeTransferSyntax() public method

public ChangeTransferSyntax ( DicomTransferSyntax newTransferSyntax, DcmCodecParameters parameters ) : void
newTransferSyntax	DicomTransferSyntax
parameters	DcmCodecParameters
return	void

Clone() public method

public Clone ( ) : DcmDataset
return	DcmDataset

ComputePixelDataMD5() public method

public ComputePixelDataMD5 ( ) : string
return	string

Contains() public method

public Contains ( Dicom.Data.DicomTag tag ) : bool
tag	Dicom.Data.DicomTag
return	bool

CreateOriginalAttributesSequence() public method

Original Attributes Sequence (0400,0561) Sequence of Items containing all attributes that were removed or replaced by other values in the main dataset. One or more Items may be permitted in this sequence.

public CreateOriginalAttributesSequence ( string originalAttributesSource, string modifyingSystem, string reasonForModification, IEnumerable tagsToModify ) : void
originalAttributesSource	string	/// Source of Previous Values (0400,0564) /// The source that provided the SOP Instance prior to the /// removal or replacement of the values. For example, this /// might be the Institution from which imported SOP Instances /// were received. ///
modifyingSystem	string	/// Modifying System (0400,0563) /// Identification of the system which removed and/or replaced /// the attributes. ///
reasonForModification	string	/// Reason for the Attribute Modification (0400,0565) /// Reason for the attribute modification. Defined terms are: /// COERCE = Replace values of attributes such as Patient /// Name, ID, Accession Number, for example, during import /// of media from an external institution, or reconciliation /// against a master patient index. /// CORRECT = Replace incorrect values, such as Patient /// Name or ID, for example, when incorrect worklist item /// was chosen or operator input error. ///
tagsToModify	IEnumerable	/// Tags from this dataset to be removed or modified. ///
return	void

DcmDataset() public method

public DcmDataset ( ) : System
return	System

DcmDataset() public method

public DcmDataset ( DicomTransferSyntax transferSyntax ) : System
transferSyntax	DicomTransferSyntax
return	System

DcmDataset() public method

public DcmDataset ( long streamPosition, uint lengthInStream ) : System
streamPosition	long
lengthInStream	uint
return	System

DcmDataset() public method

public DcmDataset ( long streamPosition, uint lengthInStream, DicomTransferSyntax transferSyntax ) : System
streamPosition	long
lengthInStream	uint
transferSyntax	DicomTransferSyntax
return	System

Dump() public method

public Dump ( ) : string
return	string

Dump() public method

public Dump ( StringBuilder sb, String prefix, DicomDumpOptions options ) : void
sb	StringBuilder
prefix	String
options	DicomDumpOptions
return	void

GetAE() public method

public GetAE ( Dicom.Data.DicomTag tag ) : DcmApplicationEntity
tag	Dicom.Data.DicomTag
return	DcmApplicationEntity

GetAS() public method

public GetAS ( Dicom.Data.DicomTag tag ) : DcmAgeString
tag	Dicom.Data.DicomTag
return	DcmAgeString

GetAT() public method

public GetAT ( Dicom.Data.DicomTag tag ) : DcmAttributeTag
tag	Dicom.Data.DicomTag
return	DcmAttributeTag

GetCS() public method

public GetCS ( Dicom.Data.DicomTag tag ) : DcmCodeString
tag	Dicom.Data.DicomTag
return	DcmCodeString

GetDA() public method

public GetDA ( Dicom.Data.DicomTag tag ) : DcmDate
tag	Dicom.Data.DicomTag
return	DcmDate

GetDS() public method

public GetDS ( Dicom.Data.DicomTag tag ) : DcmDecimalString
tag	Dicom.Data.DicomTag
return	DcmDecimalString

GetDT() public method

public GetDT ( Dicom.Data.DicomTag tag ) : DcmDateTime
tag	Dicom.Data.DicomTag
return	DcmDateTime

GetDateTime() public method

public GetDateTime ( Dicom.Data.DicomTag tag, System.DateTime deflt ) : System.DateTime
tag	Dicom.Data.DicomTag
deflt	System.DateTime
return	System.DateTime

GetDateTime() public method

public GetDateTime ( Dicom.Data.DicomTag dtag, Dicom.Data.DicomTag ttag, System.DateTime deflt ) : System.DateTime
dtag	Dicom.Data.DicomTag
ttag	Dicom.Data.DicomTag
deflt	System.DateTime
return	System.DateTime

GetDateTime() public method

public GetDateTime ( Dicom.Data.DicomTag tag, int index, System.DateTime deflt ) : System.DateTime
tag	Dicom.Data.DicomTag
index	int
deflt	System.DateTime
return	System.DateTime

GetDcmTag() public method

public GetDcmTag ( Dicom.Data.DicomTag tag ) : Dicom.Data.DicomTag
tag	Dicom.Data.DicomTag
return	Dicom.Data.DicomTag

GetDecimal() public method

public GetDecimal ( Dicom.Data.DicomTag tag, decimal deflt ) : decimal
tag	Dicom.Data.DicomTag
deflt	decimal
return	decimal

GetDouble() public method

public GetDouble ( Dicom.Data.DicomTag tag, double deflt ) : double
tag	Dicom.Data.DicomTag
deflt	double
return	double

GetElement() public method

public GetElement ( Dicom.Data.DicomTag tag ) : DcmElement
tag	Dicom.Data.DicomTag
return	DcmElement

GetFD() public method

public GetFD ( Dicom.Data.DicomTag tag ) : DcmFloatingPointDouble
tag	Dicom.Data.DicomTag
return	DcmFloatingPointDouble

GetFL() public method

public GetFL ( Dicom.Data.DicomTag tag ) : DcmFloatingPointSingle
tag	Dicom.Data.DicomTag
return	DcmFloatingPointSingle

GetFloat() public method

public GetFloat ( Dicom.Data.DicomTag tag, float deflt ) : float
tag	Dicom.Data.DicomTag
deflt	float
return	float

GetIS() public method

public GetIS ( Dicom.Data.DicomTag tag ) : DcmIntegerString
tag	Dicom.Data.DicomTag
return	DcmIntegerString

GetInt16() public method

public GetInt16 ( Dicom.Data.DicomTag tag, short deflt ) : short
tag	Dicom.Data.DicomTag
deflt	short
return	short

GetInt32() public method

public GetInt32 ( Dicom.Data.DicomTag tag, int deflt ) : int
tag	Dicom.Data.DicomTag
deflt	int
return	int

GetItem() public method

public GetItem ( Dicom.Data.DicomTag tag ) : DcmItem
tag	Dicom.Data.DicomTag
return	DcmItem

GetLO() public method

public GetLO ( Dicom.Data.DicomTag tag ) : DcmLongString
tag	Dicom.Data.DicomTag
return	DcmLongString

GetLT() public method

public GetLT ( Dicom.Data.DicomTag tag ) : DcmLongText
tag	Dicom.Data.DicomTag
return	DcmLongText

GetMaskedTags() public method

public GetMaskedTags ( Dicom.Data.DicomTagMask mask ) : IEnumerable
mask	Dicom.Data.DicomTagMask
return	IEnumerable

GetOB() public method

public GetOB ( Dicom.Data.DicomTag tag ) : DcmOtherByte
tag	Dicom.Data.DicomTag
return	DcmOtherByte

GetOF() public method

public GetOF ( Dicom.Data.DicomTag tag ) : DcmOtherFloat
tag	Dicom.Data.DicomTag
return	DcmOtherFloat

GetOW() public method

public GetOW ( Dicom.Data.DicomTag tag ) : DcmOtherWord
tag	Dicom.Data.DicomTag
return	DcmOtherWord

GetPN() public method

public GetPN ( Dicom.Data.DicomTag tag ) : DcmPersonName
tag	Dicom.Data.DicomTag
return	DcmPersonName

GetSH() public method

public GetSH ( Dicom.Data.DicomTag tag ) : DcmShortString
tag	Dicom.Data.DicomTag
return	DcmShortString

GetSL() public method

public GetSL ( Dicom.Data.DicomTag tag ) : DcmSignedLong
tag	Dicom.Data.DicomTag
return	DcmSignedLong

GetSQ() public method

public GetSQ ( Dicom.Data.DicomTag tag ) : DcmItemSequence
tag	Dicom.Data.DicomTag
return	DcmItemSequence

GetSS() public method

public GetSS ( Dicom.Data.DicomTag tag ) : DcmSignedShort
tag	Dicom.Data.DicomTag
return	DcmSignedShort

GetST() public method

public GetST ( Dicom.Data.DicomTag tag ) : DcmShortText
tag	Dicom.Data.DicomTag
return	DcmShortText

GetString() public method

public GetString ( Dicom.Data.DicomTag tag, int index, string deflt ) : string
tag	Dicom.Data.DicomTag
index	int
deflt	string
return	string

GetString() public method

public GetString ( Dicom.Data.DicomTag tag, string deflt ) : string
tag	Dicom.Data.DicomTag
deflt	string
return	string

GetStringArray() public method

public GetStringArray ( Dicom.Data.DicomTag tag, string deflt ) : string[]
tag	Dicom.Data.DicomTag
deflt	string
return	string[]

GetTM() public method

public GetTM ( Dicom.Data.DicomTag tag ) : DcmTime
tag	Dicom.Data.DicomTag
return	DcmTime

GetUI() public method

public GetUI ( Dicom.Data.DicomTag tag ) : DcmUniqueIdentifier
tag	Dicom.Data.DicomTag
return	DcmUniqueIdentifier

GetUID() public method

public GetUID ( Dicom.Data.DicomTag tag ) : DicomUID
tag	Dicom.Data.DicomTag
return	DicomUID

GetUInt16() public method

public GetUInt16 ( Dicom.Data.DicomTag tag, ushort deflt ) : ushort
tag	Dicom.Data.DicomTag
deflt	ushort
return	ushort

GetUL() public method

public GetUL ( Dicom.Data.DicomTag tag ) : DcmUnsignedLong
tag	Dicom.Data.DicomTag
return	DcmUnsignedLong

GetUN() public method

public GetUN ( Dicom.Data.DicomTag tag ) : DcmUnknown
tag	Dicom.Data.DicomTag
return	DcmUnknown

GetUS() public method

public GetUS ( Dicom.Data.DicomTag tag ) : DcmUnsignedShort
tag	Dicom.Data.DicomTag
return	DcmUnsignedShort

GetUT() public method

public GetUT ( Dicom.Data.DicomTag tag ) : DcmUnlimitedText
tag	Dicom.Data.DicomTag
return	DcmUnlimitedText

GetVR() public method

public GetVR ( Dicom.Data.DicomTag tag ) : DicomVR
tag	Dicom.Data.DicomTag
return	DicomVR

GetValueString() public method

public GetValueString ( Dicom.Data.DicomTag tag ) : string
tag	Dicom.Data.DicomTag
return	string

LoadDicomFields() public method

public LoadDicomFields ( object obj ) : void
obj	object
return	void

Merge() public method

public Merge ( DcmDataset dataset ) : void
dataset	DcmDataset
return	void

PreloadDeferredBuffers() public method

public PreloadDeferredBuffers ( ) : void
return	void

Recurse() public method

Recursively enumerates all value elements.

public Recurse ( ) : IEnumerable
return	IEnumerable

Remove() public method

public Remove ( Dicom.Data.DicomTag tag ) : void
tag	Dicom.Data.DicomTag
return	void

Remove() public method

public Remove ( Dicom.Data.DicomTagMask mask ) : void
mask	Dicom.Data.DicomTagMask
return	void

ReplaceAll() public method

Recursively replaces tags with the specified value.

public ReplaceAll ( Dicom.Data.DicomTag tag, object value ) : void
tag	Dicom.Data.DicomTag	DICOM Tag
value	object	Value
return	void

ReplaceUID() public method

Replaces UID for specified tag and all instances of UID in UI elements.

public ReplaceUID ( Dicom.Data.DicomTag tag, DicomUID uid ) : void
tag	Dicom.Data.DicomTag
uid	DicomUID
return	void

SaveDicomFields() public method

public SaveDicomFields ( object obj ) : void
obj	object
return	void

Search() public method

Performs a recursive search for the specified tag. This function returns value elements only.

public Search ( Dicom.Data.DicomTag tag ) : IEnumerable
tag	Dicom.Data.DicomTag	DICOM Tag
return	IEnumerable

SetDateTime() public method

public SetDateTime ( Dicom.Data.DicomTag dtag, Dicom.Data.DicomTag ttag, System.DateTime value ) : void
dtag	Dicom.Data.DicomTag
ttag	Dicom.Data.DicomTag
value	System.DateTime
return	void

SetString() public method

public SetString ( Dicom.Data.DicomTag tag, string value ) : void
tag	Dicom.Data.DicomTag
value	string
return	void

SetStringArray() public method

public SetStringArray ( Dicom.Data.DicomTag tag, string values ) : void
tag	Dicom.Data.DicomTag
values	string
return	void

UnloadDeferredBuffers() public method

public UnloadDeferredBuffers ( ) : void
return	void