cdac.medinfo.sdk.dcm30_04.baselibs

Class DischargeDiagnosisCodeSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.DischargeDiagnosisCodeSequenceItem

All Implemented Interfaces:

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

public class DischargeDiagnosisCodeSequenceItem
extends Item

This Item class provides methods to set,get and validate attributes in DischargeDiagnosisCodeSequence

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCenterOfRotationOffset() Retrieves average center of rotation offset of Nuclear Medicine detector in mm.
java.lang.String	getCollimatorOrGridName() Retrieves Label describing the collimator used.
java.lang.String	getCollimatorType() Retrieves Collimator type.
java.lang.String	getDistanceSourceToDetector() Retrieves Distance in mm from transmission source to the detector face.
java.lang.String[]	getFieldOfViewDimensions() Retrieves Dimensions of the field of view, in mm.
java.lang.String	getFieldOfViewShape() Retrieves Shape of the field of view of the Nuclear Medicine detector.
java.lang.String[]	getFocalDistance() Return Focal distance, in mm.
java.lang.String	getGantryOrDetectorTilt() Retrieves angle of tilt in degrees of the detector.
java.lang.String[]	getImageOrientation() Return the direction cosines of the first row and the first column with respect to the patient.
java.lang.String[]	getImagePosition() Retrieves Tthe x, y, and z coordinates of the upper left hand corner (center of the first voxel transmitted) of the image, in mm.
java.lang.String[]	getRadialPosition() Retrieves radial distance of the detector from the center of rotation, in mm.
java.lang.String	getStartAngle() Retrieves position of the detector about the patient for the start of the acquisition, in degrees.
ViewCodeSequence	getViewCodeSequence() Retrieves pre-initialized object of View 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[]	getXFocusCenter() Return Center of focus along a row.
java.lang.String[]	getYFocusCenter() Retrieves Center of focus along a column.
java.lang.String[]	getZoomCenter() Retrieves the amount of offset from (0,0) applied to each pixel in the image before application of the zoom factor, specified by a numeric pair: row value (delimiter) column value (in mm).
java.lang.String[]	getZoomFactor() Return the amount of magnification applied to each pixel in the image, specified by a numeric pair: row value (delimiter) column value.
void	setCenterOfRotationOffset(java.lang.String strCenterOfRotationOffset) Sets average center of rotation offset of Nuclear Medicine detector in mm.
void	setCollimatorOrGridName(java.lang.String strCollimatorOrGridName) Sets Label describing the collimator used.
void	setCollimatorType(java.lang.String strCollimatorType) Sets Collimator type.
void	setDistanceSourceToDetector(java.lang.String strDistanceSourceToDetector) Sets Distance in mm from transmission source to the detector face.
void	setFieldOfViewDimensions(java.lang.String[] arrStrFieldOfViewDimensions) Sets Dimensions of the field of view, in mm.
void	setFieldOfViewShape(java.lang.String strFieldOfViewShape) Sets Shape of the field of view of the Nuclear Medicine detector.
void	setFocalDistance(java.lang.String[] arrStrFocalDistance) Sets Focal distance, in mm.
void	setGantryOrDetectorTilt(java.lang.String strGantryOrDetectorTilt) Sets angle of tilt in degrees of the detector.
void	setImageOrientation(java.lang.String[] arrStrImageOrientation) Sets the direction cosines of the first row and the first column with respect to the patient.
void	setImagePosition(java.lang.String[] arrStrImagePosition) Sets the x, y, and z coordinates of the upper left hand corner (center of the first voxel transmitted) of the image, in mm.
void	setRadialPosition(java.lang.String[] arrStrRadialPosition) Sets Radial distance of the detector from the center of rotation, in mm.
void	setStartAngle(java.lang.String strStartAngle) Sets position of the detector about the patient for the start of the acquisition, in degrees.
void	setXFocusCenter(java.lang.String[] arrStrXFocusCenter) Sets the Center of focus along a row.
void	setYFocusCenter(java.lang.String[] arrStrYFocusCenter) Sets Center of focus along a column.
void	setZoomCenter(java.lang.String[] arrStrZoomCenter) Sets the amount of offset from (0,0) applied to each pixel in the image before application of the zoom factor, specified by a numeric pair: row value (delimiter) column value (in mm).
void	setZoomFactor(java.lang.String[] arrStrZoomFactor) Sets the amount of magnification applied to each pixel in the image, specified by a numeric pair: row value (delimiter) column value.
boolean	validateForModule() Validates all the attributes in DischargeDiagnosisCodeSequenceItem 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

setCollimatorOrGridName

public void setCollimatorOrGridName(java.lang.String strCollimatorOrGridName)

Sets Label describing the collimator used.

Parameters:

strCollimatorOrGridName - String value of Collimator/Grid Name.

getCollimatorOrGridName

public java.lang.String getCollimatorOrGridName()

Retrieves Label describing the collimator used.

Returns:

String - value of Collimator/Grid Name.

setCollimatorType

public void setCollimatorType(java.lang.String strCollimatorType)

Sets Collimator type. Defined Terms: PARA = Parallel (default),PINH = Pinhole,FANB = Fan-beam,CONE = Cone-beam, SLNT = Slant hole,ASTG = Astigmatic,DIVG = Diverging,NONE = No collimator,UNKN = Unknown Required if a sequence Item is present.

Parameters:

strCollimatorType - String value of Collimator Type.

getCollimatorType

public java.lang.String getCollimatorType()

Retrieves Collimator type.

Returns:

String - value of Collimator Type.

setFieldOfViewShape

public void setFieldOfViewShape(java.lang.String strFieldOfViewShape)

Sets Shape of the field of view of the Nuclear Medicine detector. Defined Terms: RECTANGLE, ROUND,HEXAGONAL.

Parameters:

strFieldOfViewShape - String value of Field Of View Shape.

getFieldOfViewShape

public java.lang.String getFieldOfViewShape()

Retrieves Shape of the field of view of the Nuclear Medicine detector. Defined Terms: RECTANGLE, ROUND,HEXAGONAL.

Returns:

String - value of Field Of View Shape.

setFieldOfViewDimensions

public void setFieldOfViewDimensions(java.lang.String[] arrStrFieldOfViewDimensions)

Sets Dimensions of the field of view, in mm. If Field of View Shape (0018,1147) is: RECTANGLE: row dimension followed by column. ROUND: diameter. HEXAGONAL: diameter of a circumscribed circle.

Parameters:

arrStrFieldOfViewDimensions - String array of Field of View Dimension(s).

getFieldOfViewDimensions

public java.lang.String[] getFieldOfViewDimensions()

Retrieves Dimensions of the field of view, in mm.

Returns:

String[] - String array of Field of View Dimension(s).

setFocalDistance

public void setFocalDistance(java.lang.String[] arrStrFocalDistance)

Sets Focal distance, in mm. A value of 0 means infinite distance for parallel collimation.

Parameters:

arrStrFocalDistance - String array of Focal Distance values.

getFocalDistance

public java.lang.String[] getFocalDistance()

Return Focal distance, in mm.

Returns:

String - array of Focal Distance values.

setXFocusCenter

public void setXFocusCenter(java.lang.String[] arrStrXFocusCenter)

Sets the Center of focus along a row.

Parameters:

arrStrXFocusCenter - String array of X Focus Center values.

getXFocusCenter

public java.lang.String[] getXFocusCenter()

Return Center of focus along a row.

Returns:

String[] - String array of X Focus Center values.

setYFocusCenter

public void setYFocusCenter(java.lang.String[] arrStrYFocusCenter)

Sets Center of focus along a column.

Parameters:

arrStrYFocusCenter - String array of Y Focus Center values.

getYFocusCenter

public java.lang.String[] getYFocusCenter()

Retrieves Center of focus along a column.

Returns:

String[] - String array of Y Focus Center values.

setZoomCenter

public void setZoomCenter(java.lang.String[] arrStrZoomCenter)

Sets the amount of offset from (0,0) applied to each pixel in the image before application of the zoom factor, specified by a numeric pair: row value (delimiter) column value (in mm).

Parameters:

arrStrZoomCenter - String array of Zoom Center values.

getZoomCenter

public java.lang.String[] getZoomCenter()

Retrieves the amount of offset from (0,0) applied to each pixel in the image before application of the zoom factor, specified by a numeric pair: row value (delimiter) column value (in mm).

Returns:

String[] - String array of Zoom Center values.

setZoomFactor

public void setZoomFactor(java.lang.String[] arrStrZoomFactor)

Sets the amount of magnification applied to each pixel in the image, specified by a numeric pair: row value (delimiter) column value.

Parameters:

arrStrZoomFactor - String array of Zoom Factor values.

getZoomFactor

public java.lang.String[] getZoomFactor()

Return the amount of magnification applied to each pixel in the image, specified by a numeric pair: row value (delimiter) column value.

Returns:

String[] - String array of Zoom Factor values.

setCenterOfRotationOffset

public void setCenterOfRotationOffset(java.lang.String strCenterOfRotationOffset)

Sets average center of rotation offset of Nuclear Medicine detector in mm.

Parameters:

strCenterOfRotationOffset - String value of Center of Rotation Offset.

getCenterOfRotationOffset

public java.lang.String getCenterOfRotationOffset()

Retrieves average center of rotation offset of Nuclear Medicine detector in mm.

Returns:

String - value of Center of Rotation Offset.

setGantryOrDetectorTilt

public void setGantryOrDetectorTilt(java.lang.String strGantryOrDetectorTilt)

Sets angle of tilt in degrees of the detector.

Parameters:

strGantryOrDetectorTilt - String value of Gantry/Detector Tilt.

getGantryOrDetectorTilt

public java.lang.String getGantryOrDetectorTilt()

Retrieves angle of tilt in degrees of the detector.

Returns:

String - value of Gantry/Detector Tilt.

setDistanceSourceToDetector

public void setDistanceSourceToDetector(java.lang.String strDistanceSourceToDetector)

Sets Distance in mm from transmission source to the detector face. Required if Image Type (0008,0008) Value 4 is TRANSMISSION, Value 3 is not TOMO, and a sequence Item is present.

Parameters:

strDistanceSourceToDetector - String value of Distance Source to Detector.

getDistanceSourceToDetector

public java.lang.String getDistanceSourceToDetector()

Retrieves Distance in mm from transmission source to the detector face.

Returns:

String - value of Distance Source to Detector.

setStartAngle

public void setStartAngle(java.lang.String strStartAngle)

Sets position of the detector about the patient for the start of the acquisition, in degrees. Zero degrees is referenced to the origin at the patient's back. Viewing from the patient's feet, angle increases in a counterclockwise direction (detector normal rotating from the patient's back towards the patient's left side). Should not be included if Image Type (0008,0008), Value 3, is TOMO, GATED TOMO, RECON TOMO or RECON GATED TOMO.

Parameters:

strStartAngle - String value of Start Angle.

getStartAngle

public java.lang.String getStartAngle()

Retrieves position of the detector about the patient for the start of the acquisition, in degrees.

Returns:

String - value of Start Angle.

setRadialPosition

public void setRadialPosition(java.lang.String[] arrStrRadialPosition)

Sets Radial distance of the detector from the center of rotation, in mm. Should not be included if Image Type (0008,0008), Value 3, is TOMO, GATED TOMO, RECON TOMO or RECON GATED TOMO.

Parameters:

arrStrRadialPosition - String array of Radial Position values.

getRadialPosition

public java.lang.String[] getRadialPosition()

Retrieves radial distance of the detector from the center of rotation, in mm.

Returns:

String[] - String array of Radial Position values.

setImageOrientation

public void setImageOrientation(java.lang.String[] arrStrImageOrientation)

Sets the direction cosines of the first row and the first column with respect to the patient.

Parameters:

arrStrImageOrientation - String array of Image Orientation values.

getImageOrientation

public java.lang.String[] getImageOrientation()

Return the direction cosines of the first row and the first column with respect to the patient.

Returns:

String[] - String array of Image Orientation values.

setImagePosition

public void setImagePosition(java.lang.String[] arrStrImagePosition)

Sets the x, y, and z coordinates of the upper left hand corner (center of the first voxel transmitted) of the image, in mm.

Parameters:

arrStrImagePosition - String array of Image Position values.

getImagePosition

public java.lang.String[] getImagePosition()

Retrieves Tthe x, y, and z coordinates of the upper left hand corner (center of the first voxel transmitted) of the image, in mm.

Returns:

String[] - String array of Image Position values.

getViewCodeSequence

public ViewCodeSequence getViewCodeSequence()

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

ViewCodeSequence - instance of ViewCodeSequence.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in DischargeDiagnosisCodeSequenceItem 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.