RTImageModule

java.lang.Object
- cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module
- - cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RTImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable
```
public class RTImageModule
extends Module
```
\* This module contains attributes that describe RT-specific characteristics of a projection image. The image described by these attributes must be a radiotherapy image acquired or calculated using a conical imaging geometry.

Field Summary

Fields
Modifier and Type Field and Description

static ISingleCollection<ITag> objSingleCollection
The obj single collection.

Fields
Modifier and Type	Field and Description
`static ISingleCollection<ITag>`	`objSingleCollection` The obj single collection.

Constructor Summary

Constructors
Constructor and Description

RTImageModule(IDataSet objIDataSet)
Instantiates a new rT image module.

Constructors
Constructor and Description
`RTImageModule(IDataSet objIDataSet)` Instantiates a new rT image module.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getBeamLimitingDeviceAngle()` Return treatment machine beam limiting device (collimator) angle, i.e.
`short`	`getBitsAllocated()` Retrieves the number of bits allocated.
`short`	`getBitsStored()` Retrieves the number of bits stored.
`java.lang.String`	`getConversionType()` Retrieves describes the kind of image conversion.
`java.lang.String`	`getEndCumulativeMetersetWeight()` Retrieves Cumulative Meterset Weight within Beam referenced by Referenced Beam Number (300C,0006) at which image acquisition ends.
`ExposureSequence`	`getExposureSequence()` Returns provides the pre-initialized object of `ExposureSequence`.
`FluenceMapSequence`	`getFluenceMapSequence()` Returns provides the pre-initialized object of `FluenceMapSequence`.
`java.lang.String`	`getFractionNumber()` Retrieves Fraction Number of fraction during which image was acquired, within Fraction Group referenced by Referenced Fraction Group Number (300C,0022) within RT Plan referenced in Referenced RT Plan Sequence (300C,0002).
`java.lang.String`	`getGantryAngle()` Return treatment machine gantry angle, i.e.
`float`	`getGantryPitchAngle()` Retrieves the Gantry Pitch Angle.
`short`	`getHighBit()` Retrieves High Bit.
`java.lang.String[]`	`getImagePlanePixelSpacing()` Retrieves physical distance (in mm) between the center of each image pixel, specified by a numeric pair - adjacent row spacing (delimiter) adjacent column spacing.
`java.lang.String[]`	`getImageType()` Return image identification characteristics.
`java.lang.String[]`	`getIsocenterPosition()` Retrieves Isocenter Position
`java.lang.String`	`getPatientPosition()` Retrieves type of the value Patient Position
`java.lang.String`	`getPatientSupportAngle()` Return Patient Support angle, i.e.
`java.lang.String`	`getPhotometricInterpretation()` Retrieves the photometric interpretation.
`short`	`getPixelIntensityRelationship()` Retrieves the PixelIntensityRelationship
`short`	`getPixelIntensityRelationshipSign()` Retrieves the PixelIntensityRelationshipSign
`short`	`getPixelRepresentation()` Retrieves the Pixel Representation.
`java.lang.String`	`getPrimaryDosimeterUnit()` Retrieves measurement unit of machine dosimeter.
`java.lang.String`	`getRadiationMachineName()` Retrieves user-defined name identifying radiation machine used in acquiring or computing image (i.e.
`java.lang.String`	`getRadiationMachineSAD()` Retrieves radiation source to Gantry rotation axis distance of radiation machine used in acquiring or computing image (mm).
`java.lang.String`	`getRadiationMachineSSD()` Retrieves source to patient surface distance (in mm) of radiation machine used in acquiring or computing image.
`java.lang.String`	`getReferencedBeamNumber()` Retrieves uniquely identifies the corresponding Nsegment treatment beam specified by Beam Number (300A,00C0) within Beam Sequence in RT Beams Module within the RT Plan referenced in Referenced RT Plan Sequence (300C,0002).
`java.lang.String`	`getReferencedFractionGroupNumber()` Retrieves identifier of Fraction Group within RT Plan referenced in Referenced RT Plan Sequence (300C,0002).
`ReferencedRTPlanSequence`	`getReferencedRTPlanSequence()` Returns provides the pre-initialized object of Referenced RT Plan Sequence.
`java.lang.String`	`getReportedValuesOrigin()` Retrieves the origin of the parameter values reported in the image.
`java.lang.String`	`getRTImageDescription()` Retrieves user-defined description for RT Image.
`java.lang.String`	`getRTImageLabel()` Retrieves User-defined label for RT Image.
`java.lang.String`	`getRTImageName()` Retrieves user-defined name for RT Image.
`java.lang.String[]`	`getRTImageOrientation()` The direction cosines of the first row and the first column with respect to the IEC XRAY IMAGE RECEPTOR coordinate system.
`java.lang.String`	`getRTImagePlane()` Retrieves whether or not image plane is normal to beam axis.
`java.lang.String[]`	`getRTImagePosition()` Retrieves 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.
`java.lang.String`	`getRTImageSID()` Retrieves distance from radiation machine source to image plane (in mm) along radiation beam axis.
`short`	`getSamplesPerPixel()` Retrieves the samples per pixel.
`java.lang.String`	`getSourceToReferenceObjectDistance()` Retrieves source to reference object distance (in mm), as used for magnification calculation of RADIOGRAPH and SIMULATOR images.
`java.lang.String`	`getStartCumulativeMetersetWeight()` Retrieves Cumulative Meterset Weight within Beam referenced by Referenced Beam Number (300C,0006) at which image acquisition starts.
`java.lang.String`	`getTableTopEccentricAngle()` Return distance (positive) from the IEC PATIENT SUPPORT vertical axis to the IEC TABLE TOP ECCENTRIC vertical axis (mm).
`java.lang.String`	`getTableTopEccentricAxisDistance()` Return distance (positive) from the IEC PATIENT SUPPORT vertical axis to the IEC TABLE TOP ECCENTRIC vertical axis (mm).
`java.lang.String`	`getTableTopLateralPosition()` Return Table Top Lateral position in IEC TABLE TOP coordinate system (mm).
`java.lang.String`	`getTableTopLongitudinalPosition()` Return Table Top Longitudinal position in IEC TABLE TOP coordinate system (mm).
`java.lang.String`	`getTableTopVerticalPosition()` Return Table Top Vertical position in IEC TABLE TOP coordinate system (mm).
`ISingleCollection<ITag>`	`getVectorOfKeys()` This method returns the vector of keys representing the DataElements that belong to this module.
`java.lang.String`	`getXRayImageReceptorAngle()` Retrieves X-Ray Image Receptor Angle i.e.
`java.lang.String[]`	`getXRayImageReceptorTranslation()` Retrieves position in (x,y,z) coordinates of origin of IEC X-RAY IMAGE RECEPTOR System in the IEC GANTRY coordinate system (mm).
`void`	`setBeamLimitingDeviceAngle(java.lang.String strBeamLimitingDeviceAngle)` Sets treatment machine beam limiting device (collimator) angle, i.e.
`void`	`setBitsAllocated(EnumBitsAllocated enumBitsAllocated)` Number of bits allocated for each pixel sample.
`void`	`setBitsStored(EnumBitsStored enumBitsStored)` Sets Number of bits stored for each pixel sample.
`void`	`setConversionType(EnumConversionType enumConversionType)` Sets describes the kind of image conversion.
`void`	`setEndCumulativeMetersetWeight(java.lang.String strEndCumulativeMetersetWeight)` Sets Cumulative Meterset Weight within Beam referenced by Referenced Beam Number (300C,0006) at which image acquisition ends.
`void`	`setFractionNumber(java.lang.String strFractionNumber)` Sets Fraction Number of fraction during which image was acquired, within Fraction Group referenced by Referenced Fraction Group Number (300C,0022) within RT Plan referenced in Referenced RT Plan Sequence (300C,0002).
`void`	`setGantryAngle(java.lang.String strGantryAngle)` Sets treatment machine gantry angle, i.e.
`void`	`setGantryPitchAngle(float fGantryPitchAngle)` Sets the Gantry Pitch Angle.
`void`	`setHighBit(EnumHighBit enumHighBit)` Sets Most significant bit for each pixel sample.
`void`	`setImagePlanePixelSpacing(java.lang.String[] arrStrImagePlanePixelSpacing)` Sets physical distance (in mm) between the center of each image pixel, specified by a numeric pair - adjacent row spacing (delimiter) adjacent column spacing.
`void`	`setImageType(java.lang.String[] arrStrImageType)` Sets image identification characteristics.
`void`	`setIsocenterPosition(java.lang.String[] strIsocenterPosition)` Sets Isocenter Position
`void`	`setPatientPosition(java.lang.String strPatientPosition)` Sets Patient Position
`void`	`setPatientSupportAngle(java.lang.String strPatientSupportAngle)` Sets patient support angle, i.e.
`void`	`setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)` Sets the intended interpretation of the pixel data.
`void`	`setPixelIntensityRelationship(EnumPixelIntensityRelationship enumPixelIntensityRelationship)` Sets PixelIntensityRelationship
`void`	`setPixelIntensityRelationshipSign(EnumPixelIntensityRelationship enumPixelIntensityRelationshipSign)` Sets PixelIntensityRelationshipSign
`void`	`setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation)` Sets Data representation of the pixel samples.
`void`	`setPrimaryDosimeterUnit(EnumPrimaryDosimeterUnit enumPrimaryDosimeterUnit)` Sets measurement unit of machine dosimeter.
`void`	`setRadiationMachineName(java.lang.String strRadiationMachineName)` Sets user-defined name identifying radiation machine used in acquiring or computing image (i.e.
`void`	`setRadiationMachineSAD(java.lang.String strRadiationMachineSAD)` Sets radiation source to Gantry rotation axis distance of radiation machine used in acquiring or computing image (mm).
`void`	`setRadiationMachineSSD(java.lang.String strRadiationMachineSSD)` Sets source to patient surface distance (in mm) of radiation machine used in acquiring or computing image.
`void`	`setReferencedBeamNumber(java.lang.String strReferencedBeamNumber)` Sets uniquely identifies the corresponding Nsegment treatment beam specified by Beam Number (300A,00C0) within Beam Sequence in RT Beams Module within the RT Plan referenced in Referenced RT Plan Sequence (300C,0002).
`void`	`setReferencedFractionGroupNumber(java.lang.String strReferencedFractionGroupNumber)` Sets identifier of Fraction Group within RT Plan referenced in Referenced RT Plan Sequence (300C,0002).
`void`	`setReportedValuesOrigin(EnumReportedValuesOrigin enumReportedValuesOrigin)` Sets the origin of the parameter values reported in the image.
`void`	`setRTImageDescription(java.lang.String strRTImageDescription)` Sets user-defined description for RT Image.
`void`	`setRTImageLabel(java.lang.String strRTImageLabel)` Sets the user-defined label for RT Image.
`void`	`setRTImageName(java.lang.String strRTImageName)` Sets user-defined name for RT Image.
`void`	`setRTImageOrientation(java.lang.String[] arrStrXRayImageOrientation)` 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[] arrStrRTImagePosition)` 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 distance from radiation machine source to image plane (in mm) along radiation beam axis.
`void`	`setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel)` Sets Samples per Pixel (0028,0002) is the number of separate planes in the image.
`void`	`setSourceToReferenceObjectDistance(java.lang.String strSourceToReferenceObjectDistance)` Sets source to reference object distance (in mm), as used for magnification calculation of RADIOGRAPH and SIMULATOR images.
`void`	`setStartCumulativeMetersetWeight(java.lang.String strStartCumulativeMetersetWeight)` Sets Cumulative Meterset Weight within Beam referenced by Referenced Beam Number (300C,0006) at which image acquisition starts.
`void`	`setTableTopEccentricAngle(java.lang.String strTableTopEccentricAngle)` Sets distance (positive) from the IEC PATIENT SUPPORT vertical axis to the IEC TABLE TOP ECCENTRIC vertical axis (mm).
`void`	`setTableTopEccentricAxisDistance(java.lang.String strTableTopEccentricAxisDistance)` Sets distance (positive) from the IEC PATIENT SUPPORT vertical axis to the IEC TABLE TOP ECCENTRIC vertical axis (mm).
`void`	`setTableTopLateralPosition(java.lang.String strTableTopLateralPosition)` Sets Table Top Lateral position in IEC TABLE TOP coordinate system (mm).
`void`	`setTableTopLongitudinalPosition(java.lang.String strTableTopLongitudinalPosition)` Sets Table Top Longitudinal position in IEC TABLE TOP coordinate system (mm).
`void`	`setTableTopVerticalPosition(java.lang.String strTableTopVerticalPosition)` Sets Table Top Vertical position in IEC TABLE TOP coordinate system (mm).
`void`	`setXRayImageReceptorAngle(java.lang.String strXRayImageReceptorAngle)` Sets X-Ray Image Receptor Angle i.e.
`void`	`setXRayImageReceptorTranslation(java.lang.String[] arrStrXRayImageReceptorTranslation)` Sets position in (x,y,z) coordinates of origin of IEC X-RAY IMAGE RECEPTOR System in the IEC GANTRY coordinate system (mm).
`boolean`	`validateModule()` This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module
add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - objSingleCollection
```
public static ISingleCollection<ITag> objSingleCollection
```
    The obj single collection.
- Constructor Detail
  - RTImageModule
```
public RTImageModule(IDataSet objIDataSet)
```
    Instantiates a new rT image module.
    
    Parameters:
    objIDataSet - the obj i data set
- Method Detail
  - validateModule
```
public boolean validateModule()
                       throws InvalidModuleException
```
    This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.
    
    Specified by:
    
    validateModule in interface IModule
    
    Specified by:
    
    validateModule in class Module
    
    Returns:
    boolean - returns validation status as success or failure
    
    Throws:
    
    InvalidModuleException - - If validation of Module fails
  - setSamplesPerPixel
```
public void setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel)
```
    Sets Samples per Pixel (0028,0002) is the number of separate planes in the image. One, three, and four image planes are defined. For monochrome (gray scale) and palette color images, the number of planes is 1. For RGB and other three vector color models, the value of this attribute is 3. For four vector color models, the value of this attribute is 4.
    
    Parameters:
    enumSamplesPerPixel - - enum value of samples per pixel in the image
  - getSamplesPerPixel
```
public short getSamplesPerPixel()
```
    Retrieves the samples per pixel.
    
    Returns:
    short - short value of Samples per pixel.
  - setPhotometricInterpretation
```
public void setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)
```
    Sets the intended interpretation of the pixel data.
    
    Parameters:
    enumPhotometricInterpretation - - Enum value of Photometric Interpretation.
  - getPhotometricInterpretation
```
public java.lang.String getPhotometricInterpretation()
```
    Retrieves the photometric interpretation.
    
    Returns:
    String - returns the photometric interpretation.
  - setBitsAllocated
```
public void setBitsAllocated(EnumBitsAllocated enumBitsAllocated)
```
    Number of bits allocated for each pixel sample. Each sample shall have the same number of bits allocated.
    
    Parameters:
    enumBitsAllocated - - enum value of number of bits allocated.
  - getBitsAllocated
```
public short getBitsAllocated()
```
    Retrieves the number of bits allocated.
    
    Returns:
    short - short value of number of bits allocated.
  - setBitsStored
```
public void setBitsStored(EnumBitsStored enumBitsStored)
```
    Sets Number of bits stored for each pixel sample. Each sample shall have the same number of bits stored.
    
    Parameters:
    enumBitsStored - - enum value of the number of bits stored.
  - getBitsStored
```
public short getBitsStored()
```
    Retrieves the number of bits stored.
    
    Returns:
    short - short value of the number of bits stored.
  - setHighBit
```
public void setHighBit(EnumHighBit enumHighBit)
```
    Sets Most significant bit for each pixel sample. Each sample shall have the same high bit.
    
    Parameters:
    enumHighBit - - enum value of High Bit.
  - getHighBit
```
public short getHighBit()
```
    Retrieves High Bit.
    
    Returns:
    short - short value of High Bit.
  - setPixelRepresentation
```
public void setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation)
```
    Sets Data representation of the pixel samples.
    
    Parameters:
    enumPixelRepresentation - - Enum value of Pixel Representation.
  - getPixelRepresentation
```
public short getPixelRepresentation()
```
    Retrieves the Pixel Representation.
    
    Returns:
    String - returns the Pixel Representation.
  - setPixelIntensityRelationship
```
public void setPixelIntensityRelationship(EnumPixelIntensityRelationship enumPixelIntensityRelationship)
```
    Sets PixelIntensityRelationship
    
    Parameters:
    enumPixelIntensityRelationship - - Enum value of PixelIntensityRelationship
  - getPixelIntensityRelationship
```
public short getPixelIntensityRelationship()
```
    Retrieves the PixelIntensityRelationship
    
    Returns:
    String - returns the PixelIntensityRelationship
  - setPixelIntensityRelationshipSign
```
public void setPixelIntensityRelationshipSign(EnumPixelIntensityRelationship enumPixelIntensityRelationshipSign)
```
    Sets PixelIntensityRelationshipSign
    
    Parameters:
    enumPixelIntensityRelationshipSign - - Enum value of PixelIntensityRelationshipSign
  - getPixelIntensityRelationshipSign
```
public short getPixelIntensityRelationshipSign()
```
    Retrieves the PixelIntensityRelationshipSign
    
    Returns:
    String - returns the PixelIntensityRelationshipSign
  - setRTImageLabel
```
public void setRTImageLabel(java.lang.String strRTImageLabel)
```
    Sets the user-defined label for RT Image.
    
    Parameters:
    strRTImageLabel - - String value of RT Image Label.
  - getRTImageLabel
```
public java.lang.String getRTImageLabel()
```
    Retrieves User-defined label for RT Image.
    
    Returns:
    String - String value of RT Image Label.
  - setRTImageName
```
public void setRTImageName(java.lang.String strRTImageName)
```
    Sets user-defined name for RT Image.
    
    Parameters:
    strRTImageName - - String value RT Image Name.
  - getRTImageName
```
public java.lang.String getRTImageName()
```
    Retrieves user-defined name for RT Image.
    
    Returns:
    String - String value RT Image Name.
  - setRTImageDescription
```
public void setRTImageDescription(java.lang.String strRTImageDescription)
```
    Sets user-defined description for RT Image.
    
    Parameters:
    strRTImageDescription - - String value of RT Image Description.
  - getRTImageDescription
```
public java.lang.String getRTImageDescription()
```
    Retrieves user-defined description for RT Image.
    
    Returns:
    String - String value of RT Image Description.
  - setImageType
```
public void setImageType(java.lang.String[] arrStrImageType)
```
    Sets image identification characteristics.
    
    Parameters:
    arrStrImageType - - String array of image identification characteristics.
  - getImageType
```
public java.lang.String[] getImageType()
```
    Return image identification characteristics.
    
    Returns:
    the image type
  - setConversionType
```
public void setConversionType(EnumConversionType enumConversionType)
```
    Sets describes the kind of image conversion. Defined Terms: 1) DV = Digitized Video 2) DI = Digital Interface 3) DF = Digitized Film 4) WSD = Workstation
    
    Parameters:
    enumConversionType - - Enum value of Conversion Type.
  - getConversionType
```
public java.lang.String getConversionType()
```
    Retrieves describes the kind of image conversion.
    
    Returns:
    String - String value of Conversion Type.
  - setReportedValuesOrigin
```
public void setReportedValuesOrigin(EnumReportedValuesOrigin enumReportedValuesOrigin)
```
    Sets the origin of the parameter values reported in the image. Required if Value 3 of Image Type (0008,0008) is SIMULATOR or PORTAL. Enumerated Values: 1) OPERATOR = manually entered by operator. 2) PLAN = planned parameter values. 3) ACTUAL = electronically recorded.
    
    Parameters:
    enumReportedValuesOrigin - - enum value of Reported Values Origin.
  - getReportedValuesOrigin
```
public java.lang.String getReportedValuesOrigin()
```
    Retrieves the origin of the parameter values reported in the image.
    
    Returns:
    String - String value of Reported Values Origin.
  - setRTImagePlane
```
public void setRTImagePlane(EnumRTImagePlane enumRTImagePlane)
```
    Sets whether or not image plane is normal to beam axis. Enumerated Values: 1) NORMAL = image plane normal to beam axis. 2) 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 - String value of RT Image Plane.
  - setXRayImageReceptorTranslation
```
public void setXRayImageReceptorTranslation(java.lang.String[] arrStrXRayImageReceptorTranslation)
```
    Sets position in (x,y,z) coordinates of origin of IEC X-RAY IMAGE RECEPTOR System in the IEC GANTRY coordinate system (mm).
    
    Parameters:
    arrStrXRayImageReceptorTranslation - - String value of X-Ray Image Receptor Translation.
  - getXRayImageReceptorTranslation
```
public java.lang.String[] getXRayImageReceptorTranslation()
```
    Retrieves position in (x,y,z) coordinates of origin of IEC X-RAY IMAGE RECEPTOR System in the IEC GANTRY coordinate system (mm).
    
    Returns:
    String[] - String value of String value of X-Ray Image Receptor Translation.
  - 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 i.e. orientation of IEC X-RAY IMAGE RECEPTOR coordinate system with respect to IEC GANTRY coordinate system (degrees).
    
    Returns:
    String - String value of X-Ray Image Receptor Angle.
  - setRTImageOrientation
```
public void setRTImageOrientation(java.lang.String[] arrStrXRayImageOrientation)
```
    Sets the direction cosines of the first row and the first column with respect to the IEC XRAY IMAGE RECEPTOR coordinate system. Required if RT Image Plane (3002,000C) is NON_NORMAL.
    
    Parameters:
    arrStrXRayImageOrientation - - String array of RT Image Orientation.
  - getRTImageOrientation
```
public java.lang.String[] getRTImageOrientation()
```
    The direction cosines of the first row and the first column with respect to the IEC XRAY IMAGE RECEPTOR coordinate system.
    
    Returns:
    String[] - String value of RT Image Orientation.
  - setImagePlanePixelSpacing
```
public void setImagePlanePixelSpacing(java.lang.String[] arrStrImagePlanePixelSpacing)
```
    Sets physical distance (in mm) between the center of each image pixel, specified by a numeric pair - adjacent row spacing (delimiter) adjacent column spacing.
    
    Parameters:
    arrStrImagePlanePixelSpacing - - String array of Image Plane Pixel Spacing.
  - getImagePlanePixelSpacing
```
public java.lang.String[] getImagePlanePixelSpacing()
```
    Retrieves physical distance (in mm) between the center of each image pixel, specified by a numeric pair - adjacent row spacing (delimiter) adjacent column spacing.
    
    Returns:
    String[] - String array of Image Plane Pixel Spacing.
  - setRTImagePosition
```
public void setRTImagePosition(java.lang.String[] arrStrRTImagePosition)
```
    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:
    arrStrRTImagePosition - - String array of RT Image Position.
  - getRTImagePosition
```
public java.lang.String[] getRTImagePosition()
```
    Retrieves 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.
    
    Returns:
    String[] - String array of RT Image Position.
  - setRadiationMachineName
```
public void setRadiationMachineName(java.lang.String strRadiationMachineName)
```
    Sets user-defined name identifying radiation machine used in acquiring or computing image (i.e. name of conventional simulator, electron accelerator, X-ray device, or machine modeled when calculating DRR).
    
    Parameters:
    strRadiationMachineName - - String value of Radiation Machine Name.
  - getRadiationMachineName
```
public java.lang.String getRadiationMachineName()
```
    Retrieves user-defined name identifying radiation machine used in acquiring or computing image (i.e. name of conventional simulator, electron accelerator, X-ray device, or machine modeled when calculating DRR).
    
    Returns:
    String - String value of Radiation Machine Name.
  - setPrimaryDosimeterUnit
```
public void setPrimaryDosimeterUnit(EnumPrimaryDosimeterUnit enumPrimaryDosimeterUnit)
```
    Sets measurement unit of machine dosimeter. Enumerated Values: 1) MU = Monitor Unit 2) MINUTE = minute
    
    Parameters:
    enumPrimaryDosimeterUnit - - enum value of Primary Dosimeter Unit.
  - getPrimaryDosimeterUnit
```
public java.lang.String getPrimaryDosimeterUnit()
```
    Retrieves measurement unit of machine dosimeter.
    
    Returns:
    String - String value of Primary Dosimeter Unit.
  - setRadiationMachineSAD
```
public void setRadiationMachineSAD(java.lang.String strRadiationMachineSAD)
```
    Sets radiation source to Gantry rotation axis distance of radiation machine used in acquiring or computing image (mm).
    
    Parameters:
    strRadiationMachineSAD - - String value of Radiation Machine SAD.
  - getRadiationMachineSAD
```
public java.lang.String getRadiationMachineSAD()
```
    Retrieves radiation source to Gantry rotation axis distance of radiation machine used in acquiring or computing image (mm).
    
    Returns:
    the radiation machine sad
  - setRadiationMachineSSD
```
public void setRadiationMachineSSD(java.lang.String strRadiationMachineSSD)
```
    Sets source to patient surface distance (in mm) of radiation machine used in acquiring or computing image.
    
    Parameters:
    strRadiationMachineSSD - - String value of Radiation Machine SSD.
  - getRadiationMachineSSD
```
public java.lang.String getRadiationMachineSSD()
```
    Retrieves source to patient surface distance (in mm) of radiation machine used in acquiring or computing image.
    
    Returns:
    the radiation machine ssd
  - setRTImageSID
```
public void setRTImageSID(java.lang.String strRTImageSID)
```
    Sets distance from radiation machine source to image plane (in mm) along radiation beam axis.
    
    Parameters:
    strRTImageSID - - String value of RT Image SID.
  - getRTImageSID
```
public java.lang.String getRTImageSID()
```
    Retrieves distance from radiation machine source to image plane (in mm) along radiation beam axis.
    
    Returns:
    the RT image sid
  - setSourceToReferenceObjectDistance
```
public void setSourceToReferenceObjectDistance(java.lang.String strSourceToReferenceObjectDistance)
```
    Sets source to reference object distance (in mm), as used for magnification calculation of RADIOGRAPH and SIMULATOR images.
    
    Parameters:
    strSourceToReferenceObjectDistance - - String value of Source to Reference Object Distance.
  - getSourceToReferenceObjectDistance
```
public java.lang.String getSourceToReferenceObjectDistance()
```
    Retrieves source to reference object distance (in mm), as used for magnification calculation of RADIOGRAPH and SIMULATOR images.
    
    Returns:
    the source to reference object distance
  - getReferencedRTPlanSequence
```
public ReferencedRTPlanSequence getReferencedRTPlanSequence()
```
    Returns provides the pre-initialized object of Referenced RT Plan 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:
    ReferencedRTPlanSequence - object of Referenced RT Plan Sequence.
  - setReferencedBeamNumber
```
public void setReferencedBeamNumber(java.lang.String strReferencedBeamNumber)
```
    Sets uniquely identifies the corresponding Nsegment treatment beam specified by Beam Number (300A,00C0) within Beam Sequence in RT Beams Module within the RT Plan referenced in Referenced RT Plan Sequence (300C,0002).
    
    Parameters:
    strReferencedBeamNumber - - String value of Referenced Beam Number.
  - getReferencedBeamNumber
```
public java.lang.String getReferencedBeamNumber()
```
    Retrieves uniquely identifies the corresponding Nsegment treatment beam specified by Beam Number (300A,00C0) within Beam Sequence in RT Beams Module within the RT Plan referenced in Referenced RT Plan Sequence (300C,0002).
    
    Returns:
    the referenced beam number
  - setReferencedFractionGroupNumber
```
public void setReferencedFractionGroupNumber(java.lang.String strReferencedFractionGroupNumber)
```
    Sets identifier of Fraction Group within RT Plan referenced in Referenced RT Plan Sequence (300C,0002).
    
    Parameters:
    strReferencedFractionGroupNumber - - String value of Referenced Fraction Group Number.
  - getReferencedFractionGroupNumber
```
public java.lang.String getReferencedFractionGroupNumber()
```
    Retrieves identifier of Fraction Group within RT Plan referenced in Referenced RT Plan Sequence (300C,0002).
    
    Returns:
    the referenced fraction group number
  - setFractionNumber
```
public void setFractionNumber(java.lang.String strFractionNumber)
```
    Sets Fraction Number of fraction during which image was acquired, within Fraction Group referenced by Referenced Fraction Group Number (300C,0022) within RT Plan referenced in Referenced RT Plan Sequence (300C,0002).
    
    Parameters:
    strFractionNumber - - String value of Fraction Number.
  - getFractionNumber
```
public java.lang.String getFractionNumber()
```
    Retrieves Fraction Number of fraction during which image was acquired, within Fraction Group referenced by Referenced Fraction Group Number (300C,0022) within RT Plan referenced in Referenced RT Plan Sequence (300C,0002).
    
    Returns:
    the fraction number
  - setStartCumulativeMetersetWeight
```
public void setStartCumulativeMetersetWeight(java.lang.String strStartCumulativeMetersetWeight)
```
    Sets Cumulative Meterset Weight within Beam referenced by Referenced Beam Number (300C,0006) 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 Beam referenced by Referenced Beam Number (300C,0006) at which image acquisition starts.
    
    Returns:
    the start cumulative meterset weight
  - setEndCumulativeMetersetWeight
```
public void setEndCumulativeMetersetWeight(java.lang.String strEndCumulativeMetersetWeight)
```
    Sets Cumulative Meterset Weight within Beam referenced by Referenced Beam Number (300C,0006) 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 Beam referenced by Referenced Beam Number (300C,0006) at which image acquisition ends.
    
    Returns:
    the end cumulative meterset weight
  - getExposureSequence
```
public ExposureSequence getExposureSequence()
```
    Returns provides the pre-initialized object of ExposureSequence. 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:
    ExposureSequence - object of Exposure Sequence.
  - getFluenceMapSequence
```
public FluenceMapSequence getFluenceMapSequence()
```
    Returns provides the pre-initialized object of FluenceMapSequence. 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:
    - object of Fluence Map Sequence.
  - setGantryAngle
```
public void setGantryAngle(java.lang.String strGantryAngle)
```
    Sets treatment machine gantry angle, i.e. orientation of IEC GANTRY coordinate system with respect to IEC FIXED REFERENCE coordinate system (degrees).
    
    Parameters:
    strGantryAngle - - String value of Gantry Angle.
  - getGantryAngle
```
public java.lang.String getGantryAngle()
```
    Return treatment machine gantry angle, i.e. orientation of IEC GANTRY coordinate system with respect to IEC FIXED REFERENCE coordinate system (degrees).
    
    Returns:
    String - String value of Gantry Angle.
  - setGantryPitchAngle
```
public void setGantryPitchAngle(float fGantryPitchAngle)
```
    Sets the Gantry Pitch Angle. i.e., the rotation of the IEC GANTRY coordinatesystem about the X-axis of the IEC GANTRY coordinate system(degrees).
    
    Parameters:
    fGantryPitchAngle - Float value of Gantry Pitch Angle. i.e., the rotation of the IEC GANTRY coordinatesystem about the X-axis of the IEC GANTRY coordinate system(degrees).
  - getGantryPitchAngle
```
public float getGantryPitchAngle()
```
    Retrieves the Gantry Pitch Angle. i.e., the rotation of the IEC GANTRY coordinatesystem about the X-axis of the IEC GANTRY coordinate system(degrees).
    
    Returns:
    float - Float value of the Gantry Pitch Angle
  - setBeamLimitingDeviceAngle
```
public void setBeamLimitingDeviceAngle(java.lang.String strBeamLimitingDeviceAngle)
```
    Sets treatment machine beam limiting device (collimator) angle, i.e. orientation of IEC BEAM LIMITING DEVICE coordinate system with respect to IEC GANTRY coordinate system (degrees).
    
    Parameters:
    strBeamLimitingDeviceAngle - - String value of Beam Limiting Device Angle.
  - getBeamLimitingDeviceAngle
```
public java.lang.String getBeamLimitingDeviceAngle()
```
    Return treatment machine beam limiting device (collimator) angle, i.e. orientation of IEC BEAM LIMITING DEVICE coordinate system with respect to IEC GANTRY coordinate system (degrees).
    
    Returns:
    String - String value of Beam Limiting Device Angle.
  - setPatientSupportAngle
```
public void setPatientSupportAngle(java.lang.String strPatientSupportAngle)
```
    Sets patient support angle, i.e. orientation of IEC PATIENT SUPPORT coordinate system with respect to IEC FIXED REFERENCE coordinate system (degrees).
    
    Parameters:
    strPatientSupportAngle - - String value of Patient Support Angle.
  - getPatientSupportAngle
```
public java.lang.String getPatientSupportAngle()
```
    Return Patient Support angle, i.e. orientation of IEC PATIENT SUPPORT coordinate system with respect to IEC FIXED REFERENCE coordinate system (degrees).
    
    Returns:
    String - String value of Patient Support Angle.
  - setTableTopEccentricAxisDistance
```
public void setTableTopEccentricAxisDistance(java.lang.String strTableTopEccentricAxisDistance)
```
    Sets distance (positive) from the IEC PATIENT SUPPORT vertical axis to the IEC TABLE TOP ECCENTRIC vertical axis (mm).
    
    Parameters:
    strTableTopEccentricAxisDistance - - String value of Table Top Eccentric Axis Distance.
  - getTableTopEccentricAxisDistance
```
public java.lang.String getTableTopEccentricAxisDistance()
```
    Return distance (positive) from the IEC PATIENT SUPPORT vertical axis to the IEC TABLE TOP ECCENTRIC vertical axis (mm).
    
    Returns:
    String -String value of Table Top Eccentric Axis Distance.
  - setTableTopEccentricAngle
```
public void setTableTopEccentricAngle(java.lang.String strTableTopEccentricAngle)
```
    Sets distance (positive) from the IEC PATIENT SUPPORT vertical axis to the IEC TABLE TOP ECCENTRIC vertical axis (mm).
    
    Parameters:
    strTableTopEccentricAngle - the str table top eccentric angle
  - getTableTopEccentricAngle
```
public java.lang.String getTableTopEccentricAngle()
```
    Return distance (positive) from the IEC PATIENT SUPPORT vertical axis to the IEC TABLE TOP ECCENTRIC vertical axis (mm).
    
    Returns:
    String -String value of Table Top Eccentric Axis Angle.
  - setTableTopVerticalPosition
```
public void setTableTopVerticalPosition(java.lang.String strTableTopVerticalPosition)
```
    Sets Table Top Vertical position in IEC TABLE TOP coordinate system (mm).
    
    Parameters:
    strTableTopVerticalPosition - - String value of Table Top Vertical Position.
  - getTableTopVerticalPosition
```
public java.lang.String getTableTopVerticalPosition()
```
    Return Table Top Vertical position in IEC TABLE TOP coordinate system (mm).
    
    Returns:
    String - String value of Table Top Vertical Position.
  - setTableTopLongitudinalPosition
```
public void setTableTopLongitudinalPosition(java.lang.String strTableTopLongitudinalPosition)
```
    Sets Table Top Longitudinal position in IEC TABLE TOP coordinate system (mm).
    
    Parameters:
    strTableTopLongitudinalPosition - - String value of Table Top Longitudinal Position.
  - getTableTopLongitudinalPosition
```
public java.lang.String getTableTopLongitudinalPosition()
```
    Return Table Top Longitudinal position in IEC TABLE TOP coordinate system (mm).
    
    Returns:
    the table top longitudinal position
  - setTableTopLateralPosition
```
public void setTableTopLateralPosition(java.lang.String strTableTopLateralPosition)
```
    Sets Table Top Lateral position in IEC TABLE TOP coordinate system (mm).
    
    Parameters:
    strTableTopLateralPosition - - String value of Table Top Lateral Position.
  - getTableTopLateralPosition
```
public java.lang.String getTableTopLateralPosition()
```
    Return Table Top Lateral position in IEC TABLE TOP coordinate system (mm).
    
    Returns:
    the table top lateral position
  - setIsocenterPosition
```
public void setIsocenterPosition(java.lang.String[] strIsocenterPosition)
```
    Sets Isocenter Position
    
    Parameters:
    strIsocenterPosition - String value of Isocenter Position
  - getIsocenterPosition
```
public java.lang.String[] getIsocenterPosition()
```
    Retrieves Isocenter Position
    
    Returns:
    String - value of Isocenter Position
  - setPatientPosition
```
public void setPatientPosition(java.lang.String strPatientPosition)
```
    Sets Patient Position
    
    Parameters:
    strPatientPosition - Specifies type of the value Patient Position
  - getPatientPosition
```
public java.lang.String getPatientPosition()
```
    Retrieves type of the value Patient Position
    
    Returns:
    String - Type of the value Patient Position
  - getVectorOfKeys
```
public ISingleCollection<ITag> getVectorOfKeys()
```
    This method returns the vector of keys representing the DataElements that belong to this module.
    
    Overrides:
    
    getVectorOfKeys in class Module
    
    Returns:
    vector of Tags - returns the vector containing the collection of tags

Class RTImageModule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

Methods inherited from class java.lang.Object

Field Detail

objSingleCollection

Constructor Detail

RTImageModule

Method Detail

validateModule

setSamplesPerPixel

getSamplesPerPixel

setPhotometricInterpretation

getPhotometricInterpretation

setBitsAllocated

getBitsAllocated

setBitsStored

getBitsStored

setHighBit

getHighBit

setPixelRepresentation

getPixelRepresentation

setPixelIntensityRelationship

getPixelIntensityRelationship

setPixelIntensityRelationshipSign

getPixelIntensityRelationshipSign

setRTImageLabel

getRTImageLabel

setRTImageName

getRTImageName

setRTImageDescription

getRTImageDescription

setImageType

getImageType

setConversionType

getConversionType

setReportedValuesOrigin

getReportedValuesOrigin

setRTImagePlane

getRTImagePlane

setXRayImageReceptorTranslation

getXRayImageReceptorTranslation

setXRayImageReceptorAngle

getXRayImageReceptorAngle

setRTImageOrientation

getRTImageOrientation

setImagePlanePixelSpacing

getImagePlanePixelSpacing

setRTImagePosition

getRTImagePosition

setRadiationMachineName

getRadiationMachineName

setPrimaryDosimeterUnit

getPrimaryDosimeterUnit

setRadiationMachineSAD

getRadiationMachineSAD

setRadiationMachineSSD

getRadiationMachineSSD

setRTImageSID

getRTImageSID

setSourceToReferenceObjectDistance

getSourceToReferenceObjectDistance

getReferencedRTPlanSequence

setReferencedBeamNumber

getReferencedBeamNumber

setReferencedFractionGroupNumber

getReferencedFractionGroupNumber

setFractionNumber

getFractionNumber

setStartCumulativeMetersetWeight

getStartCumulativeMetersetWeight

setEndCumulativeMetersetWeight

getEndCumulativeMetersetWeight

getExposureSequence

getFluenceMapSequence

setGantryAngle

getGantryAngle

setGantryPitchAngle