cdac.medinfo.sdk.dcm30_04.baselibs

Class DeliveryVerificationImageSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.DeliveryVerificationImageSequenceItem

All Implemented Interfaces:

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

public class DeliveryVerificationImageSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Delivery Verification ImageSequence .

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
double	getDoubleExposureFieldDelta() Retrieves the Minimal value of Chemical Shift Frequency in ppm.
java.lang.String	getDoubleExposureFlag() Retrieves type of Double Exposure Flag value encoded in this Item
double	getDoubleExposureMeterset() Retrieves the Minimal value of Chemical Shift Frequency in ppm.
java.lang.String	getDoubleExposureOrdering() Retrieves type of Double Exposure Ordering value encoded in this Item
java.lang.String	getEndCumulativeMetersetWeight() Retrieves cumulative Meter set Weight within current Beam at which image acquisition will start.
java.lang.String	getMetersetExposure() Retrieves cumulative Meter set Weight within current Beam at which image acquisition will start.
RelatedReferenceRTImageSequence	getRelatedReferenceRTImageSequence() Retrieves pre-initialized object of Related Reference RTImage 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	getStartCumulativeMetersetWeight() Retrieves cumulative Meter set Weight within current Beam at which image acquisition will start.
java.lang.String	getVerificationImageTiming() Retrieves type of the value encoded in this Item
java.lang.String	getXRayImageReceptorTranslation() Retrieves XRayImageReceptorTranslation Thickness.
void	setDoubleExposureFieldDelta(double dblDoubleExposureFieldDelta) Sets the Double Exposure Field Delta Double value format of type FD.
void	setDoubleExposureFlag(EnumDoubleExposureFlag enumDoubleExposureFlag) Sets Indicates whether the current verification image is a single or double exposure.
void	setDoubleExposureMeterset(double dblDoubleExposureMeterset) Sets the Double Exposure Meterset in double format of type FD.
void	setDoubleExposureOrdering(EnumDoubleExposureOrdering enumDoubleExposureOrdering) Sets Indicates the ordering of the open (double exposure) field with respect to the primary (collimated) field in a double exposure
void	setEndCumulativeMetersetWeight(java.lang.String strEndCumulativeMetersetWeight) Cumulative Meterset Weight within current Beam at which imageacquisition will end.
void	setMetersetExposure(java.lang.String strMetersetExposure) Treatment machine Meter set duration over which image is to be acquired, specified in Monitor units (MU) or minutes as defined byPrimary Dosimeter Unit (300A,00B3) specified in the Referenced RTPlan Sequence (300C,0002)..
void	setStartCumulativeMetersetWeight(java.lang.String strStartCumulativeMetersetWeight) Cumulative Meter set Weight within current Beam at which image acquisition will start.
void	setVerificationImageTiming(EnumVerificationImageTiming enumVerificationImageTiming) Sets the temporal relationship of the verification
void	setXRayImageReceptorTranslation(java.lang.String strXRayImageReceptorTranslation) Sets Position in (x,y,z) coordinates in mm of origin of the IEC X-RAY IMAGE RECEPTOR System in the IEC GANTRY coordinate system.
boolean	validateForModule() Validates all the attributes in DeliveryVerificationImageSequenceItem 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 DeliveryVerificationImageSequenceItem 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 Conditional element fails.

setVerificationImageTiming

public void setVerificationImageTiming(EnumVerificationImageTiming enumVerificationImageTiming)

Sets the temporal relationship of the verification

Parameters:

enumVerificationImageTiming - Specifies type of the value encoded in this Item

getVerificationImageTiming

public java.lang.String getVerificationImageTiming()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setStartCumulativeMetersetWeight

public void setStartCumulativeMetersetWeight(java.lang.String strStartCumulativeMetersetWeight)

Cumulative Meter set Weight within current Beam at which image acquisition will start. Required if Verification Image Timing (0074,1032) is DURING_BEAM

Parameters:

strStartCumulativeMetersetWeight - String value of Slice Thickness.

getStartCumulativeMetersetWeight

public java.lang.String getStartCumulativeMetersetWeight()

Retrieves cumulative Meter set Weight within current Beam at which image acquisition will start.

Returns:

String - value of Slice Thickness.

setMetersetExposure

public void setMetersetExposure(java.lang.String strMetersetExposure)

Treatment machine Meter set duration over which image is to be acquired, specified in Monitor units (MU) or minutes as defined byPrimary Dosimeter Unit (300A,00B3) specified in the Referenced RTPlan Sequence (300C,0002).. Required if Verification Image Timing (0074,1032) is DURING_BEAM

Parameters:

strStartMetersetExposure - String value.

getMetersetExposure

public java.lang.String getMetersetExposure()

Retrieves cumulative Meter set Weight within current Beam at which image acquisition will start.

Returns:

String - value of Meter set Exposure.

setEndCumulativeMetersetWeight

public void setEndCumulativeMetersetWeight(java.lang.String strEndCumulativeMetersetWeight)

Cumulative Meterset Weight within current Beam at which imageacquisition will end. Required if Verification Image Timing (0074,1032) is DURING_BEAM

Parameters:

strStartMetersetExposure - String value.

getEndCumulativeMetersetWeight

public java.lang.String getEndCumulativeMetersetWeight()

Retrieves cumulative Meter set Weight within current Beam at which image acquisition will start.

Returns:

String - value of Meter set Exposure.

setDoubleExposureFlag

public void setDoubleExposureFlag(EnumDoubleExposureFlag enumDoubleExposureFlag)

Sets Indicates whether the current verification image is a single or double exposure.

Parameters:

strDoubleExposureFlag - Specifies type of the value encoded in this Item Enum Value:SINGLE,DOUBLE

getDoubleExposureFlag

public java.lang.String getDoubleExposureFlag()

Retrieves type of Double Exposure Flag value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setDoubleExposureOrdering

public void setDoubleExposureOrdering(EnumDoubleExposureOrdering enumDoubleExposureOrdering)

Sets Indicates the ordering of the open (double exposure) field with respect to the primary (collimated) field in a double exposure

Parameters:

strDoubleExposureOrdering - Specifies type of the value encoded in this Item Defined Terms:OPEN_FIRST,OPEN_SECOND

getDoubleExposureOrdering

public java.lang.String getDoubleExposureOrdering()

Retrieves type of Double Exposure Ordering value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setDoubleExposureMeterset

public void setDoubleExposureMeterset(double dblDoubleExposureMeterset)

Sets the Double Exposure Meterset in double format of type FD.

Parameters:

DoubleExposureMeterset - Double value of coordinates

getDoubleExposureMeterset

public double getDoubleExposureMeterset()

Retrieves the Minimal value of Chemical Shift Frequency in ppm.

Returns:

double - double value of ChemicalShiftsMinimumIntegrationLimitOnppm

setDoubleExposureFieldDelta

public void setDoubleExposureFieldDelta(double dblDoubleExposureFieldDelta)

Sets the Double Exposure Field Delta Double value format of type FD. Offsets of field-defining edges in mm for the double exposure in theIEC BEAM LIMITING DEVICE coordinate system in the IEC order X1,X2, Y1, Y2. Negative values for X1 and Y1 indicate an enlarged field,negative values for X2 and Y2 indicate a reduced field.

Parameters:

Double - Exposure Field Delta Double value of coordinates

getDoubleExposureFieldDelta

public double getDoubleExposureFieldDelta()

Retrieves the Minimal value of Chemical Shift Frequency in ppm.

Returns:

double - double value of Double Exposure Field Delta

setXRayImageReceptorTranslation

public void setXRayImageReceptorTranslation(java.lang.String strXRayImageReceptorTranslation)

Sets Position in (x,y,z) coordinates in mm of origin of the IEC X-RAY IMAGE RECEPTOR System in the IEC GANTRY coordinate system.

Parameters:

strXRayImageReceptorTranslation - String value of Slice Thickness.

getXRayImageReceptorTranslation

public java.lang.String getXRayImageReceptorTranslation()

Retrieves XRayImageReceptorTranslation Thickness.

Returns:

String - value of XRayImageReceptorTranslation.

getRelatedReferenceRTImageSequence

public RelatedReferenceRTImageSequence getRelatedReferenceRTImageSequence()

Retrieves pre-initialized object of Related Reference RTImage 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:

RelatedReferenceRTImageSequence - instance of RelatedReferenceRTImageSequence.