cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RTDoseModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RTDoseModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RTDoseModule
extends Module

The RT Dose module is used to convey 2D or 3D radiation dose data generated from treatment planning systems or similar devices.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
RTDoseModule(IDataSet objIDataSet)

Method Summary

Methods

Modifier and Type	Method and Description
short	getBitsAllocated() Retrieves Bits Allocated.
short	getBitsStored() Retrieves Bits Stored.
DerivationCodeSequence	getDerivationCodeSequence() Retrieves sequence of DerivationCodeSequence
java.lang.String	getDoseComment() Retrieves Dose Comment.
java.lang.String	getDoseGridScaling() Retrieves Dose Grid Scaling.
java.lang.String	getDoseSummationType() Retrieves Dose Summation Type.
java.lang.String	getDoseType() Retrieves Dose Type.
java.lang.String	getDoseUnits() Retrieves Dose axis units.
java.lang.String[]	getGridFrameOffsetVector() Retrieves Grid Frame Offset Vector.
short	getHighBit() Retrieves High Bit.
java.lang.String	getInstanceNumber() Retrieves Instance Number.
java.lang.String[]	getNormalizationPoint() Retrieves Normalization Point.
java.lang.String	getPhotometricInterpretation() Retrieves Photometric Interpretation.
short	getPixelRepresentation() Retrieves Pixel Representation.
ReferencedInstanceSequence	getReferencedInstanceSequence() Retrieves sequence of ReferencedInstanceSequence
ReferencedRTPlanSequence	getReferencedRTPlanSequence() Retrieves sequence of one Class/Instance pair describing RT Plan associated with dose.
ReferencedSpatialRegistrationSequence	getReferencedSpatialRegistrationSequence() Retrieves sequence of Referenced SpatialRegistration
ReferencedTreatmentRecordSequence	getReferencedTreatmentRecordSequence() Retrieves sequence of Referenced TreatmentRecord Sequence
short	getSamplesperPixel() Retrieves Samples per Pixel.
java.lang.String	getSpatialTransformOfDose() Retrieves type of the value Spatial Transform of Dose
java.lang.String[]	getTissueHeterogeneityCorrection() Retrieves Tissue Heterogeneity Correction.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setBitsAllocated(EnumBitsAllocated enumBitsAllocated) Sets Bits Allocated.
void	setBitsStored(EnumBitsStored enumBitsStored) Sets Bits Stored.
void	setDoseComment(java.lang.String strDoseComment) Sets Dose Comment.
void	setDoseGridScaling(java.lang.String strDoseGridScaling) Sets Scaling factor.
void	setDoseSummationType(EnumDoseSummationType enumDoseSummationType) Sets Type of dose summation.
void	setDoseType(EnumDoseType enumDoseType) Sets Type of dose.
void	setDoseUnits(EnumDoseUnits enumDoseUnits) Sets Dose axis units.
void	setGridFrameOffsetVector(java.lang.String[] arrstrGridFrameOffsetVector) Sets Grid Frame Offset Vector.
void	setHighBit(EnumHighBit enumHighBit) Sets High Bit.
void	setInstanceNumber(java.lang.String strInstanceNumber) Sets Instance Number.
void	setNormalizationPoint(java.lang.String[] arrstrNormalizationPoint) Sets Normalization Point.
void	setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation) Sets Photometric Interpretation.
void	setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation) Sets Pixel Representation.
void	setSamplesperPixel(EnumSamplesPerPixel enumSamplesperPixel) Sets Samples per Pixel.
void	setSpatialTransformOfDose(java.lang.String strSpatialTransformOfDose) Sets the Spatial Transform of Dose
void	setTissueHeterogeneityCorrection(EnumTissueHeterogeneityCorrection[] enumTissueHeterogeneityCorrection) Sets Tissue Heterogeneity Correction.
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

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

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

RTDoseModule

public RTDoseModule(IDataSet objIDataSet)

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setDoseUnits

public void setDoseUnits(EnumDoseUnits enumDoseUnits)

Sets Dose axis units. Enumerated Values : GY = Gray, RELATIVE = dose relative to reference value specified in DVH Normalization Dose Value (3004,0042).

Parameters:

enumDoseUnits - - Enum value of Dose Units

getDoseUnits

public java.lang.String getDoseUnits()

Retrieves Dose axis units.

Returns:

String - String value of Dose Units.

setSamplesperPixel

public void setSamplesperPixel(EnumSamplesPerPixel enumSamplesperPixel)

Sets Samples per Pixel. Number of samples (planes) in this image.

Parameters:

enumSamplesperPixel - - Short value of Samples per Pixel.

getSamplesperPixel

public short getSamplesperPixel()

Retrieves Samples per Pixel.

Returns:

the samplesper pixel

setPhotometricInterpretation

public void setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)

Sets Photometric Interpretation. Specifies the intended interpretation of the pixel data

Parameters:

enumPhotometricInterpretation - - String value of Photometric Interpretation.

getPhotometricInterpretation

public java.lang.String getPhotometricInterpretation()

Retrieves Photometric Interpretation.

Returns:

the photometric interpretation

setBitsAllocated

public void setBitsAllocated(EnumBitsAllocated enumBitsAllocated)

Sets Bits Allocated. Number of bits allocated for each pixel sample. Each sample shall have the same number of bits allocated.

Parameters:

enumBitsAllocated - the enum bits allocated

getBitsAllocated

public short getBitsAllocated()

Retrieves Bits Allocated.

Returns:

the bits allocated

setBitsStored

public void setBitsStored(EnumBitsStored enumBitsStored)

Sets Bits Stored. Number of bits stored for each pixel sample. Each sample shall have the same number of bits stored.

Parameters:

enumBitsStored - the enum bits stored

getBitsStored

public short getBitsStored()

Retrieves Bits Stored.

Returns:

the bits stored

setHighBit

public void setHighBit(EnumHighBit enumHighBit)

Sets High Bit. Most significant bit for each pixel sample. Each sample shall have the same high bit.

Parameters:

enumHighBit - - short value of High Bit.

getHighBit

public short getHighBit()

Retrieves High Bit.

Returns:

the high bit

setPixelRepresentation

public void setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation)

Sets Pixel Representation. Data representation of the pixel samples. Each sample shall have the same pixel representation.

Parameters:

enumPixelRepresentation - the enum pixel representation

getPixelRepresentation

public short getPixelRepresentation()

Retrieves Pixel Representation.

Returns:

the pixel representation

setDoseType

public void setDoseType(EnumDoseType enumDoseType)

Sets Type of dose.

Parameters:

enumDoseType - - Enum value of Dose Type.

getDoseType

public java.lang.String getDoseType()

Retrieves Dose Type.

Returns:

the dose type

setSpatialTransformOfDose

public void setSpatialTransformOfDose(java.lang.String strSpatialTransformOfDose)

Sets the Spatial Transform of Dose

Parameters:

strSpatialTransformOfDose - Specifies type of the value Spatial Transform of Dose

getSpatialTransformOfDose

public java.lang.String getSpatialTransformOfDose()

Retrieves type of the value Spatial Transform of Dose

Returns:

String - Type of the value Spatial Transform of Dose

getReferencedSpatialRegistrationSequence

public ReferencedSpatialRegistrationSequence getReferencedSpatialRegistrationSequence()

Retrieves sequence of Referenced SpatialRegistration

Returns:

- instance of ReferencedRTPlanSequence.

setInstanceNumber

public void setInstanceNumber(java.lang.String strInstanceNumber)

Sets Instance Number. A number that identifies this object instance.

Parameters:

strInstanceNumber - - String value of Instance Number.

getInstanceNumber

public java.lang.String getInstanceNumber()

Retrieves Instance Number.

Returns:

the instance number

setDoseComment

public void setDoseComment(java.lang.String strDoseComment)

Sets Dose Comment. User-defined comments for dose data.

Parameters:

strDoseComment - - String value of Dose Comment.

getDoseComment

public java.lang.String getDoseComment()

Retrieves Dose Comment.

Returns:

the dose comment

setNormalizationPoint

public void setNormalizationPoint(java.lang.String[] arrstrNormalizationPoint)

Sets Normalization Point.

Parameters:

arrstrNormalizationPoint - - String value of Normalization Point.

getNormalizationPoint

public java.lang.String[] getNormalizationPoint()

Retrieves Normalization Point.

Returns:

the normalization point

setDoseSummationType

public void setDoseSummationType(EnumDoseSummationType enumDoseSummationType)

Sets Type of dose summation.

Parameters:

enumDoseSummationType - - Enum value of Dose Summation Type.

getDoseSummationType

public java.lang.String getDoseSummationType()

Retrieves Dose Summation Type.

Returns:

the dose summation type

setGridFrameOffsetVector

public void setGridFrameOffsetVector(java.lang.String[] arrstrGridFrameOffsetVector)

Sets Grid Frame Offset Vector.

Parameters:

arrstrGridFrameOffsetVector - - String value of Grid Frame Offset Vector.

getGridFrameOffsetVector

public java.lang.String[] getGridFrameOffsetVector()

Retrieves Grid Frame Offset Vector.

Returns:

the grid frame offset vector

setDoseGridScaling

public void setDoseGridScaling(java.lang.String strDoseGridScaling)

Sets Scaling factor.

Parameters:

strDoseGridScaling - - String value of Dose Grid Scaling.

getDoseGridScaling

public java.lang.String getDoseGridScaling()

Retrieves Dose Grid Scaling.

Returns:

the dose grid scaling

setTissueHeterogeneityCorrection

public void setTissueHeterogeneityCorrection(EnumTissueHeterogeneityCorrection[] enumTissueHeterogeneityCorrection)

Sets Tissue Heterogeneity Correction. Specifies a list of patient heterogeneity characteristics used for calculating dose.

Parameters:

enumTissueHeterogeneityCorrection - - Enum value of Tissue Heterogeneity Correction.

getTissueHeterogeneityCorrection

public java.lang.String[] getTissueHeterogeneityCorrection()

Retrieves Tissue Heterogeneity Correction.

Returns:

the tissue heterogeneity correction

getReferencedRTPlanSequence

public ReferencedRTPlanSequence getReferencedRTPlanSequence()

Retrieves sequence of one Class/Instance pair describing RT Plan associated with dose.

Returns:

- instance of ReferencedRTPlanSequence.

getReferencedTreatmentRecordSequence

public ReferencedTreatmentRecordSequence getReferencedTreatmentRecordSequence()

Retrieves sequence of Referenced TreatmentRecord Sequence

Returns:

- instance of objRReferencedTreatmentRecordSequence.

getDerivationCodeSequence

public DerivationCodeSequence getDerivationCodeSequence()

Retrieves sequence of DerivationCodeSequence

Returns:

- instance of DerivationCodeSequence.

getReferencedInstanceSequence

public ReferencedInstanceSequence getReferencedInstanceSequence()

Retrieves sequence of ReferencedInstanceSequence

Returns:

- instance of ReferencedInstanceSequence.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

vector of Tags - returns the vector containing the collection of tags.