cdac.medinfo.sdk.dcm30_04.baselibs

Class DVHSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.DVHSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class DVHSequenceItem
extends Item

This item class contains the methods to set,get and validate the attribute present in DVH Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDoseType() Retrieves Dose Type.
java.lang.String	getDoseUnits() Retrieves Dose axis units.
java.lang.String[]	getDVHData() Retrieves a data stream describing the dose bin widths Dn and associated volumes Vn in DVH Volume Units (3004,0054) in the order D1V1, D2V2, ...
java.lang.String	getDVHDoseScaling() Retrieves DVH Dose Scaling factor.
java.lang.String	getDVHMaximumDose() Retrieves Maximum calculated dose to ROI(s) described by DVH Referenced ROI Sequence (3004,0060).
java.lang.String	getDVHMeanDose() Retrieves Mean calculated dose to ROI(s) described by DVH Referenced ROI Sequence (3004,0060).
java.lang.String	getDVHMinimumDose() Retrieves Minimum calculated dose to ROI(s) described by DVH Referenced ROI Sequence (3004,0060).
java.lang.String	getDVHNumberOfBins() Retrieves Number of bins n used to store DVH Data (3004,0058).
DVHReferencedROISequence	getDVHReferencedROISequence() Retrieves pre-initialized object of DVH Referenced ROI 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
java.lang.String	getDVHType() Retrieves Type of DVH
java.lang.String	getDVHVolumeUnits() Retrieves Volume axis units.
void	setDoseType(EnumDoseType enumDoseType) Sets Dose Type.
void	setDoseUnits(EnumDoseUnits enumDoseUnits) Sets Dose axis units.
void	setDVHData(java.lang.String[] arrDVHData) Sets A data stream describing the dose bin widths Dn and associated volumes Vn in DVH Volume Units (3004,0054) in the order D1V1, D2V2, ...
void	setDVHDoseScaling(java.lang.String strDVHDoseScaling) Sets Scaling factor that when multiplied by the dose bin widths found in DVH Data (3004,0058), yields dose bin widths in the dose units as specified by Dose Units 3004,0002.
void	setDVHMaximumDose(java.lang.String strDVHMaximumDose) Sets Maximum calculated dose to ROI(s) described by DVH Referenced ROI Sequence (3004,0060).
void	setDVHMeanDose(java.lang.String strDVHMeanDose) Sets Mean calculated dose to ROI(s) described by DVH Referenced ROI Sequence (3004,0060).
void	setDVHMinimumDose(java.lang.String strDVHMinimumDose) Sets Minimum calculated dose to ROI(s) described by DVH Referenced ROI Sequence (3004,0060).
void	setDVHNumberOfBins(java.lang.String strDVHNumberOfBins) Sets Number of bins n used to store DVH Data (3004,0058).
void	setDVHType(EnumDVHType enumDVHType) Sets Type of DVH.
void	setDVHVolumeUnits(EnumDVHVolumeUnits enumDVHVolumeUnits) Sets Volume axis units.
boolean	validateForModule() Validates all the attributes in DVHSequenceItem that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

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

Method Detail

getDVHReferencedROISequence

public DVHReferencedROISequence getDVHReferencedROISequence()

Retrieves pre-initialized object of DVH Referenced ROI 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:

DVHReferencedROISequence - instance of DVH Referenced ROI Sequence.

setDVHType

public void setDVHType(EnumDVHType enumDVHType)

Sets Type of DVH. Enumerated Values: DIFFERENTIAL = differential dose-volume histogram, CUMULATIVE = cumulative dose-volume histogram, NATURAL = natural dose volume histogram.

Parameters:

enumDVHType - Enum value of DVH Type

getDVHType

public java.lang.String getDVHType()

Retrieves Type of DVH

Returns:

String - value of DVH Type.

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 - value of Dose Units.

setDoseType

public void setDoseType(EnumDoseType enumDoseType)

Sets Dose Type. Defined Terms: PHYSICAL = physical dose EFFECTIVE = physical dose after correction for biological effect using userdefined modeling technique ERROR = difference between desired and planned dose

Parameters:

enumDoseType - Enum value of Dose Type

getDoseType

public java.lang.String getDoseType()

Retrieves Dose Type.

Returns:

String - value of Dose Type.

setDVHDoseScaling

public void setDVHDoseScaling(java.lang.String strDVHDoseScaling)

Sets Scaling factor that when multiplied by the dose bin widths found in DVH Data (3004,0058), yields dose bin widths in the dose units as specified by Dose Units 3004,0002.

Parameters:

strDVHDoseScaling - String value of DVH Dose Scaling.

getDVHDoseScaling

public java.lang.String getDVHDoseScaling()

Retrieves DVH Dose Scaling factor.

Returns:

String - value of DVH Dose Scaling.

setDVHVolumeUnits

public void setDVHVolumeUnits(EnumDVHVolumeUnits enumDVHVolumeUnits)

Sets Volume axis units. Defined Terms: CM3 = cubic centimeters, PERCENT = percent, PER_U= volume per u with u(dose)=dose-3/2

Parameters:

enumDVHVolumeUnits - Enum value of DVH Volume Units

getDVHVolumeUnits

public java.lang.String getDVHVolumeUnits()

Retrieves Volume axis units.

Returns:

String - value of DVH Volume Units.

setDVHNumberOfBins

public void setDVHNumberOfBins(java.lang.String strDVHNumberOfBins)

Sets Number of bins n used to store DVH Data (3004,0058).

Parameters:

strDVHNumberOfBins - String value of DVH Number of Bins.

getDVHNumberOfBins

public java.lang.String getDVHNumberOfBins()

Retrieves Number of bins n used to store DVH Data (3004,0058).

Returns:

String - value of DVH Number of Bins.

setDVHData

public void setDVHData(java.lang.String[] arrDVHData)

Sets A data stream describing the dose bin widths Dn and associated volumes Vn in DVH Volume Units (3004,0054) in the order D1V1, D2V2, ... DnVn.

Parameters:

arrDVHData - String array value of DVH Data.

getDVHData

public java.lang.String[] getDVHData()

Retrieves a data stream describing the dose bin widths Dn and associated volumes Vn in DVH Volume Units (3004,0054) in the order D1V1, D2V2, ... DnVn.

Returns:

String - value of DVH Data.

setDVHMinimumDose

public void setDVHMinimumDose(java.lang.String strDVHMinimumDose)

Sets Minimum calculated dose to ROI(s) described by DVH Referenced ROI Sequence (3004,0060).

Parameters:

strDVHMinimumDose - String value of DVH Minimum Dose.

getDVHMinimumDose

public java.lang.String getDVHMinimumDose()

Retrieves Minimum calculated dose to ROI(s) described by DVH Referenced ROI Sequence (3004,0060).

Returns:

String - value of DVH Minimum Dose.

setDVHMaximumDose

public void setDVHMaximumDose(java.lang.String strDVHMaximumDose)

Sets Maximum calculated dose to ROI(s) described by DVH Referenced ROI Sequence (3004,0060).

Parameters:

strDVHMaximumDose - String value of DVH Maximum Dose.

getDVHMaximumDose

public java.lang.String getDVHMaximumDose()

Retrieves Maximum calculated dose to ROI(s) described by DVH Referenced ROI Sequence (3004,0060).

Returns:

String - value of DVH Maximum Dose.

setDVHMeanDose

public void setDVHMeanDose(java.lang.String strDVHMeanDose)

Sets Mean calculated dose to ROI(s) described by DVH Referenced ROI Sequence (3004,0060).

Parameters:

strDVHMeanDose - String value of DVH Mean Dose.

getDVHMeanDose

public java.lang.String getDVHMeanDose()

Retrieves Mean calculated dose to ROI(s) described by DVH Referenced ROI Sequence (3004,0060).

Returns:

String - value of DVH Mean Dose.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in DVHSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.