cdac.medinfo.sdk.dcm30_04.baselibs

Class ContourSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.ContourSequenceItem

All Implemented Interfaces:

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

public class ContourSequenceItem
extends Item

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

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getAttachedContours() Retrieves list of Contour Number (3006,0048) defining lower-numbered contour(s) to which the current contour is connected.
java.lang.String[]	getContourData() Retrieves Sequence of (x,y,z) triplets defining a contour in the patient based coordinate system.
java.lang.String	getContourGeometricType() Retrieves geometric type of contour.
ContourImageSequence	getContourImageSequence() Retrieves pre-initialized object of Contour Image 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	getContourNumber() Retrieves identification number of the contour.
java.lang.String[]	getContourOffsetVector() Retrieves a Vector (x,y,z) in the the patient based coordinate system which is normal to plane of Contour Data (3006,0050), describing direction and magnitude of the offset (in mm) of each point of the central plane of a contour slab from the corresponding original point of Contour Data (3006,0050).
java.lang.String	getContourSlabThickness() Retrieves Contour Slab Thickness which specifies the thickness of a slab.
java.lang.String	getNumberOfContourPoints() Retrieves number of points (triplets) in Contour Data (3006,0050).
void	setAttachedContours(java.lang.String[] arrStrAttachedContours) Sets list of Contour Number (3006,0048) defining lower-numbered contour(s) to which the current contour is connected.
void	setContourData(java.lang.String[] arrStrContourData) Sets Sequence of (x,y,z) triplets defining a contour in the patient based coordinate system.
void	setContourGeometricType(EnumContourGeometricType enumContourGeometricType) Sets geometric type of contour.
void	setContourNumber(java.lang.String strContourNumber) Sets identification number of the contour.
void	setContourOffsetVector(java.lang.String[] arrStrContourOffsetVector) Sets a Vector (x,y,z) in the the patient based coordinate system which is normal to plane of Contour Data (3006,0050), describing direction and magnitude of the offset (in mm) of each point of the central plane of a contour slab from the corresponding original point of Contour Data (3006,0050).
void	setContourSlabThickness(java.lang.String strContourSlabThickness) Sets Contour Slab Thickness which specifies the thickness of a slab.
void	setNumberOfContourPoints(java.lang.String strNumberOfContourPoints) Sets number of points (triplets) in Contour Data (3006,0050).
boolean	validateForModule() Validates all the attributes in ContourSequenceItem 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 ContourSequenceItem 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.

setContourNumber

public void setContourNumber(java.lang.String strContourNumber)

Sets identification number of the contour.

Parameters:

strContourNumber - String value of Contour Number.

getContourNumber

public java.lang.String getContourNumber()

Retrieves identification number of the contour.

Returns:

String - value of Contour Number.

setAttachedContours

public void setAttachedContours(java.lang.String[] arrStrAttachedContours)

Sets list of Contour Number (3006,0048) defining lower-numbered contour(s) to which the current contour is connected.

Parameters:

arrStrAttachedContours - String array value of Attached Contours .

getAttachedContours

public java.lang.String[] getAttachedContours()

Retrieves list of Contour Number (3006,0048) defining lower-numbered contour(s) to which the current contour is connected.

Returns:

String - array value of Attached Contours .

setContourGeometricType

public void setContourGeometricType(EnumContourGeometricType enumContourGeometricType)

Sets geometric type of contour.

Parameters:

enumContourGeometricType - enum value of Contour Geometric Type.

getContourGeometricType

public java.lang.String getContourGeometricType()

Retrieves geometric type of contour.

Returns:

String - value of Contour Geometric Type.

setContourSlabThickness

public void setContourSlabThickness(java.lang.String strContourSlabThickness)

Sets Contour Slab Thickness which specifies the thickness of a slab.

Parameters:

strContourSlabThickness - String value of Contour Slab Thickness.

getContourSlabThickness

public java.lang.String getContourSlabThickness()

Retrieves Contour Slab Thickness which specifies the thickness of a slab.

Returns:

String - value of Contour Slab Thickness.

setContourOffsetVector

public void setContourOffsetVector(java.lang.String[] arrStrContourOffsetVector)

Sets a Vector (x,y,z) in the the patient based coordinate system which is normal to plane of Contour Data (3006,0050), describing direction and magnitude of the offset (in mm) of each point of the central plane of a contour slab from the corresponding original point of Contour Data (3006,0050).

Parameters:

arrStrContourOffsetVector - String array value of Contour Offset Vector.

getContourOffsetVector

public java.lang.String[] getContourOffsetVector()

Retrieves a Vector (x,y,z) in the the patient based coordinate system which is normal to plane of Contour Data (3006,0050), describing direction and magnitude of the offset (in mm) of each point of the central plane of a contour slab from the corresponding original point of Contour Data (3006,0050).

Returns:

String - array value of Contour Offset Vector.

setNumberOfContourPoints

public void setNumberOfContourPoints(java.lang.String strNumberOfContourPoints)

Sets number of points (triplets) in Contour Data (3006,0050).

Parameters:

strNumberOfContourPoints - String value of Number of Contour Points.

getNumberOfContourPoints

public java.lang.String getNumberOfContourPoints()

Retrieves number of points (triplets) in Contour Data (3006,0050).

Returns:

String - value of Number of Contour Points.

setContourData

public void setContourData(java.lang.String[] arrStrContourData)

Sets Sequence of (x,y,z) triplets defining a contour in the patient based coordinate system.

Parameters:

arrStrContourData - String array value of Contour Data.

getContourData

public java.lang.String[] getContourData()

Retrieves Sequence of (x,y,z) triplets defining a contour in the patient based coordinate system.

Returns:

String - array value of Contour Data.

getContourImageSequence

public ContourImageSequence getContourImageSequence()

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

ContourImageSequence - instance of ContourImageSequence.