cdac.medinfo.sdk.dcm30_04.baselibs

Class ROIContourSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.ROIContourSequenceItem

All Implemented Interfaces:

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

public class ROIContourSequenceItem
extends Item

This item class contains methods to validate,set and get the attributes in ROIContourSequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
ContourSequence	getContourSequence() Retrieves pre-initialized object of Contour 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.
short[]	getRecommendedDisplayCIELabValue() Retrieves RecommendedDisplayCIELabValue
short	getRecommendedDisplayGrayscaleValue() Retrieves default single gray unsigned value in which it is recommended thatthe contour be rendered on a monochrome display.
java.lang.String	getReferencedROINumber() Retrieves value that uniquely identifies the referenced ROI described in the Structure Set ROI Sequence (3006,0020).
java.lang.String[]	getROIDisplayColor() Retrieves RGB triplet color representation for ROI, specified using the range 0-255.
void	setRecommendedDisplayCIELabValue(short[] arrShRecommendedDisplayCIELabValue)
void	setRecommendedDisplayGrayscaleValue(short shRecommendedDisplayGrayscaleValue) Sets default single gray unsigned value in which it is recommended thatthe contour be rendered on a monochrome display.
void	setReferencedROINumber(java.lang.String strReferencedROINumber) Sets value that uniquely identifies the referenced ROI described in the Structure Set ROI Sequence (3006,0020).
void	setROIDisplayColor(java.lang.String[] arrStrROIDisplayColor) Sets RGB triplet color representation for ROI, specified using the range 0-255.
boolean	validateForModule() Validates all the attributes in ROIContourSequenceItem according the rules defined by the Contour Sequence.

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

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in ROIContourSequenceItem according the rules defined by the Contour Sequence.

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.

setReferencedROINumber

public void setReferencedROINumber(java.lang.String strReferencedROINumber)

Sets value that uniquely identifies the referenced ROI described in the Structure Set ROI Sequence (3006,0020).

Parameters:

strReferencedROINumber - String value of Referenced ROI Number.

getReferencedROINumber

public java.lang.String getReferencedROINumber()

Retrieves value that uniquely identifies the referenced ROI described in the Structure Set ROI Sequence (3006,0020).

Returns:

String - value of Referenced ROI Number.

setROIDisplayColor

public void setROIDisplayColor(java.lang.String[] arrStrROIDisplayColor)

Sets RGB triplet color representation for ROI, specified using the range 0-255.

Parameters:

arrStrROIDisplayColor - String array value of ROI Display Color.

getROIDisplayColor

public java.lang.String[] getROIDisplayColor()

Retrieves RGB triplet color representation for ROI, specified using the range 0-255.

Returns:

String - array value of ROI Display Color.

setRecommendedDisplayGrayscaleValue

public void setRecommendedDisplayGrayscaleValue(short shRecommendedDisplayGrayscaleValue)

Sets default single gray unsigned value in which it is recommended thatthe contour be rendered on a monochrome display.

Parameters:

shRecommendedDisplayGrayscaleValue - short value of RecommendedDisplayGrayscaleValue

getRecommendedDisplayGrayscaleValue

public short getRecommendedDisplayGrayscaleValue()

Retrieves default single gray unsigned value in which it is recommended thatthe contour be rendered on a monochrome display.

Returns:

short - short value of RecommendedDisplayGrayscaleValue

setRecommendedDisplayCIELabValue

public void setRecommendedDisplayCIELabValue(short[] arrShRecommendedDisplayCIELabValue)

getRecommendedDisplayCIELabValue

public short[] getRecommendedDisplayCIELabValue()

Retrieves RecommendedDisplayCIELabValue

Returns:

short Array of RecommendedDisplayCIELabValue

getContourSequence

public ContourSequence getContourSequence()

Retrieves pre-initialized object of Contour 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:

ContourSequence - instance of ContourSequence.