cdac.medinfo.sdk.dcm30_04.baselibs

Class FiducialSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.FiducialSequenceItem

All Implemented Interfaces:

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

public class FiducialSequenceItem
extends Item

A sequence that specifies one or more fiducials, one item per fiducial.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getContourData() Retrieves the coordinates of this item's fiducial.
double	getContourUncertaintyRadius() Retrieves the coordinates of this item's fiducial.
java.lang.String	getFiducialDescription() Retrieves the User description or comments about the fiducial.
java.lang.String	getFiducialIdentifier() Retrieves a fiducial assignment identifier that is unique within this Fiducial Sequence item but may match the fiducial identifier of an equivalent feature in another item.
FiducialIdentifierCodeSequence	getFiducialIdentifierCodeSequence() Retrieves pre-initialized object of Fiducial Identifier Code 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	getFiducialUID() Retrieves the Globally unique identifier for the fiducial instance of this fiducial assignment.
GraphicCoordinatesDataSequence	getGraphicCoordinatesDataSequence() Retrieves pre-initialized object of Graphic Coordinates Data 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	getNumberofContourPoints() Retrieves Number of points (triplets) in Contour Data
java.lang.String	getShapeType() Retrieves Shape Type (0070,0306) defines the geometric interpretation of the Contour Data (3006,0050.
void	setContourData(java.lang.String[] arrstrContourData) Sets the coordinates of this item's fiducial.
void	setContourUncertaintyRadius(double dblContourUncertaintyRadius) Sets the coordinates of this item's fiducial.
void	setFiducialDescription(java.lang.String strFiducialDescription) Sets the User description or comments about the fiducial.
void	setFiducialIdentifier(java.lang.String strFiducialIdentifier) Sets a fiducial assignment identifier that is unique within this Fiducial Sequence item but may match the fiducial identifier of an equivalent feature in another item.
void	setFiducialUID(java.lang.String strFiducialUID) Sets the Globally unique identifier for the fiducial instance of this fiducial assignment.
void	setNumberofContourPoints(java.lang.String strNumberofContourPoints) Sets Number of points (triplets) in Contour Data
void	setShapeType(EnumShapeType enumShapeType) Sets Shape Type (0070,0306) defines the geometric interpretation of the Contour Data (3006,0050) in terms of EnumShapeType.
boolean	validateForModule() Validates all the attributes in Fiducial Sequence Item 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

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in Fiducial Sequence Item 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 - If Mandatory or Conditional element fails.

setFiducialIdentifier

public void setFiducialIdentifier(java.lang.String strFiducialIdentifier)

Sets a fiducial assignment identifier that is unique within this Fiducial Sequence item but may match the fiducial identifier of an equivalent feature in another item.

Parameters:

strFiducialIdentifier - String value of fiducial assignment identifier

getFiducialIdentifier

public java.lang.String getFiducialIdentifier()

Retrieves a fiducial assignment identifier that is unique within this Fiducial Sequence item but may match the fiducial identifier of an equivalent feature in another item.

Returns:

String - value of fiducial assignment identifier

setFiducialUID

public void setFiducialUID(java.lang.String strFiducialUID)

Sets the Globally unique identifier for the fiducial instance of this fiducial assignment.

Parameters:

strFiducialUID - String value of Globally unique identifier

getFiducialUID

public java.lang.String getFiducialUID()

Retrieves the Globally unique identifier for the fiducial instance of this fiducial assignment.

Returns:

String - value of Globally unique identifier

setFiducialDescription

public void setFiducialDescription(java.lang.String strFiducialDescription)

Sets the User description or comments about the fiducial.

Parameters:

strFiducialDescription - String value of User description

getFiducialDescription

public java.lang.String getFiducialDescription()

Retrieves the User description or comments about the fiducial.

Returns:

String - value of User description

setShapeType

public void setShapeType(EnumShapeType enumShapeType)

Sets Shape Type (0070,0306) defines the geometric interpretation of the Contour Data (3006,0050) in terms of EnumShapeType.

Parameters:

enumShapeType - Enum value for geometric interpretation of the Contour Data

getShapeType

public java.lang.String getShapeType()

Retrieves Shape Type (0070,0306) defines the geometric interpretation of the Contour Data (3006,0050.

Returns:

String - value for geometric interpretation of the Contour Data

setNumberofContourPoints

public void setNumberofContourPoints(java.lang.String strNumberofContourPoints)

Sets Number of points (triplets) in Contour Data

Parameters:

strNumberofContourPoints - String value of Number of points

getNumberofContourPoints

public java.lang.String getNumberofContourPoints()

Retrieves Number of points (triplets) in Contour Data

Returns:

String - value of Number of points

setContourData

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

Sets the coordinates of this item's fiducial.

Parameters:

arrstrContourData - String array of coordinates

getContourData

public java.lang.String[] getContourData()

Retrieves the coordinates of this item's fiducial.

Returns:

[]String - value of coordinates

setContourUncertaintyRadius

public void setContourUncertaintyRadius(double dblContourUncertaintyRadius)

Sets the coordinates of this item's fiducial.

Parameters:

dblContourUncertaintyRadius - String array of coordinates

getContourUncertaintyRadius

public double getContourUncertaintyRadius()

Retrieves the coordinates of this item's fiducial.

Returns:

double - double value of coordinates

getFiducialIdentifierCodeSequence

public FiducialIdentifierCodeSequence getFiducialIdentifierCodeSequence()

Retrieves pre-initialized object of Fiducial Identifier Code 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:

FiducialIdentifierCodeSequence - instance of Fiducial Identifier Code Sequence.

getGraphicCoordinatesDataSequence

public GraphicCoordinatesDataSequence getGraphicCoordinatesDataSequence()

Retrieves pre-initialized object of Graphic Coordinates Data 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:

GraphicCoordinatesDataSequence - instance of Graphic Coordinates Data Sequence.