DicomObject (dcm4che 2.0.25 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.dcm4che2.data
Interface DicomObject

All Superinterfaces:: java.io.Serializable

All Known Implementing Classes:: BasicDicomObject

public interface DicomObject
extends java.io.Serializable
extends java.io.Serializable

Since:: Aug, 2005
Version:: $Revision: 13166 $ $Date: 2010-04-13 20:29:17 +0200 (Tue, 13 Apr 2010) $
Author:: gunter zeilinger(gunterze@gmail.com)

Nested Class Summary
`static interface`	`DicomObject.Visitor` Visitor object passed to @link{#accept}.

Method Summary
`boolean`	`accept(DicomObject.Visitor visitor)` Calls @link{Visitor#visit} for each element in this Dataset.
`void`	`add(DicomElement attr)`
`boolean`	`bigEndian()`
`void`	`bigEndian(boolean bigEndian)`
`boolean`	`cacheGet()`
`void`	`cacheGet(boolean cacheGet)`
`boolean`	`cachePut()`
`void`	`cachePut(boolean cachePut)`
`void`	`clear()` Removes all elements from this Dicom Object.
`DicomObject`	`command()`
`java.util.Iterator<DicomElement>`	`commandIterator()` Returns an iterator over Command elements (0000, eeee) in this Dicom Object.
`boolean`	`contains(int tag)` Returns `true`, if this Dicom Object contains the specified Element.
`boolean`	`containsAll(DicomObject keys)` Returns `true` if this Dicom Object contains all of the elements in the specified Dicom Object.
`boolean`	`containsValue(int tag)` Returns `true`, if this Dicom Object contains the specified Element with a value length > 0.
`void`	`copyTo(DicomObject destination)`
`DicomObject`	`dataset()`
`java.util.Iterator<DicomElement>`	`datasetIterator()` Returns an iterator over Data elements (group tag > 2) in this Dicom Object.
`DicomObject`	`exclude(int[] tags)`
`DicomObject`	`excludePrivate()` Note that this method does not remove private attributes from this DicomObject, rather, it returns a view of the DicomObject without private attributes.
`DicomObject`	`fileMetaInfo()`
`java.util.Iterator<DicomElement>`	`fileMetaInfoIterator()` Returns an iterator over File Meta Information elements (0002, eeee) in this Dicom Object.
`DicomElement`	`get(int tag)`
`DicomElement`	`get(int[] tagPath)`
`DicomElement`	`get(int[] tagPath, VR vr)`
`DicomElement`	`get(int tag, VR vr)`
`byte[]`	`getBytes(int tag)`
`byte[]`	`getBytes(int[] tagPath)`
`byte[]`	`getBytes(int[] tagPath, boolean bigEndian)`
`byte[]`	`getBytes(int tag, boolean bigEndian)`
`java.util.Date`	`getDate(int tag)`
`java.util.Date`	`getDate(int[] tagPath)`
`java.util.Date`	`getDate(int[] tagPath, java.util.Date defVal)`
`java.util.Date`	`getDate(int[] itemPath, int daTag, int tmTag)`
`java.util.Date`	`getDate(int[] itemPath, int daTag, int tmTag, java.util.Date defVal)`
`java.util.Date`	`getDate(int[] tagPath, VR vr)`
`java.util.Date`	`getDate(int[] tagPath, VR vr, java.util.Date defVal)`
`java.util.Date`	`getDate(int tag, java.util.Date defVal)`
`java.util.Date`	`getDate(int daTag, int tmTag)`
`java.util.Date`	`getDate(int daTag, int tmTag, java.util.Date defVal)`
`java.util.Date`	`getDate(int tag, VR vr)`
`java.util.Date`	`getDate(int tag, VR vr, java.util.Date defVal)`
`DateRange`	`getDateRange(int tag)`
`DateRange`	`getDateRange(int[] tagPath)`
`DateRange`	`getDateRange(int[] tagPath, DateRange defVal)`
`DateRange`	`getDateRange(int[] itemPath, int daTag, int tmTag)`
`DateRange`	`getDateRange(int[] itemPath, int daTag, int tmTag, DateRange defVal)`
`DateRange`	`getDateRange(int[] tagPath, VR vr)`
`DateRange`	`getDateRange(int[] tagPath, VR vr, DateRange defVal)`
`DateRange`	`getDateRange(int tag, DateRange defVal)`
`DateRange`	`getDateRange(int daTag, int tmTag)`
`DateRange`	`getDateRange(int daTag, int tmTag, DateRange defVal)`
`DateRange`	`getDateRange(int tag, VR vr)`
`DateRange`	`getDateRange(int tag, VR vr, DateRange defVal)`
`java.util.Date[]`	`getDates(int tag)`
`java.util.Date[]`	`getDates(int[] tagPath)`
`java.util.Date[]`	`getDates(int[] tagPath, java.util.Date[] defVal)`
`java.util.Date[]`	`getDates(int[] itemPath, int daTag, int tmTag)`
`java.util.Date[]`	`getDates(int[] itemPath, int daTag, int tmTag, java.util.Date[] defVal)`
`java.util.Date[]`	`getDates(int[] tagPath, VR vr)`
`java.util.Date[]`	`getDates(int[] tagPath, VR vr, java.util.Date[] defVal)`
`java.util.Date[]`	`getDates(int tag, java.util.Date[] defVal)`
`java.util.Date[]`	`getDates(int daTag, int tmTag)`
`java.util.Date[]`	`getDates(int daTag, int tmTag, java.util.Date[] defVal)`
`java.util.Date[]`	`getDates(int tag, VR vr)`
`java.util.Date[]`	`getDates(int tag, VR vr, java.util.Date[] defVal)`
`double`	`getDouble(int tag)`
`double`	`getDouble(int[] tagPath)`
`double`	`getDouble(int[] tagPath, double defVal)`
`double`	`getDouble(int[] tagPath, VR vr)`
`double`	`getDouble(int[] tagPath, VR vr, double defVal)`
`double`	`getDouble(int tag, double defVal)`
`double`	`getDouble(int tag, VR vr)`
`double`	`getDouble(int tag, VR vr, double defVal)`
`double[]`	`getDoubles(int tag)`
`double[]`	`getDoubles(int[] tagPath)`
`double[]`	`getDoubles(int[] tagPath, double[] defVal)`
`double[]`	`getDoubles(int[] tagPath, VR vr)`
`double[]`	`getDoubles(int[] tagPath, VR vr, double[] defVal)`
`double[]`	`getDoubles(int tag, double[] defVal)`
`double[]`	`getDoubles(int tag, VR vr)`
`double[]`	`getDoubles(int tag, VR vr, double[] defVal)`
`float`	`getFloat(int tag)`
`float`	`getFloat(int[] tagPath)`
`float`	`getFloat(int[] tagPath, float defVal)`
`float`	`getFloat(int[] tagPath, VR vr)`
`float`	`getFloat(int[] tagPath, VR vr, float defVal)`
`float`	`getFloat(int tag, float defVal)`
`float`	`getFloat(int tag, VR vr)`
`float`	`getFloat(int tag, VR vr, float defVal)`
`float[]`	`getFloats(int tag)`
`float[]`	`getFloats(int[] tagPath)`
`float[]`	`getFloats(int[] tagPath, float[] defVal)`
`float[]`	`getFloats(int[] tagPath, VR vr)`
`float[]`	`getFloats(int[] tagPath, VR vr, float[] defVal)`
`float[]`	`getFloats(int tag, float[] defVal)`
`float[]`	`getFloats(int tag, VR vr)`
`float[]`	`getFloats(int tag, VR vr, float[] defVal)`
`int`	`getInt(int tag)`
`int`	`getInt(int[] tagPath)`
`int`	`getInt(int[] tagPath, int defVal)`
`int`	`getInt(int[] tagPath, VR vr)`
`int`	`getInt(int[] tagPath, VR vr, int defVal)`
`int`	`getInt(int tag, int defVal)`
`int`	`getInt(int tag, VR vr)`
`int`	`getInt(int tag, VR vr, int defVal)`
`int[]`	`getInts(int tag)`
`int[]`	`getInts(int[] tagPath)`
`int[]`	`getInts(int[] tagPath, int[] defVal)`
`int[]`	`getInts(int[] tagPath, VR vr)`
`int[]`	`getInts(int[] tagPath, VR vr, int[] defVal)`
`int[]`	`getInts(int tag, int[] defVal)`
`int[]`	`getInts(int tag, VR vr)`
`int[]`	`getInts(int tag, VR vr, int[] defVal)`
`long`	`getItemOffset()` Returns the offset of the Sequence Item containing this Nested Data Set in the Dicom Stream from/to which the Data Set was read/written, or `-1` if this is not a Nested Data Set or it was not (yet) read from/written to a Dicom Stream.
`int`	`getItemPosition()` Returns zero-based position of this Nested Data in the Sequence Element, or `-1` if this is not a Nested Data Set.
`DicomObject`	`getNestedDicomObject(int tag)`
`DicomObject`	`getNestedDicomObject(int[] itemPath)`
`DicomObject`	`getParent()` Returns the Data Set containing this Data Set in a Sequence Element, or `null` if this is not a nested Data Set.
`java.lang.String`	`getPrivateCreator(int tag)` Returns private creator identifier, for given private tag.
`DicomObject`	`getRoot()`
`short[]`	`getShorts(int tag)`
`short[]`	`getShorts(int[] tagPath)`
`short[]`	`getShorts(int[] tagPath, short[] defVal)`
`short[]`	`getShorts(int[] tagPath, VR vr)`
`short[]`	`getShorts(int[] tagPath, VR vr, short[] defVal)`
`short[]`	`getShorts(int tag, short[] defVal)`
`short[]`	`getShorts(int tag, VR vr)`
`short[]`	`getShorts(int tag, VR vr, short[] defVal)`
`SpecificCharacterSet`	`getSpecificCharacterSet()` Returns the Specific Character Set defined by Attribute Specific Character Set (0008,0005) of this or the root Data Set, if this is a Nested Data Set containing in a Sequence Element.
`java.lang.String`	`getString(int tag)`
`java.lang.String`	`getString(int[] tagPath)`
`java.lang.String`	`getString(int[] tagPath, java.lang.String defVal)`
`java.lang.String`	`getString(int[] tagPath, VR vr)`
`java.lang.String`	`getString(int[] tagPath, VR vr, java.lang.String defVal)`
`java.lang.String`	`getString(int tag, java.lang.String defVal)`
`java.lang.String`	`getString(int tag, VR vr)`
`java.lang.String`	`getString(int tag, VR vr, java.lang.String defVal)`
`java.lang.String[]`	`getStrings(int tag)`
`java.lang.String[]`	`getStrings(int[] tagPath)`
`java.lang.String[]`	`getStrings(int[] tagPath, java.lang.String[] defVal)`
`java.lang.String[]`	`getStrings(int[] tagPath, VR vr)`
`java.lang.String[]`	`getStrings(int[] tagPath, VR vr, java.lang.String[] defVal)`
`java.lang.String[]`	`getStrings(int tag, java.lang.String[] defVal)`
`java.lang.String[]`	`getStrings(int tag, VR vr)`
`java.lang.String[]`	`getStrings(int tag, VR vr, java.lang.String[] defVal)`
`void`	`initFileMetaInformation(java.lang.String tsuid)`
`void`	`initFileMetaInformation(java.lang.String cuid, java.lang.String iuid, java.lang.String tsuid)`
`boolean`	`isEmpty()` Returns `true` if this Dicom Object contains no elements.
`boolean`	`isRoot()` Returns `true` if this is not a nested Data Set.
`java.util.Iterator<DicomElement>`	`iterator()` Returns an iterator over all elements in this Dicom Object.
`java.util.Iterator<DicomElement>`	`iterator(int fromTag, int toTag)` Returns an iterator over elements in the given range in this Dicom Object.
`boolean`	`matches(DicomObject keys, boolean ignoreCaseOfPN)`
`java.lang.String`	`nameOf(int tag)` Returns name of Attribute with specified (private) tag or
`DicomElement`	`putBytes(int[] tagPath, VR vr, byte[] val)`
`DicomElement`	`putBytes(int[] tagPath, VR vr, byte[] val, boolean bigEndian)`
`DicomElement`	`putBytes(int tag, VR vr, byte[] val)`
`DicomElement`	`putBytes(int tag, VR vr, byte[] val, boolean bigEndian)`
`DicomElement`	`putDate(int[] tagPath, VR vr, java.util.Date val)`
`DicomElement`	`putDate(int tag, VR vr, java.util.Date val)`
`DicomElement`	`putDateRange(int[] tagPath, VR vr, DateRange val)`
`DicomElement`	`putDateRange(int tag, VR vr, DateRange val)`
`DicomElement`	`putDates(int[] tagPath, VR vr, java.util.Date[] val)`
`DicomElement`	`putDates(int tag, VR vr, java.util.Date[] val)`
`DicomElement`	`putDouble(int[] tagPath, VR vr, double val)`
`DicomElement`	`putDouble(int tag, VR vr, double val)`
`DicomElement`	`putDoubles(int[] tagPath, VR vr, double[] val)`
`DicomElement`	`putDoubles(int tag, VR vr, double[] val)`
`DicomElement`	`putFloat(int[] tagPath, VR vr, float val)`
`DicomElement`	`putFloat(int tag, VR vr, float val)`
`DicomElement`	`putFloats(int[] tagPath, VR vr, float[] val)`
`DicomElement`	`putFloats(int tag, VR vr, float[] val)`
`DicomElement`	`putFragments(int[] tagPath, VR vr, boolean bigEndian)`
`DicomElement`	`putFragments(int[] tagPath, VR vr, boolean bigEndian, int capacity)`
`DicomElement`	`putFragments(int tag, VR vr, boolean bigEndian)`
`DicomElement`	`putFragments(int tag, VR vr, boolean bigEndian, int capacity)`
`DicomElement`	`putInt(int[] tagPath, VR vr, int val)`
`DicomElement`	`putInt(int tag, VR vr, int val)`
`DicomElement`	`putInts(int[] tagPath, VR vr, int[] val)`
`DicomElement`	`putInts(int tag, VR vr, int[] val)`
`DicomElement`	`putNestedDicomObject(int[] tagPath, DicomObject item)`
`DicomElement`	`putNestedDicomObject(int tag, DicomObject item)`
`DicomElement`	`putNull(int[] tagPath, VR vr)`
`DicomElement`	`putNull(int tag, VR vr)`
`DicomElement`	`putSequence(int tag)`
`DicomElement`	`putSequence(int[] tagPath)`
`DicomElement`	`putSequence(int[] tagPath, int capacity)`
`DicomElement`	`putSequence(int tag, int capacity)`
`DicomElement`	`putShorts(int[] tagPath, VR vr, short[] val)`
`DicomElement`	`putShorts(int tag, VR vr, short[] val)`
`DicomElement`	`putString(int[] tagPath, VR vr, java.lang.String val)`
`DicomElement`	`putString(int tag, VR vr, java.lang.String val)`
`DicomElement`	`putStrings(int[] tagPath, VR vr, java.lang.String[] val)`
`DicomElement`	`putStrings(int tag, VR vr, java.lang.String[] val)`
`DicomElement`	`remove(int tag)`
`DicomElement`	`remove(int[] tagPath)`
`int`	`resolveTag(int tag, java.lang.String privateCreator)` Resolve existing private tag.
`int`	`resolveTag(int tag, java.lang.String privateCreator, boolean reserve)` Resolves private tag.
`void`	`serializeElements(java.io.ObjectOutputStream oos)`
`void`	`setItemOffset(long offset)` Sets the offset of the Sequence Item encoding this Nested Data Set in a Dicom Stream.
`void`	`setItemPosition(int pos)` Sets zero-based position of this Nested Data in the Sequence Element.
`void`	`setParent(DicomObject parent)`
`void`	`shareElements()`
`int`	`size()` Returns number of elements in this Dicom Object.
`DicomObject`	`subSet(DicomObject filter)`
`DicomObject`	`subSet(int[] tags)`
`DicomObject`	`subSet(int fromTag, int toTag)`
`int`	`toStringBuffer(java.lang.StringBuffer sb, DicomObjectToStringParam param)`
`int`	`vm(int tag)` Returns Number of Values of the specified Element or `-1` if there is no such Element in this Dicom Object.
`VR`	`vrOf(int tag)` Returns Value Representation of Attribute with specified (private) tag or @link{VR#UN} if no entry was found in configured @link{VRMap}s.

Method Detail

size

int size()

Returns number of elements in this Dicom Object.

Returns:: number of elements in this Dicom Object.

isEmpty

boolean isEmpty()

Returns true if this Dicom Object contains no elements.

Returns:: true if this Dicom Object contains no elements.

clear

void clear()

Removes all elements from this Dicom Object.

getRoot

DicomObject getRoot()

Returns:: the root Data Set, if this Data Set is contained within a Sequence Element of another Data Set, otherwise this.

isRoot

boolean isRoot()

Returns true if this is not a nested Data Set.

Returns:: true if this is not a nested Data Set.

getParent

DicomObject getParent()

Returns the Data Set containing this Data Set in a Sequence Element, or null if this is not a nested Data Set.

Returns:: the Data Set containing this Data Set in a Sequence Element, or null if this is not a nested Data Set.

setParent

void setParent(DicomObject parent)

getSpecificCharacterSet

SpecificCharacterSet getSpecificCharacterSet()

Returns the Specific Character Set defined by Attribute Specific Character Set (0008,0005) of this or the root Data Set, if this is a Nested Data Set containing in a Sequence Element. Returns null if Attribute Specific Character Set (0008,0005) is not present.

Returns:: the Specific Character Set defined by Attribute Specific Character Set (0008,0005) or null if the Attribute is not present.

iterator

java.util.Iterator<DicomElement> iterator()

Returns an iterator over all elements in this Dicom Object.

Returns:: an Iterator over all elements in this Dicom Object.

iterator

java.util.Iterator<DicomElement> iterator(int fromTag,
                                          int toTag)

Returns an iterator over elements in the given range in this Dicom Object.

Parameters:: fromTag - minimal (group, element) as 8 byte integer: ggggeeee, of first element included.; toTag - maximal (group, element) as 8 byte integer: ggggeeee, of last element included.
Returns:: an Iterator over elements in this Dicom Object.

commandIterator

java.util.Iterator<DicomElement> commandIterator()

Returns an iterator over Command elements (0000, eeee) in this Dicom Object.

Returns:: an Iterator over Command elements (0000, eeee) in this Dicom Object.

fileMetaInfoIterator

java.util.Iterator<DicomElement> fileMetaInfoIterator()

Returns an iterator over File Meta Information elements (0002, eeee) in this Dicom Object.

Returns:: an Iterator over File Meta Information elements (0002, eeee) in this Dicom Object.

datasetIterator

java.util.Iterator<DicomElement> datasetIterator()

Returns an iterator over Data elements (group tag > 2) in this Dicom Object.

Returns:: an Iterator over Data elements in this Dicom Object.

getItemPosition

int getItemPosition()

Returns zero-based position of this Nested Data in the Sequence Element, or -1 if this is not a Nested Data Set.

Returns:: zero-based position of this Nested Data in the Sequence Element Set, or -1 if this is not a Nested Data Set.

setItemPosition

void setItemPosition(int pos)

Sets zero-based position of this Nested Data in the Sequence Element. Typically only internally used.

getItemOffset

long getItemOffset()

Returns the offset of the Sequence Item containing this Nested Data Set in the Dicom Stream from/to which the Data Set was read/written, or -1 if this is not a Nested Data Set or it was not (yet) read from/written to a Dicom Stream.

Returns:: the offset of the Sequence Item containing this Nested Data Set in the Dicom Stream, or -1.

setItemOffset

void setItemOffset(long offset)

Sets the offset of the Sequence Item encoding this Nested Data Set in a Dicom Stream. Typically only internally used.

Parameters:: offset - of the Sequence Item containing this Nested Data Set in a Dicom Stream.

vrOf

VR vrOf(int tag)

Returns Value Representation of Attribute with specified (private) tag or @link{VR#UN} if no entry was found in configured @link{VRMap}s.

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:: Value Representation of Attribute with specified (private) tag.

nameOf

java.lang.String nameOf(int tag)

Returns name of Attribute with specified (private) tag or

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:: name of Attribute with specified (private) tag.

resolveTag

int resolveTag(int tag,
               java.lang.String privateCreator)

Resolve existing private tag. Invokes

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; privateCreator - private creator identifier
Returns:: resolved tag or -1, if no tags are reserved for privateCreator.

resolveTag

int resolveTag(int tag,
               java.lang.String privateCreator,
               boolean reserve)

Resolves private tag. If the group number of the specified tag is odd (= private tag) and privateCreator != null, searches for the first private creator data element in (gggg,0010-00FF) which matches privateCreator, and returns ggggEEee with EE the element number of the matching private creator data element and ee the two lower bytes of the element number of the specified tag.> If no matching private creator data element in (gggg,0010-00FF) is found, and reserve=true, the specified privateCreator is inserted in the first unused private creator data element, and ggggEEee with EE the element number the new inserted private creator data element is returned. If reserve=false, -1 is returned.
If the group number of the specified tag is even (= standard tag) or privateCreator == null, tag is returned unmodified.

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; privateCreator - private creator identifier
Returns:: resolved tag or -1, if no tags are reserved for privateCreator and reserve=false.

getPrivateCreator

java.lang.String getPrivateCreator(int tag)

Returns private creator identifier, for given private tag.

Parameters:: tag - (group, element) of private tag as 8 byte integer: ggggeeee
Returns:: Returns private creator identifier, for given private tag.
Throws:: IllegalArgumentExcepion - if tag is not a private tag or if itself a Private Creator Data Element (gggg,00EE).

vm

int vm(int tag)

Returns Number of Values of the specified Element or -1 if there is no such Element in this Dicom Object.

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:: Number of Values of the specified Element or -1 if there is no such Element in this Dicom Object.

contains

boolean contains(int tag)

Returns true, if this Dicom Object contains the specified Element.

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:: true, if this DicomObject contains the specified Element.

containsValue

boolean containsValue(int tag)

Returns true, if this Dicom Object contains the specified Element with a value length > 0.

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:: true, if this DicomObject contains the specified Element with a value length > 0.

containsAll

boolean containsAll(DicomObject keys)

Returns true if this Dicom Object contains all of the elements in the specified Dicom Object.

Parameters:: keys - Dicom Object to be checked for containment in this Dicom Object.
Returns:: true if this Dicom Object contains all of the elements in the specified collection

accept

boolean accept(DicomObject.Visitor visitor)

Calls @link{Visitor#visit} for each element in this Dataset. Returns false, if @link{Visitor#visit} returns false for any element.

Parameters:: visitor - Visitor object, which method @link{Visitor#visit} is called for each element in this Dataset.
Returns:: true if @link{Visitor#visit} returns true for all elements of this dataset, false if @link{Visitor#visit} returns false for any element.

add

void add(DicomElement attr)

Parameters:: attr -

remove

DicomElement remove(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

remove

DicomElement remove(int[] tagPath)

Parameters:: tagPath -
Returns:

get

DicomElement get(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

get

DicomElement get(int tag,
                 VR vr)

get

DicomElement get(int[] tagPath)

Parameters:: tagPath -
Returns:

get

DicomElement get(int[] tagPath,
                 VR vr)

getBytes

byte[] getBytes(int tag,
                boolean bigEndian)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; bigEndian -
Returns:

getBytes

byte[] getBytes(int tag)

getBytes

byte[] getBytes(int[] tagPath,
                boolean bigEndian)

Parameters:: tagPath -; bigEndian -
Returns:

getBytes

byte[] getBytes(int[] tagPath)

getNestedDicomObject

DicomObject getNestedDicomObject(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getNestedDicomObject

DicomObject getNestedDicomObject(int[] itemPath)

Parameters:: itemPath -
Returns:

getInt

int getInt(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getInt

int getInt(int tag,
           VR vr)

getInt

int getInt(int tag,
           int defVal)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; defVal - TODO
Returns:

getInt

int getInt(int tag,
           VR vr,
           int defVal)

getInt

int getInt(int[] tagPath)

Parameters:: tagPath -
Returns:

getInt

int getInt(int[] tagPath,
           VR vr)

getInt

int getInt(int[] tagPath,
           int defVal)

Parameters:: tagPath -
Returns:

getInt

int getInt(int[] tagPath,
           VR vr,
           int defVal)

getInts

int[] getInts(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getInts

int[] getInts(int tag,
              VR vr)

getInts

int[] getInts(int tag,
              int[] defVal)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getInts

int[] getInts(int tag,
              VR vr,
              int[] defVal)

getInts

int[] getInts(int[] tagPath)

Parameters:: tagPath -
Returns:

getInts

int[] getInts(int[] tagPath,
              VR vr)

getInts

int[] getInts(int[] tagPath,
              int[] defVal)

Parameters:: tagPath -
Returns:

getInts

int[] getInts(int[] tagPath,
              VR vr,
              int[] defVal)

getShorts

short[] getShorts(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getShorts

short[] getShorts(int tag,
                  VR vr)

getShorts

short[] getShorts(int tag,
                  short[] defVal)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getShorts

short[] getShorts(int tag,
                  VR vr,
                  short[] defVal)

getShorts

short[] getShorts(int[] tagPath)

Parameters:: tagPath -
Returns:

getShorts

short[] getShorts(int[] tagPath,
                  VR vr)

getShorts

short[] getShorts(int[] tagPath,
                  short[] defVal)

Parameters:: tagPath -
Returns:

getShorts

short[] getShorts(int[] tagPath,
                  VR vr,
                  short[] defVal)

getFloat

float getFloat(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getFloat

float getFloat(int tag,
               VR vr)

getFloat

float getFloat(int tag,
               float defVal)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getFloat

float getFloat(int tag,
               VR vr,
               float defVal)

getFloat

float getFloat(int[] tagPath)

Parameters:: tagPath -
Returns:

getFloat

float getFloat(int[] tagPath,
               VR vr)

getFloat

float getFloat(int[] tagPath,
               float defVal)

Parameters:: tagPath -
Returns:

getFloat

float getFloat(int[] tagPath,
               VR vr,
               float defVal)

getFloats

float[] getFloats(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getFloats

float[] getFloats(int tag,
                  VR vr)

getFloats

float[] getFloats(int tag,
                  float[] defVal)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getFloats

float[] getFloats(int tag,
                  VR vr,
                  float[] defVal)

getFloats

float[] getFloats(int[] tagPath)

Parameters:: tagPath -
Returns:

getFloats

float[] getFloats(int[] tagPath,
                  VR vr)

getFloats

float[] getFloats(int[] tagPath,
                  float[] defVal)

Parameters:: tagPath -
Returns:

getFloats

float[] getFloats(int[] tagPath,
                  VR vr,
                  float[] defVal)

getDouble

double getDouble(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getDouble

double getDouble(int tag,
                 VR vr)

getDouble

double getDouble(int tag,
                 double defVal)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getDouble

double getDouble(int tag,
                 VR vr,
                 double defVal)

getDouble

double getDouble(int[] tagPath)

Parameters:: tagPath -
Returns:

getDouble

double getDouble(int[] tagPath,
                 VR vr)

getDouble

double getDouble(int[] tagPath,
                 double defVal)

Parameters:: tagPath -
Returns:

getDouble

double getDouble(int[] tagPath,
                 VR vr,
                 double defVal)

getDoubles

double[] getDoubles(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getDoubles

double[] getDoubles(int tag,
                    VR vr)

getDoubles

double[] getDoubles(int tag,
                    double[] defVal)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getDoubles

double[] getDoubles(int tag,
                    VR vr,
                    double[] defVal)

getDoubles

double[] getDoubles(int[] tagPath)

Parameters:: tagPath -
Returns:

getDoubles

double[] getDoubles(int[] tagPath,
                    VR vr)

getDoubles

double[] getDoubles(int[] tagPath,
                    double[] defVal)

Parameters:: tagPath -
Returns:

getDoubles

double[] getDoubles(int[] tagPath,
                    VR vr,
                    double[] defVal)

getString

java.lang.String getString(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getString

java.lang.String getString(int tag,
                           VR vr)

getString

java.lang.String getString(int tag,
                           java.lang.String defVal)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getString

java.lang.String getString(int tag,
                           VR vr,
                           java.lang.String defVal)

getString

java.lang.String getString(int[] tagPath)

Parameters:: tagPath -
Returns:

getString

java.lang.String getString(int[] tagPath,
                           VR vr)

getString

java.lang.String getString(int[] tagPath,
                           java.lang.String defVal)

Parameters:: tagPath -
Returns:

getString

java.lang.String getString(int[] tagPath,
                           VR vr,
                           java.lang.String defVal)

getStrings

java.lang.String[] getStrings(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getStrings

java.lang.String[] getStrings(int tag,
                              VR vr)

getStrings

java.lang.String[] getStrings(int tag,
                              java.lang.String[] defVal)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getStrings

java.lang.String[] getStrings(int tag,
                              VR vr,
                              java.lang.String[] defVal)

getStrings

java.lang.String[] getStrings(int[] tagPath)

Parameters:: tagPath -
Returns:

getStrings

java.lang.String[] getStrings(int[] tagPath,
                              VR vr)

getStrings

java.lang.String[] getStrings(int[] tagPath,
                              java.lang.String[] defVal)

Parameters:: tagPath -
Returns:

getStrings

java.lang.String[] getStrings(int[] tagPath,
                              VR vr,
                              java.lang.String[] defVal)

getDate

java.util.Date getDate(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getDate

java.util.Date getDate(int tag,
                       VR vr)

getDate

java.util.Date getDate(int tag,
                       java.util.Date defVal)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getDate

java.util.Date getDate(int tag,
                       VR vr,
                       java.util.Date defVal)

getDate

java.util.Date getDate(int daTag,
                       int tmTag)

Parameters:: daTag -; tmTag -
Returns:

getDate

java.util.Date getDate(int daTag,
                       int tmTag,
                       java.util.Date defVal)

Parameters:: daTag -; tmTag -
Returns:

getDate

java.util.Date getDate(int[] tagPath)

Parameters:: tagPath -
Returns:

getDate

java.util.Date getDate(int[] tagPath,
                       VR vr)

getDate

java.util.Date getDate(int[] tagPath,
                       java.util.Date defVal)

Parameters:: tagPath -
Returns:

getDate

java.util.Date getDate(int[] tagPath,
                       VR vr,
                       java.util.Date defVal)

getDate

java.util.Date getDate(int[] itemPath,
                       int daTag,
                       int tmTag)

Parameters:: itemPath -; daTag -; tmTag -
Returns:

getDate

java.util.Date getDate(int[] itemPath,
                       int daTag,
                       int tmTag,
                       java.util.Date defVal)

Parameters:: itemPath -; daTag -; tmTag -
Returns:

getDates

java.util.Date[] getDates(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getDates

java.util.Date[] getDates(int tag,
                          VR vr)

getDates

java.util.Date[] getDates(int tag,
                          java.util.Date[] defVal)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getDates

java.util.Date[] getDates(int tag,
                          VR vr,
                          java.util.Date[] defVal)

getDates

java.util.Date[] getDates(int daTag,
                          int tmTag)

Parameters:: daTag -; tmTag -
Returns:

getDates

java.util.Date[] getDates(int daTag,
                          int tmTag,
                          java.util.Date[] defVal)

Parameters:: daTag -; tmTag -
Returns:

getDates

java.util.Date[] getDates(int[] tagPath)

Parameters:: tagPath -
Returns:

getDates

java.util.Date[] getDates(int[] tagPath,
                          VR vr)

getDates

java.util.Date[] getDates(int[] tagPath,
                          java.util.Date[] defVal)

Parameters:: tagPath -
Returns:

getDates

java.util.Date[] getDates(int[] tagPath,
                          VR vr,
                          java.util.Date[] defVal)

getDates

java.util.Date[] getDates(int[] itemPath,
                          int daTag,
                          int tmTag)

Parameters:: itemPath -; daTag -; tmTag -
Returns:

getDates

java.util.Date[] getDates(int[] itemPath,
                          int daTag,
                          int tmTag,
                          java.util.Date[] defVal)

Parameters:: itemPath -; daTag -; tmTag -
Returns:

getDateRange

DateRange getDateRange(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getDateRange

DateRange getDateRange(int tag,
                       VR vr)

getDateRange

DateRange getDateRange(int tag,
                       DateRange defVal)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

getDateRange

DateRange getDateRange(int tag,
                       VR vr,
                       DateRange defVal)

getDateRange

DateRange getDateRange(int daTag,
                       int tmTag)

Parameters:: daTag -; tmTag -
Returns:

getDateRange

DateRange getDateRange(int daTag,
                       int tmTag,
                       DateRange defVal)

Parameters:: daTag -; tmTag -
Returns:

getDateRange

DateRange getDateRange(int[] tagPath)

Parameters:: tagPath -
Returns:

getDateRange

DateRange getDateRange(int[] tagPath,
                       VR vr)

getDateRange

DateRange getDateRange(int[] tagPath,
                       DateRange defVal)

Parameters:: tagPath -
Returns:

getDateRange

DateRange getDateRange(int[] tagPath,
                       VR vr,
                       DateRange defVal)

getDateRange

DateRange getDateRange(int[] itemPath,
                       int daTag,
                       int tmTag)

Parameters:: itemPath -; daTag -; tmTag -
Returns:

getDateRange

DateRange getDateRange(int[] itemPath,
                       int daTag,
                       int tmTag,
                       DateRange defVal)

Parameters:: itemPath -; daTag -; tmTag -
Returns:

putNull

DicomElement putNull(int tag,
                     VR vr)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -
Returns:

putBytes

DicomElement putBytes(int tag,
                      VR vr,
                      byte[] val)

putBytes

DicomElement putBytes(int tag,
                      VR vr,
                      byte[] val,
                      boolean bigEndian)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -; val -; bigEndian -
Returns:

putNestedDicomObject

DicomElement putNestedDicomObject(int tag,
                                  DicomObject item)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; item -
Returns:

putInt

DicomElement putInt(int tag,
                    VR vr,
                    int val)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -; val -
Returns:

putInts

DicomElement putInts(int tag,
                     VR vr,
                     int[] val)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -; val -
Returns:

putShorts

DicomElement putShorts(int tag,
                       VR vr,
                       short[] val)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -; val -
Returns:

putFloat

DicomElement putFloat(int tag,
                      VR vr,
                      float val)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -; val -
Returns:

putFloats

DicomElement putFloats(int tag,
                       VR vr,
                       float[] val)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -; val -
Returns:

putDouble

DicomElement putDouble(int tag,
                       VR vr,
                       double val)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -; val -
Returns:

putDoubles

DicomElement putDoubles(int tag,
                        VR vr,
                        double[] val)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -; val -
Returns:

putString

DicomElement putString(int tag,
                       VR vr,
                       java.lang.String val)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -; val -
Returns:

putStrings

DicomElement putStrings(int tag,
                        VR vr,
                        java.lang.String[] val)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -; val -
Returns:

putDate

DicomElement putDate(int tag,
                     VR vr,
                     java.util.Date val)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -; val -
Returns:

putDates

DicomElement putDates(int tag,
                      VR vr,
                      java.util.Date[] val)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -; val -
Returns:

putDateRange

DicomElement putDateRange(int tag,
                          VR vr,
                          DateRange val)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -; val -
Returns:

putSequence

DicomElement putSequence(int tag)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.
Returns:

putSequence

DicomElement putSequence(int tag,
                         int capacity)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; capacity -
Returns:

putFragments

DicomElement putFragments(int tag,
                          VR vr,
                          boolean bigEndian)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -; bigEndian -
Returns:

putFragments

DicomElement putFragments(int tag,
                          VR vr,
                          boolean bigEndian,
                          int capacity)

Parameters:: tag - (group, element) as 8 byte integer: ggggeeee.; vr -; bigEndian -; capacity -
Returns:

putNull

DicomElement putNull(int[] tagPath,
                     VR vr)

Parameters:: tagPath -; vr -
Returns:

putBytes

DicomElement putBytes(int[] tagPath,
                      VR vr,
                      byte[] val)

putBytes

DicomElement putBytes(int[] tagPath,
                      VR vr,
                      byte[] val,
                      boolean bigEndian)

Parameters:: tagPath -; vr -; val -; bigEndian -
Returns:

putNestedDicomObject

DicomElement putNestedDicomObject(int[] tagPath,
                                  DicomObject item)

Parameters:: tagPath -; item -
Returns:

putInt

DicomElement putInt(int[] tagPath,
                    VR vr,
                    int val)

Parameters:: tagPath -; vr -; val -
Returns:

putInts

DicomElement putInts(int[] tagPath,
                     VR vr,
                     int[] val)

Parameters:: tagPath -; vr -; val -
Returns:

putShorts

DicomElement putShorts(int[] tagPath,
                       VR vr,
                       short[] val)

Parameters:: tagPath -; vr -; val -
Returns:

putFloat

DicomElement putFloat(int[] tagPath,
                      VR vr,
                      float val)

Parameters:: tagPath -; vr -; val -
Returns:

putFloats

DicomElement putFloats(int[] tagPath,
                       VR vr,
                       float[] val)

Parameters:: tagPath -; vr -; val -
Returns:

putDouble

DicomElement putDouble(int[] tagPath,
                       VR vr,
                       double val)

Parameters:: tagPath -; vr -; val -
Returns:

putDoubles

DicomElement putDoubles(int[] tagPath,
                        VR vr,
                        double[] val)

Parameters:: tagPath -; vr -; val -
Returns:

putString

DicomElement putString(int[] tagPath,
                       VR vr,
                       java.lang.String val)

Parameters:: tagPath -; vr -; val -
Returns:

putStrings

DicomElement putStrings(int[] tagPath,
                        VR vr,
                        java.lang.String[] val)

Parameters:: tagPath -; vr -; val -
Returns:

putDate

DicomElement putDate(int[] tagPath,
                     VR vr,
                     java.util.Date val)

Parameters:: tagPath -; vr -; val -
Returns:

putDates

DicomElement putDates(int[] tagPath,
                      VR vr,
                      java.util.Date[] val)

Parameters:: tagPath -; vr -; val -
Returns:

putDateRange

DicomElement putDateRange(int[] tagPath,
                          VR vr,
                          DateRange val)

Parameters:: tagPath -; vr -; val -
Returns:

putSequence

DicomElement putSequence(int[] tagPath)

Parameters:: tagPath -
Returns:

putSequence

DicomElement putSequence(int[] tagPath,
                         int capacity)

Parameters:: tagPath -; capacity -
Returns:

putFragments

DicomElement putFragments(int[] tagPath,
                          VR vr,
                          boolean bigEndian)

Parameters:: tagPath -; vr -; bigEndian -
Returns:

putFragments

DicomElement putFragments(int[] tagPath,
                          VR vr,
                          boolean bigEndian,
                          int capacity)

Parameters:: tagPath -; vr -; bigEndian -; capacity -
Returns:

shareElements

void shareElements()

serializeElements

void serializeElements(java.io.ObjectOutputStream oos)
                       throws java.io.IOException

Parameters:: oos -
Throws:: java.io.IOException

copyTo

void copyTo(DicomObject destination)

Parameters:: destination -

matches

boolean matches(DicomObject keys,
                boolean ignoreCaseOfPN)

Parameters:: keys -; ignoreCaseOfPN -
Returns:

cacheGet

boolean cacheGet()

Returns:

cacheGet

void cacheGet(boolean cacheGet)

Parameters:: cacheGet -

cachePut

boolean cachePut()

Returns:

cachePut

void cachePut(boolean cachePut)

Parameters:: cachePut -

bigEndian

boolean bigEndian()

Returns:

bigEndian

void bigEndian(boolean bigEndian)

Parameters:: bigEndian -

command

DicomObject command()

Returns:

dataset

DicomObject dataset()

Returns:

fileMetaInfo

DicomObject fileMetaInfo()

Returns:

subSet

DicomObject subSet(DicomObject filter)

Parameters:: filter -
Returns:

subSet

DicomObject subSet(int fromTag,
                   int toTag)

Parameters:: fromTag -; toTag -
Returns:

subSet

DicomObject subSet(int[] tags)

Parameters:: tags -
Returns:

exclude

DicomObject exclude(int[] tags)

Parameters:: tags -
Returns:

excludePrivate

DicomObject excludePrivate()

Note that this method does not remove private attributes from this DicomObject, rather, it returns a view of the DicomObject without private attributes. You you may store this view to a file.

Returns:: a new DicomObject without private attributes.

initFileMetaInformation

void initFileMetaInformation(java.lang.String tsuid)

Parameters:: tsuid -

initFileMetaInformation

void initFileMetaInformation(java.lang.String cuid,
                             java.lang.String iuid,
                             java.lang.String tsuid)

Parameters:: cuid -; iuid -; tsuid -

toStringBuffer

int toStringBuffer(java.lang.StringBuffer sb,
                   DicomObjectToStringParam param)

Parameters:: sb -; param -
Returns:

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.dcm4che2.data Interface DicomObject

size

isEmpty

clear

getRoot

isRoot

getParent

setParent

getSpecificCharacterSet

iterator

iterator

commandIterator

fileMetaInfoIterator

datasetIterator

getItemPosition

setItemPosition

getItemOffset

setItemOffset

vrOf

nameOf

resolveTag

resolveTag

getPrivateCreator

vm

contains

containsValue

containsAll

accept

add

remove

remove

get

get

get

get

getBytes

getBytes

getBytes

getBytes

getNestedDicomObject

getNestedDicomObject

getInt

getInt

getInt

getInt

getInt

getInt

getInt

getInt

getInts

getInts

getInts

getInts

getInts

getInts

getInts

getInts

getShorts

getShorts

getShorts

getShorts

getShorts

getShorts

getShorts

getShorts

getFloat

getFloat

getFloat

getFloat

getFloat

getFloat

getFloat

getFloat

getFloats

getFloats

getFloats

getFloats

getFloats

getFloats

getFloats

org.dcm4che2.data
Interface DicomObject