cdac.medinfo.sdk.dcm30_04.baselibs

Class PlannedVerificationImageSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.PlannedVerificationImageSequenceItem

All Implemented Interfaces:

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

public class PlannedVerificationImageSequenceItem
extends Item

This item class contains the methods to set,get and validate the attribute present in Planned Verification Image Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getEndCumulativeMetersetWeight() Retrieves Cumulative Meterset Weight within current Beam at which image acquisition ends.
java.lang.String[]	getImagingDeviceSpecificAcquisitionParameters() Retrieves Imaging Device Specific Acquisition Parameters
java.lang.String	getMetersetExposure() Retrieves Meterset duration over which image is to be acquired, specified in Monitor units (MU) or minutes as defined by Primary Dosimeter Unit (300A,00B3).
java.lang.String	getReferencedReferenceImageNumber() Retrieves Referenced Reference Image Number.
java.lang.String[]	getRTImageOrientation() Retrieves RT Image Orientation.
java.lang.String	getRTImagePlane() Retrieves whether or not image plane is normal to beam axis.
java.lang.String[]	getRTImagePosition() Retrieves RT Image Orientation.
java.lang.String	getRTImageSID() Retrieves Radiation machine source to image plane distance (mm).
java.lang.String	getStartCumulativeMetersetWeight() Retrieves Cumulative Meterset Weight within current Beam at which image acquisition starts.
java.lang.String	getXRayImageReceptorAngle() Retrieves X-Ray Image Receptor Angle.
void	setEndCumulativeMetersetWeight(java.lang.String strEndCumulativeMetersetWeight) Sets Cumulative Meterset Weight within current Beam at which image acquisition ends.
void	setImagingDeviceSpecificAcquisitionParameters(java.lang.String[] arrImagingDeviceSpecificAcquisitionParameters) Sets User-specified device-specific parameters that describe how the imager will acquire the image.
void	setMetersetExposure(java.lang.String strMetersetExposure) Sets Meterset duration over which image is to be acquired, specified in Monitor units (MU) or minutes as defined by Primary Dosimeter Unit (300A,00B3).
void	setReferencedReferenceImageNumber(java.lang.String strReferencedReferenceImageNumber) Sets Referenced Reference Image Number.
void	setRTImageOrientation(java.lang.String[] arrRTImageOrientation) Sets The direction cosines of the first row and the first column with respect to the IEC XRAY IMAGE RECEPTOR coordinate System.
void	setRTImagePlane(EnumRTImagePlane enumRTImagePlane) Sets whether or not image plane is normal to beam axis.
void	setRTImagePosition(java.lang.String[] arrRTImagePosition) Sets The x and y coordinates (in mm) of the upper left hand corner of the image, in the IEC X-RAY IMAGE RECEPTOR coordinate system.
void	setRTImageSID(java.lang.String strRTImageSID) Sets Radiation machine source to image plane distance (mm).
void	setStartCumulativeMetersetWeight(java.lang.String strStartCumulativeMetersetWeight) Sets Cumulative Meterset Weight within current Beam at which image acquisition starts.
void	setXRayImageReceptorAngle(java.lang.String strXRayImageReceptorAngle) Sets X-Ray Image Receptor Angle i.e.
boolean	validateForModule() Validates all the attributes in PlannedVerificationImageSequenceItem 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

setStartCumulativeMetersetWeight

public void setStartCumulativeMetersetWeight(java.lang.String strStartCumulativeMetersetWeight)

Sets Cumulative Meterset Weight within current Beam at which image acquisition starts.

Parameters:

strStartCumulativeMetersetWeight - String value of Start Cumulative Meterset Weight.

getStartCumulativeMetersetWeight

public java.lang.String getStartCumulativeMetersetWeight()

Retrieves Cumulative Meterset Weight within current Beam at which image acquisition starts.

Returns:

String - value of Start Cumulative Meterset Weight.

setMetersetExposure

public void setMetersetExposure(java.lang.String strMetersetExposure)

Sets Meterset duration over which image is to be acquired, specified in Monitor units (MU) or minutes as defined by Primary Dosimeter Unit (300A,00B3).

Parameters:

strMetersetExposure - String value of Meterset Exposure.

getMetersetExposure

public java.lang.String getMetersetExposure()

Retrieves Meterset duration over which image is to be acquired, specified in Monitor units (MU) or minutes as defined by Primary Dosimeter Unit (300A,00B3).

Returns:

String - value of Meterset Exposure.

setEndCumulativeMetersetWeight

public void setEndCumulativeMetersetWeight(java.lang.String strEndCumulativeMetersetWeight)

Sets Cumulative Meterset Weight within current Beam at which image acquisition ends.

Parameters:

strEndCumulativeMetersetWeight - String value of End Cumulative Meterset Weight.

getEndCumulativeMetersetWeight

public java.lang.String getEndCumulativeMetersetWeight()

Retrieves Cumulative Meterset Weight within current Beam at which image acquisition ends.

Returns:

String - value of End Cumulative Meterset Weight.

setRTImagePlane

public void setRTImagePlane(EnumRTImagePlane enumRTImagePlane)

Sets whether or not image plane is normal to beam axis. Enumerated Values: NORMAL = image plane normal to beam axis, NON_NORMAL = image plane non-normal to beam axis.

Parameters:

enumRTImagePlane - Enum value of RT Image Plane.

getRTImagePlane

public java.lang.String getRTImagePlane()

Retrieves whether or not image plane is normal to beam axis.

Returns:

String - value of of RT Image Plane.

setXRayImageReceptorAngle

public void setXRayImageReceptorAngle(java.lang.String strXRayImageReceptorAngle)

Sets X-Ray Image Receptor Angle i.e. orientation of IEC X-RAY IMAGE RECEPTOR coordinate system with respect to IEC GANTRY coordinate system (degrees).

Parameters:

strXRayImageReceptorAngle - String value of X-Ray Image Receptor Angle.

getXRayImageReceptorAngle

public java.lang.String getXRayImageReceptorAngle()

Retrieves X-Ray Image Receptor Angle.

Returns:

String - value of X-Ray Image Receptor Angle.

setRTImageOrientation

public void setRTImageOrientation(java.lang.String[] arrRTImageOrientation)

Sets The direction cosines of the first row and the first column with respect to the IEC XRAY IMAGE RECEPTOR coordinate System.

Parameters:

arrRTImageOrientation - String array of RT Image Orientation.

getRTImageOrientation

public java.lang.String[] getRTImageOrientation()

Retrieves RT Image Orientation. The direction cosines of the first row and the first column with respect to the IEC XRAY IMAGE RECEPTOR coordinate System.

Returns:

arrRTImageOrientation - String value ofRT Image Orientation.

setRTImagePosition

public void setRTImagePosition(java.lang.String[] arrRTImagePosition)

Sets The x and y coordinates (in mm) of the upper left hand corner of the image, in the IEC X-RAY IMAGE RECEPTOR coordinate system. This is the center of the first pixel transmitted.

Parameters:

arrRTImagePosition - String array of RT Image Position.

getRTImagePosition

public java.lang.String[] getRTImagePosition()

Retrieves RT Image Orientation. The direction cosines of the first row and the first column with respect to the IEC XRAY IMAGE RECEPTOR coordinate System.

Returns:

arrRTImageOrientation - String value ofRT Image Orientation.

setRTImageSID

public void setRTImageSID(java.lang.String strRTImageSID)

Sets Radiation machine source to image plane distance (mm).

Parameters:

strRTImageSID - String value of RT Image SID.

getRTImageSID

public java.lang.String getRTImageSID()

Retrieves Radiation machine source to image plane distance (mm).

Returns:

String - value of RT Image SID.

setImagingDeviceSpecificAcquisitionParameters

public void setImagingDeviceSpecificAcquisitionParameters(java.lang.String[] arrImagingDeviceSpecificAcquisitionParameters)

Sets User-specified device-specific parameters that describe how the imager will acquire the image.

Parameters:

arrImagingDeviceSpecificAcquisitionParameters - String array of Imaging Device-Specific Acquisition Parameters.

getImagingDeviceSpecificAcquisitionParameters

public java.lang.String[] getImagingDeviceSpecificAcquisitionParameters()

Retrieves Imaging Device Specific Acquisition Parameters

Returns:

String - array of Imaging Device-Specific Acquisition Parameters.

setReferencedReferenceImageNumber

public void setReferencedReferenceImageNumber(java.lang.String strReferencedReferenceImageNumber)

Sets Referenced Reference Image Number. Uniquely identifies Reference Image to which planned verification image is related, specified by Reference Image Number (300A,00C8) within Referenced Reference Image Sequence (300A,0042).

Parameters:

strReferencedReferenceImageNumber - String value of Referenced Reference Image Number.

getReferencedReferenceImageNumber

public java.lang.String getReferencedReferenceImageNumber()

Retrieves Referenced Reference Image Number. Uniquely identifies Reference Image to which planned verification image is related, specified by Reference Image Number (300A,00C8) within Referenced Reference Image Sequence (300A,0042).

Returns:

String - value of Referenced Reference Image Number.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

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