cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RTDVHModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RTDVHModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RTDVHModule
extends Module

The RT DVH module provides for the inclusion of differential or cumulative dose volume histogram data. The data contained within this module may supplement dose data in the RT Dose and/or RT Dose ROI modules, or it may be present in the absence of other dose data.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RTDVHModule(IDataSet objIDataSet) Instantiates a new rTDVH module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDVHNormalizationDoseValue() Retrieves the DVH Normalization Dose Value.
java.lang.String[]	getDVHNormalizationPoint() Retrieves DVH Normalization Point.
DVHSequence	getDVHSequence() Retrieves pre-initialized object of DVH Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
ReferencedStructureSetSequence	getReferencedStructureSetSequence() Retrieves pre-initialized object of Referenced Structure Set Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setDVHNormalizationDoseValue(java.lang.String strDVHNormalizationDoseValue) The method is used to set DVH Normalization Dose Value.
void	setDVHNormalizationPoint(java.lang.String[] arrStrDVHNormalizationPoint) This method is used to set Coordinates (x, y, z) of common DVH normalization point in the patient based coordinate system.
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

RTDVHModule

public RTDVHModule(IDataSet objIDataSet)

Instantiates a new rTDVH module.

Parameters:

objIDataSet - the obj i data set

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

getReferencedStructureSetSequence

public ReferencedStructureSetSequence getReferencedStructureSetSequence()

Retrieves pre-initialized object of Referenced Structure Set Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

ReferencedStructureSetSequence - instance of Referenced Structure Set Sequence.

setDVHNormalizationPoint

public void setDVHNormalizationPoint(java.lang.String[] arrStrDVHNormalizationPoint)

This method is used to set Coordinates (x, y, z) of common DVH normalization point in the patient based coordinate system. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

Parameters:

arrStrDVHNormalizationPoint - : String array of DVH Normalization Point

getDVHNormalizationPoint

public java.lang.String[] getDVHNormalizationPoint()

Retrieves DVH Normalization Point.

Returns:

- String array of DVH Normalization Point

setDVHNormalizationDoseValue

public void setDVHNormalizationDoseValue(java.lang.String strDVHNormalizationDoseValue)

The method is used to set DVH Normalization Dose Value. Dose Value at DVH Normalization Point (3004,0040) used as reference for individual DVHs when Dose Units (3004,0002) is RELATIVE. The function accepts a String Value strDVHNormalizationDose Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strDVHNormalizationDoseValue - :String value of DVH Normalization Dose Value

getDVHNormalizationDoseValue

public java.lang.String getDVHNormalizationDoseValue()

Retrieves the DVH Normalization Dose Value.

Returns:

- String value of DVH Normalization Dose Value

getDVHSequence

public DVHSequence getDVHSequence()

Retrieves pre-initialized object of DVH Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

DVHSequence - instance of DVH Sequence.

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