cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class DXDetectorModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.DXDetectorModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class DXDetectorModule
extends Module

\* This module contains IOD Attributes that describe a DX detector.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DXDetectorModule(IDataSet objIDataSet) Instantiates a new dX detector module.

Method Summary

Methods

Modifier and Type	Method and Description
BasicPixelSpacingCalibrationMacro	getBasicPixelSpacingCalibrationMacro() Get the Instance of Code Sequence Macro.Attributes related to Code Sequence Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first.
java.lang.String	getCassetteID() Return user-defined label identifier for Cassette ID.
java.lang.String	getDetectorActivationOffsetFromExposure() Return time in mSec that the detector becomes active after the X-Ray beam is turned on during acquisition of this image.
java.lang.String	getDetectorActiveTime() Return time in mSec that the detector is active during acquisition of this image.
DigitalXRayDetectorMacro	getDigitalXRayDetectorMacro() Get the Instance of Digital XRay Detector Macro.Attributes related to Code Sequence Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first.
java.lang.String[]	getFieldOfViewDimensions() Returns type of filter(s) inserted into the X-Ray beam.
java.lang.String	getFieldOfViewHorizontalFlip() Return whether or not a horizontal flip has been applied to the Field of View.
java.lang.String[]	getFieldOfViewOrigin() Returns offset of the TLHC of a rectangle circumscribing the Field of View, that is the image pixels stored in Pixel Data (7FE0,0010), before rotation or flipping, from the TLHC of the physical detector area measured in physical detector pixels as a row offset followed by a column offset.
java.lang.String	getFieldOfViewRotation() Return clockwise rotation in degrees of Field of View, that is the image pixels stored in Pixel Data (7FE0,0010), relative to the physical detector.
java.lang.String	getFieldOfViewShape() Return shape of the Field of View, that is the image pixels stored in Pixel Data (7FE0,0010).
java.lang.String[]	getImagerPixelSpacing() Return Physical distance measured at the front plane of the Image Receptor housing between the center of each pixel.
java.lang.String	getPlateID() Return user-defined label identifier for Plate ID.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.
void	setCassetteID(java.lang.String strCassetteID) Sets CassetteID
java.lang.String	setDetectorActivationOffsetFromExposure() Return Offset time in mSec that the detector becomes active after the X-Ray beam is turned on during acquisition of this image.
void	setDetectorActivationOffsetFromExposure(java.lang.String strDetectorActivationOffsetFromExposure) Sets Offset time in mSec that the detector becomes active after the X-Ray beam is turned on during acquisition of this image.
void	setDetectorActiveTime(java.lang.String strDetectorActiveTime) Sets time in mSec that the detector is active during acquisition of this image.
void	setFieldOfViewDimensions(java.lang.String[] arrStrFieldOfViewDimensions) Sets Dimensions of the Image Intensifier Field of View in mm.
void	setFieldOfViewHorizontalFlip(EnumFieldOfViewHorizontalFlip enumFieldOfViewHorizontalFlip) Sets whether or not a horizontal flip has been applied to the Field of View, that is the image pixels stored in Pixel Data (7FE0,0010), after rotation relative to the physical detector as described in Field of View Rotation (0018,7032).
void	setFieldOfViewOrigin(java.lang.String[] arrStrFieldOfViewOrigin) Sets offset of the TLHC of a rectangle circumscribing the Field of View, that is the image pixels stored in Pixel Data (7FE0,0010), before rotation or flipping, from the TLHC of the physical detector area measured in physical detector pixels as a row offset followed by a column offset.
void	setFieldOfViewRotation(EnumFieldOfViewRotation enumFieldOfViewRotation) Sets clockwise rotation in degrees of Field of View, that is the image pixels stored in Pixel Data (7FE0,0010), relative to the physical detector.
void	setFieldOfViewShape(EnumFieldOfViewShape enumFieldOfViewShape) Sets shape of the Field of View, that is the image pixels stored in Pixel Data (7FE0,0010).
void	setImagerPixelSpacing(java.lang.String[] arrStrImagerPixelSpacing) Sets the Physical distance measured at the front plane of the Image Receptor housing between the center of each pixel.
void	setPlateID(java.lang.String strPlateID) Sets Plate ID
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

DXDetectorModule

public DXDetectorModule(IDataSet objIDataSet)

Instantiates a new dX detector 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:

- returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

getDigitalXRayDetectorMacro

public DigitalXRayDetectorMacro getDigitalXRayDetectorMacro()

Get the Instance of Digital XRay Detector Macro.Attributes related to Code Sequence Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was set in the last call to its setter method.

Returns:

- object of code sequence macro which the user programmer can populate

setDetectorActiveTime

public void setDetectorActiveTime(java.lang.String strDetectorActiveTime)

Sets time in mSec that the detector is active during acquisition of this image.

Parameters:

strDetectorActiveTime - - String value of Detector Active Time

getDetectorActiveTime

public java.lang.String getDetectorActiveTime()

Return time in mSec that the detector is active during acquisition of this image.

Returns:

- String value of Detector Active Time

setDetectorActivationOffsetFromExposure

public void setDetectorActivationOffsetFromExposure(java.lang.String strDetectorActivationOffsetFromExposure)

Sets Offset time in mSec that the detector becomes active after the X-Ray beam is turned on during acquisition of this image. May be negative.

Parameters:

strDetectorActivationOffsetFromExposure - - String value of Detector Activation Offset From Exposure

getDetectorActivationOffsetFromExposure

public java.lang.String getDetectorActivationOffsetFromExposure()

Return time in mSec that the detector becomes active after the X-Ray beam is turned on during acquisition of this image. May be negative.

Returns:

- String value of Detector Activation Offset From Exposure

setDetectorActivationOffsetFromExposure

public java.lang.String setDetectorActivationOffsetFromExposure()

Return Offset time in mSec that the detector becomes active after the X-Ray beam is turned on during acquisition of this image.

Returns:

- String value of Detector Activation Offset From Exposure

setFieldOfViewShape

public void setFieldOfViewShape(EnumFieldOfViewShape enumFieldOfViewShape)

Sets shape of the Field of View, that is the image pixels stored in Pixel Data (7FE0,0010). Enumerated Values: RECTANGLE, ROUND, HEXAGONAL.

Parameters:

enumFieldOfViewShape - the enum field of view shape

getFieldOfViewShape

public java.lang.String getFieldOfViewShape()

Return shape of the Field of View, that is the image pixels stored in Pixel Data (7FE0,0010).

Returns:

- String value of Field of View Shape

setFieldOfViewDimensions

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

Sets Dimensions of the Image Intensifier Field of View in mm. If Rectangle, row dimension followed by column; if Round, diameter.

Parameters:

arrStrFieldOfViewDimensions - - String array of Field of View Dimensions

getFieldOfViewDimensions

public java.lang.String[] getFieldOfViewDimensions()

Returns type of filter(s) inserted into the X-Ray beam.

Returns:

- String Array of Field Of View Dimensions

setFieldOfViewOrigin

public void setFieldOfViewOrigin(java.lang.String[] arrStrFieldOfViewOrigin)

Sets offset of the TLHC of a rectangle circumscribing the Field of View, that is the image pixels stored in Pixel Data (7FE0,0010), before rotation or flipping, from the TLHC of the physical detector area measured in physical detector pixels as a row offset followed by a column offset.

Parameters:

arrStrFieldOfViewOrigin - - String array of Field of View Origin

getFieldOfViewOrigin

public java.lang.String[] getFieldOfViewOrigin()

Returns offset of the TLHC of a rectangle circumscribing the Field of View, that is the image pixels stored in Pixel Data (7FE0,0010), before rotation or flipping, from the TLHC of the physical detector area measured in physical detector pixels as a row offset followed by a column offset.

Returns:

- String Array of Field of View Origin

setFieldOfViewRotation

public void setFieldOfViewRotation(EnumFieldOfViewRotation enumFieldOfViewRotation)

Sets clockwise rotation in degrees of Field of View, that is the image pixels stored in Pixel Data (7FE0,0010), relative to the physical detector. Enumerated Values: 0, 90, 180, 270. Required if Field of View Horizontal Flip (0018,7034) is present.

Parameters:

enumFieldOfViewRotation - the enum field of view rotation

getFieldOfViewRotation

public java.lang.String getFieldOfViewRotation()

Return clockwise rotation in degrees of Field of View, that is the image pixels stored in Pixel Data (7FE0,0010), relative to the physical detector.

Returns:

- String value of Field of View Rotation

setFieldOfViewHorizontalFlip

public void setFieldOfViewHorizontalFlip(EnumFieldOfViewHorizontalFlip enumFieldOfViewHorizontalFlip)

Sets whether or not a horizontal flip has been applied to the Field of View, that is the image pixels stored in Pixel Data (7FE0,0010), after rotation relative to the physical detector as described in Field of View Rotation (0018,7032). Enumerated Values: NO,YES.Required if Field of View Rotation (0018,7032) is present.

Parameters:

enumFieldOfViewHorizontalFlip - the enum field of view horizontal flip

getFieldOfViewHorizontalFlip

public java.lang.String getFieldOfViewHorizontalFlip()

Return whether or not a horizontal flip has been applied to the Field of View.

Returns:

- String value of Field of View Horizontal Flip

setImagerPixelSpacing

public void setImagerPixelSpacing(java.lang.String[] arrStrImagerPixelSpacing)

Sets the Physical distance measured at the front plane of the Image Receptor housing between the center of each pixel. Specified by a numeric pair - row spacing value (delimiter) column spacing value - in mm. In the case of CR, the front plane is defined to be the external surface of the CR plate closest to the patient and radiation source.

Parameters:

arrStrImagerPixelSpacing - - image pixel spacing values

getImagerPixelSpacing

public java.lang.String[] getImagerPixelSpacing()

Return Physical distance measured at the front plane of the Image Receptor housing between the center of each pixel.

Returns:

- String value of Imager Pixel Spacing.

getBasicPixelSpacingCalibrationMacro

public BasicPixelSpacingCalibrationMacro getBasicPixelSpacingCalibrationMacro()

Get the Instance of Code Sequence Macro.Attributes related to Code Sequence Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was set in the last call to its setter method.

Returns:

- object of code sequence macro which the user programmer can populate

setCassetteID

public void setCassetteID(java.lang.String strCassetteID)

Sets CassetteID

Parameters:

strCassetteID - String value of Cassette ID.

getCassetteID

public java.lang.String getCassetteID()

Return user-defined label identifier for Cassette ID.

Returns:

String - value of Cassette ID.

setPlateID

public void setPlateID(java.lang.String strPlateID)

Sets Plate ID

Parameters:

strCassetteID - String value of Plate ID.

getPlateID

public java.lang.String getPlateID()

Return user-defined label identifier for Plate ID.

Returns:

String - value of PlateID.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

collection - custom collection containing the list of DataElements belonging to the CT Image Module