cdac.medinfo.sdk.dcm30_04.baselibs

Class RotationInformationSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.RotationInformationSequenceItem

All Implemented Interfaces:

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

public class RotationInformationSequenceItem
extends Item

This item class contains methods used to set,get and validate the attributes in Rotation Information Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getActualFrameDuration() Retrieves nominal acquisition time per angular position, in msec.
java.lang.String	getAngularStep() Retrieves the angular scan arc step between views of the TOMO acquisition, in degrees.
java.lang.String[]	getDistanceSourceToDetector() Retrieves distance in mm from transmission source to the detector face.
short	getNumberOfFramesInRotation() Retrieves Number of angular views in this rotation.
java.lang.String[]	getRadialPosition() Retrieves radial distance of the detector from the center of rotation, in mm.
java.lang.String	getRotationDirection() Retrieves direction of rotation of the detector about the patient.
java.lang.String	getScanArc() Retrieves effective angular range of the scan data in degrees.
java.lang.String	getStartAngle() Retrieves position of the detector about the patient for the start of this rotation, in degrees.
java.lang.String	getTableHeight() Retrieves distance in mm of the top of the patient table to the center of rotation.
java.lang.String	getTableTraverse() Retrieves location of the patient table (or gantry relative to the table) in mm.
void	setActualFrameDuration(java.lang.String strActualFrameDuration) Sets nominal acquisition time per angular position, in msec.
void	setAngularStep(java.lang.String strAngularStep) Sets the angular scan arc step between views of the TOMO acquisition, in degrees.
void	setDistanceSourceToDetector(java.lang.String[] arrStrRadialPosition) Sets Distance in mm from transmission source to the detector face.
void	setNumberOfFramesInRotation(short shNumberOfFramesInRotation) Sets number of angular views in this rotation.
void	setRadialPosition(java.lang.String[] arrStrRadialPosition) Sets Radial distance of the detector from the center of rotation, in mm.
void	setRotationDirection(EnumRotationDirection enumRotationDirection) Sets direction of rotation of the detector about the patient.
void	setScanArc(java.lang.String strScanArc) Sets the effective angular range of the scan data in degrees.
void	setStartAngle(java.lang.String strStartAngle) Sets position of the detector about the patient for the start of this rotation, in degrees.
void	setTableHeight(java.lang.String strTableHeight) Sets the distance in mm of the top of the patient table to the center of rotation.
void	setTableTraverse(java.lang.String strTableTraverse) Sets location of the patient table (or gantry relative to the table) in mm.The range and values of this element are determined by the manufacturer.
boolean	validateForModule() Validates all the attributes in RotationInformationSequenceItem 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 RotationInformationSequenceItem 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.

setStartAngle

public void setStartAngle(java.lang.String strStartAngle)

Sets position of the detector about the patient for the start of this rotation, 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). Required if a sequence Item is present.

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 this rotation, in degrees.

Returns:

String - value of Start Angle.

setAngularStep

public void setAngularStep(java.lang.String strAngularStep)

Sets the angular scan arc step between views of the TOMO acquisition, in degrees.

Parameters:

strAngularStep - String value of Angular Step.

getAngularStep

public java.lang.String getAngularStep()

Retrieves the angular scan arc step between views of the TOMO acquisition, in degrees.

Returns:

String - value of Angular Step.

setRotationDirection

public void setRotationDirection(EnumRotationDirection enumRotationDirection)

Sets direction of rotation of the detector about the patient. See Start Angle (0054,0200) for further explanation of direction. Enumerated Values: CW = clockwise (decreasing angle), CC = counter-clockwise (increasing angle).

Parameters:

enumRotationDirection - enum value of direction of rotation of the detector about the patient.

getRotationDirection

public java.lang.String getRotationDirection()

Retrieves direction of rotation of the detector about the patient.

Returns:

String - value of Rotation Direction.

setScanArc

public void setScanArc(java.lang.String strScanArc)

Sets the effective angular range of the scan data in degrees. The value shall be positive. Required if a sequence Item is present.

Parameters:

strScanArc - String value of Scan Arc.

getScanArc

public java.lang.String getScanArc()

Retrieves effective angular range of the scan data in degrees.

Returns:

String - value of Scan Arc.

setActualFrameDuration

public void setActualFrameDuration(java.lang.String strActualFrameDuration)

Sets nominal acquisition time per angular position, in msec.

Parameters:

strActualFrameDuration - String value of Actual Frame Duration.

getActualFrameDuration

public java.lang.String getActualFrameDuration()

Retrieves nominal acquisition time per angular position, in msec.

Returns:

String - value of Actual Frame Duration.

setRadialPosition

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

Sets Radial distance of the detector from the center of rotation, in mm. It shall have a single value which is an average value for this rotation, or it shall have one value per angular view.

Parameters:

arrStrRadialPosition - String array of Radial Position.

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.

setDistanceSourceToDetector

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

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

Parameters:

arrStrRadialPosition - String array of Distance from Source to Detector.

getDistanceSourceToDetector

public java.lang.String[] getDistanceSourceToDetector()

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

Returns:

String - array of Distance from Source to Detector.

setNumberOfFramesInRotation

public void setNumberOfFramesInRotation(short shNumberOfFramesInRotation)

Sets number of angular views in this rotation. Required if a sequence Item is present.

Parameters:

shNumberOfFramesInRotation - short value of Number Of Frames in Rotation.

getNumberOfFramesInRotation

public short getNumberOfFramesInRotation()

Retrieves Number of angular views in this rotation.

Returns:

short - short value of Number Of Frames in Rotation.

setTableTraverse

public void setTableTraverse(java.lang.String strTableTraverse)

Sets location of the patient table (or gantry relative to the table) in mm.The range and values of this element are determined by the manufacturer.

Parameters:

strTableTraverse - String value of Table Traverse.

getTableTraverse

public java.lang.String getTableTraverse()

Retrieves location of the patient table (or gantry relative to the table) in mm.

Returns:

String - value of Table Traverse.

setTableHeight

public void setTableHeight(java.lang.String strTableHeight)

Sets the distance in mm of the top of the patient table to the center of rotation. Table height below the center of rotation has a positive value.

Parameters:

strTableHeight - String value of Table Height.

getTableHeight

public java.lang.String getTableHeight()

Retrieves distance in mm of the top of the patient table to the center of rotation.

Returns:

String - value of Table Height.