maspack.image.dicom

Class DicomHeader

java.lang.Object

maspack.image.dicom.DicomHeader

public class DicomHeader
extends java.lang.Object

Stores all header DICOM information

Author:

Antonio

Constructor Summary

Constructors

Constructor and Description
DicomHeader()

Method Summary

Modifier and Type	Method and Description
void	addInfo(int tagId, DicomElement info) Add DICOM header entry
static void	addTransferSyntax(DicomTransferSyntax syntax) Adds a possible transfer syntax, previously unknown, allowing for decoding of new DICOM information
DicomDateTime	getDateTime(int tagId) Determines the data/time value of a given header element (if represents valid date/time)
double	getDecimalValue(int tagId, double defaultValue) Determines the decimal value of a given header element (if represents valid decimal number)
DicomElement	getElement(int tagId) Query DICOM header information
int	getIntValue(int tagId, int defaultValue) Determines the integer value of a given header element (if represents valid integer)
double[]	getMultiDecimalValue(int tagId) Determines the decimal array value of a given header element (if represents valid decimal array)
int[]	getMultiIntValue(int tagId) Determines the integer array value of a given header element (if represents valid integer array)
java.lang.String[]	getMultiStringValue(int tagId) Determines the string values of a given header element
DicomElement[]	getSequence(int tagId)
java.lang.String	getStringValue(int tagId) Determines the string representation of a given header element
DicomTransferSyntax	getTransferSyntax()
static DicomTransferSyntax	getTransferSyntax(java.lang.String uid) Determines the appropriate transfer syntax based on the syntax's uid
VectorNd	getVectorValue(int tagId) Determines the vector value of a given header element (if represents valid vector)
DicomElement	removeInfo(int tagId) Remove DICOM header information
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DicomHeader

public DicomHeader()

Method Detail

addInfo

public void addInfo(int tagId,
                    DicomElement info)

Add DICOM header entry

Parameters:

tagId - integer tag identifying header element

info - header information to add

removeInfo

public DicomElement removeInfo(int tagId)

Remove DICOM header information

Parameters:

tagId - integer tag identifying header element

Returns:

corresponding header information if exists and removed, null otherwise

getElement

public DicomElement getElement(int tagId)

Query DICOM header information

Parameters:

tagId - integer tag identifying header element

Returns:

corresponding header information if exists, null otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTransferSyntax

public DicomTransferSyntax getTransferSyntax()

Returns:

the transfer syntax, which identifies how the content and image is stored

getStringValue

public java.lang.String getStringValue(int tagId)

Determines the string representation of a given header element

Parameters:

tagId - integer tag identifier for the header element

Returns:

string representation

getIntValue

public int getIntValue(int tagId,
                       int defaultValue)

Determines the integer value of a given header element (if represents valid integer)

Parameters:

tagId - DICOM tag identifier

defaultValue - default integer value to return if the tag is not present in the header

Returns:

the value of the header element if exists and is valid, otherwise the supplied default value is returned

getDecimalValue

public double getDecimalValue(int tagId,
                              double defaultValue)

Determines the decimal value of a given header element (if represents valid decimal number)

Parameters:

tagId - DICOM tag identifier

defaultValue - default decimal value to return if the tag is not present in the header

Returns:

the value of the header element if exists and is valid, otherwise the supplied default value is returned

getVectorValue

public VectorNd getVectorValue(int tagId)

Determines the vector value of a given header element (if represents valid vector)

Parameters:

tagId - DICOM tag identifier

Returns:

the value of the header element if exists and is valid, null otherwise

getSequence

public DicomElement[] getSequence(int tagId)

getMultiStringValue

public java.lang.String[] getMultiStringValue(int tagId)

Determines the string values of a given header element

Parameters:

tagId - DICOM tag identifier

Returns:

the value of the header element if exists and is valid

getMultiIntValue

public int[] getMultiIntValue(int tagId)

Determines the integer array value of a given header element (if represents valid integer array)

Parameters:

tagId - DICOM tag identifier

Returns:

the value of the header element if exists and is valid, null otherwise

getMultiDecimalValue

public double[] getMultiDecimalValue(int tagId)

Determines the decimal array value of a given header element (if represents valid decimal array)

Parameters:

tagId - DICOM tag identifier

Returns:

the value of the header element if exists and is valid, null otherwise

getDateTime

public DicomDateTime getDateTime(int tagId)

Determines the data/time value of a given header element (if represents valid date/time)

Parameters:

tagId - DICOM tag identifier

Returns:

the value of the header element if exists and is valid, null otherwise

addTransferSyntax

public static void addTransferSyntax(DicomTransferSyntax syntax)

Adds a possible transfer syntax, previously unknown, allowing for decoding of new DICOM information

Parameters:

syntax - transfer syntax to add, containing necessary decoding information

getTransferSyntax

public static DicomTransferSyntax getTransferSyntax(java.lang.String uid)

Determines the appropriate transfer syntax based on the syntax's uid

Parameters:

uid - the identifying uid for the transfer syntax

Returns:

the transfer syntax representation, null if not found