Class DicomDictionary

Namespace

FellowOakDicom

Assembly

fo-dicom.core.dll

Class for managing DICOM dictionaries.

public class DicomDictionary : IEnumerable<DicomDictionaryEntry>, IEnumerable

Inheritance

object

DicomDictionary

Implements

IEnumerable<DicomDictionaryEntry>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

LinqExtensions.IsOneOf<T>(T, params T[])

EnumerableExtensions.Each<T>(IEnumerable<T>, Action<T>)

LinqExtensions.Diff<S, T>(IEnumerable<S>, Func<S, S, T>)

LinqExtensions.FilterByType<T>(IEnumerable<object>)

Constructors

DicomDictionary()

public DicomDictionary()

Fields

PrivateCreatorTag

public static readonly DicomDictionaryEntry PrivateCreatorTag

Field Value

DicomDictionaryEntry

UnknownTag

public static readonly DicomDictionaryEntry UnknownTag

Field Value

DicomDictionaryEntry

Properties

Default

public static DicomDictionary Default { get; set; }

Property Value

DicomDictionary

this[DicomPrivateCreator]

public DicomDictionary this[DicomPrivateCreator creator] { get; }

Parameters

creator DicomPrivateCreator

Property Value

DicomDictionary

this[DicomTag]

public DicomDictionaryEntry this[DicomTag tag] { get; }

Parameters

tag DicomTag

Property Value

DicomDictionaryEntry

this[string]

Gets the DIcomTag for a given keyword.

public DicomTag this[string keyword] { get; }

Parameters

keyword string

The attribute keyword that we look for.

Property Value

DicomTag

A matching DicomTag or null if none is found.

PrivateCreator

public DicomPrivateCreator PrivateCreator { get; }

Property Value

DicomPrivateCreator

Methods

Add(DicomDictionaryEntry)

public void Add(DicomDictionaryEntry entry)

Parameters

entry DicomDictionaryEntry

EnsureDefaultDictionariesLoaded(bool?)

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

public static DicomDictionary EnsureDefaultDictionariesLoaded(bool? loadPrivateDictionary = null)

Parameters

loadPrivateDictionary bool?

Leave null (default value) if unconcerned. Set true to search for resource streams named "Dicom.Dictionaries.Private Dictionary.xml.gz" in referenced assemblies

Returns

DicomDictionary

GetEnumerator()

public IEnumerator<DicomDictionaryEntry> GetEnumerator()

Returns

IEnumerator<DicomDictionaryEntry>

GetPrivateCreator(string)

public DicomPrivateCreator GetPrivateCreator(string creator)

Parameters

creator string

Returns

DicomPrivateCreator

Load(string, DicomDictionaryFormat)

Load DICOM dictionary data from file.

public void Load(string file, DicomDictionaryFormat format)

Parameters

file string

File name.

format DicomDictionaryFormat

File format.