Class DicomDictionary
Class for managing DICOM dictionaries.
Inheritance
System.Object
DicomDictionary
Implements
System.Collections.Generic.IEnumerable<DicomDictionaryEntry>
System.Collections.IEnumerable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: FellowOakDicom
Assembly: fo-dicom.core.dll
Syntax
public class DicomDictionary : IEnumerable<DicomDictionaryEntry>, IEnumerable
Constructors
DicomDictionary()
Declaration
public DicomDictionary()
Fields
PrivateCreatorTag
Declaration
public static readonly DicomDictionaryEntry PrivateCreatorTag
Field Value
Type | Description |
---|---|
DicomDictionaryEntry |
UnknownTag
Declaration
public static readonly DicomDictionaryEntry UnknownTag
Field Value
Type | Description |
---|---|
DicomDictionaryEntry |
Properties
Default
Declaration
public static DicomDictionary Default { get; set; }
Property Value
Type | Description |
---|---|
DicomDictionary |
Item[DicomPrivateCreator]
Declaration
public DicomDictionary this[DicomPrivateCreator creator] { get; }
Parameters
Type | Name | Description |
---|---|---|
DicomPrivateCreator | creator |
Property Value
Type | Description |
---|---|
DicomDictionary |
Item[DicomTag]
Declaration
public DicomDictionaryEntry this[DicomTag tag] { get; }
Parameters
Type | Name | Description |
---|---|---|
DicomTag | tag |
Property Value
Type | Description |
---|---|
DicomDictionaryEntry |
Item[String]
Gets the DIcomTag for a given keyword.
Declaration
public DicomTag this[string keyword] { get; }
Parameters
Type | Name | Description |
---|---|---|
System.String | keyword | The attribute keyword that we look for. |
Property Value
Type | Description |
---|---|
DicomTag | A matching DicomTag or null if none is found. |
PrivateCreator
Declaration
public DicomPrivateCreator PrivateCreator { get; }
Property Value
Type | Description |
---|---|
DicomPrivateCreator |
Methods
Add(DicomDictionaryEntry)
Declaration
public void Add(DicomDictionaryEntry entry)
Parameters
Type | Name | Description |
---|---|---|
DicomDictionaryEntry | entry |
EnsureDefaultDictionariesLoaded(Nullable<Boolean>)
Ensures the default DICOM dictionaries are loaded Safe to call multiple times but will throw an exception if inconsistent values for loadPrivateDictionary are provided over multiple calls
Declaration
public static DicomDictionary EnsureDefaultDictionariesLoaded(bool? loadPrivateDictionary = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Boolean> | loadPrivateDictionary | Leave null (default value) if unconcerned. Set true to search for resource streams named "Dicom.Dictionaries.Private Dictionary.xml.gz" in referenced assemblies |
Returns
Type | Description |
---|---|
DicomDictionary |
GetEnumerator()
Declaration
public IEnumerator<DicomDictionaryEntry> GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerator<DicomDictionaryEntry> |
GetPrivateCreator(String)
Declaration
public DicomPrivateCreator GetPrivateCreator(string creator)
Parameters
Type | Name | Description |
---|---|---|
System.String | creator |
Returns
Type | Description |
---|---|
DicomPrivateCreator |
Load(String, DicomDictionaryFormat)
Load DICOM dictionary data from file.
Declaration
public void Load(string file, DicomDictionaryFormat format)
Parameters
Type | Name | Description |
---|---|---|
System.String | file | File name. |
DicomDictionaryFormat | format | File format. |
Explicit Interface Implementations
IEnumerable.GetEnumerator()
Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.IEnumerator |
Implements
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable