cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class CRImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CRImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class CRImageModule
extends Module

\* The class CRImageModule.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CRImageModule(IDataSet objIDataSet) Instantiates a new cR image module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcquisitionDeviceProcessingCode() Gets the acquisition device processing code.
java.lang.String	getAcquisitionDeviceProcessingDescription() Gets the acquisition device processing description.
BasicPixelSpacingCalibrationMacro	getBasicPixelSpacingCalibrationMacro() Get the Instance of Basic Pixel Spacing Calibration Macro Attributes.
java.lang.String	getCassetteOrientation() Gets the cassette orientation.
java.lang.String	getCassetteSize() Gets the cassette size.
java.lang.String	getDistanceSourceToDetector() Gets the distance source to detector.
java.lang.String	getDistanceSourceToPatient() Gets the distance source to patient.
java.lang.String	getExposure() Gets the exposure.
java.lang.String	getExposureinMicroAs() Gets the exposurein micro as.
short	getExposuresOnPlate() Gets the exposures on plate.
java.lang.String	getExposureTime() Gets the exposure time.
java.lang.String	getFilterType() Gets the filter type.
GeneralAnatomyOptionalMacro	getGeneralAnatomyOptionalMacro() Retrieves the instance of GeneralAnatomyOptionalMacro.
java.lang.String	getGeneratorPower() Gets the generator power.
java.lang.String[]	getImagerPixelSpacing() Gets the imager pixel spacing.
java.lang.String	getKVP() Gets the kVP.
java.lang.String	getPhotometricInterpretation() Gets the photometric interpretation.
java.lang.String	getPlateID() Gets the plate id.
java.lang.String	getRelativeXRayExposure() Gets the relative x ray exposure.
java.lang.String	getSensitivity() Gets the sensitivity.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
java.lang.String	getXrayTubeCurrent() Gets the xray tube current.
void	setAcquisitionDeviceProcessingCode(java.lang.String strAcquisitionDeviceProcessingCode) Sets Code representing the device-specific processing associated with the image (e.g.
void	setAcquisitionDeviceProcessingDescription(java.lang.String strAcquisitionDeviceProcessingDescription) Set the device-specific processing associated with the image (e.g.
void	setCassetteOrientation(EnumCassetteOrientation enumCassetteOrientation) Sets the Orientation of cassette, used to properly position the image for display.
void	setCassetteSize(EnumCassetteSize enumCassetteSize) Sets the Size of cassette.
void	setDistanceSourceToDetector(java.lang.String strDistanceSourceToDetector) The method is used to set Distance in mm from source to detector center.
void	setDistanceSourceToPatient(java.lang.String strDistanceSourceToPatient) The method is used to set Distance in mm from source to isocenter The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values.
void	setExposure(java.lang.String strExposure) The method is used to set The exposure expressed in mAs The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values.
void	setExposureinMicroAs(java.lang.String strExposureinMicroAs) The method is used to set The exposure expressed in MicroAs The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values.
void	setExposuresOnPlate(short shExposuresOnPlate) Total number of x-ray exposures that have been made on the plate identified in Plate ID (0018,1004).
void	setExposureTime(java.lang.String strExposureTime) The method is used to set Time of x-ray exposure in msec The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values.
void	setGeneratorPower(java.lang.String strGeneratorPower) The method is used to set Power in kW to the x-ray generator.
void	setImagerPixelSpacing(java.lang.String[] arrStrImagerPixelSpacing) Set the Physical distance measured at the front plane of the Image Receptor housing between the center of each pixel.
void	setKVP(java.lang.String strKVP) The method is used to set Peak kilo voltage output of the x-ray generator used The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values.
void	setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation) The method is used to set Specifies the intended interpretation of the pixel data.
void	setPlateID(java.lang.String strPlateID) The ID or serial number of the sensing plate upon which the image was acquired.
void	setRelativeXRayExposure(java.lang.String strRelativeXRayExposure) Sets the Relative x-ray exposure on the plate.
void	setSensitivity(java.lang.String strSensitivity) Read out sensitivity.
void	setXrayTubeCurrent(java.lang.String strXrayTubeCurrent) The method is used to set X-ray Tube Current in mA.
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

CRImageModule

public CRImageModule(IDataSet objIDataSet)

Instantiates a new cR 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 success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setPhotometricInterpretation

public void setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)

The method is used to set Specifies the intended interpretation of the pixel data. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap Enumerated Values: MONOCHROME1 MONOCHROME2

Parameters:

enumPhotometricInterpretation - the enum photometric interpretation

setKVP

public void setKVP(java.lang.String strKVP)

The method is used to set Peak kilo voltage output of the x-ray generator used The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strKVP - the str kvp

setPlateID

public void setPlateID(java.lang.String strPlateID)

The ID or serial number of the sensing plate upon which the image was acquired.

Parameters:

strPlateID - - Specifies ID or serial number of the sensing plate

setDistanceSourceToDetector

public void setDistanceSourceToDetector(java.lang.String strDistanceSourceToDetector)

The method is used to set Distance in mm from source to detector center. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strDistanceSourceToDetector - :String value of Data Reconstruction Diameter

setDistanceSourceToPatient

public void setDistanceSourceToPatient(java.lang.String strDistanceSourceToPatient)

The method is used to set Distance in mm from source to isocenter The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strDistanceSourceToPatient - :String value of Distance of Source To Patient

setExposureTime

public void setExposureTime(java.lang.String strExposureTime)

The method is used to set Time of x-ray exposure in msec The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strExposureTime - :String value of Time of x-ray exposure in msec

setXrayTubeCurrent

public void setXrayTubeCurrent(java.lang.String strXrayTubeCurrent)

The method is used to set X-ray Tube Current in mA. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strXrayTubeCurrent - :String value of X-ray Tube Current in mA.

setExposure

public void setExposure(java.lang.String strExposure)

The method is used to set The exposure expressed in mAs The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strExposure - :String value of The exposure expressed in mAs

setExposureinMicroAs

public void setExposureinMicroAs(java.lang.String strExposureinMicroAs)

The method is used to set The exposure expressed in MicroAs The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strExposureinMicroAs - :String value of The exposure expressed in mAs

setImagerPixelSpacing

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

Set 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 - the arr str imager pixel spacing

setGeneratorPower

public void setGeneratorPower(java.lang.String strGeneratorPower)

The method is used to set Power in kW to the x-ray generator.

Parameters:

strGeneratorPower - :String value of Power in kW to the x-ray generator.

setAcquisitionDeviceProcessingDescription

public void setAcquisitionDeviceProcessingDescription(java.lang.String strAcquisitionDeviceProcessingDescription)

Set the device-specific processing associated with the image (e.g. Organ Description)

Parameters:

strAcquisitionDeviceProcessingDescription - the str acquisition device processing description

setAcquisitionDeviceProcessingCode

public void setAcquisitionDeviceProcessingCode(java.lang.String strAcquisitionDeviceProcessingCode)

Sets Code representing the device-specific processing associated with the image (e.g. CR Organ Filtering code)

Parameters:

strAcquisitionDeviceProcessingCode - the str acquisition device processing code

setCassetteOrientation

public void setCassetteOrientation(EnumCassetteOrientation enumCassetteOrientation)

Sets the Orientation of cassette, used to properly position the image for display. Enumerated Values: LANDSCAPE, PORTRAIT

Parameters:

enumCassetteOrientation - the enum cassette orientation

setCassetteSize

public void setCassetteSize(EnumCassetteSize enumCassetteSize)

Sets the Size of cassette. Defined Terms: 18CMX24CM,8INX10IN,24CMX30CM,10INX12IN,30CMX35CM,30CMX40CM, 11INX14IN,35CMX35CM,14INX14IN,35CMX43CM,14INX17IN

Parameters:

enumCassetteSize - the enum cassette size

setExposuresOnPlate

public void setExposuresOnPlate(short shExposuresOnPlate)

Total number of x-ray exposures that have been made on the plate identified in Plate ID (0018,1004).

Parameters:

shExposuresOnPlate - the sh exposures on plate

setRelativeXRayExposure

public void setRelativeXRayExposure(java.lang.String strRelativeXRayExposure)

Sets the Relative x-ray exposure on the plate. Meaning of values is implementation specific. May be used to adjust the dynamic range of the plate digitizer (scanner).

Parameters:

strRelativeXRayExposure - the str relative x ray exposure

setSensitivity

public void setSensitivity(java.lang.String strSensitivity)

Read out sensitivity.

Parameters:

strSensitivity - the str sensitivity

getPhotometricInterpretation

public java.lang.String getPhotometricInterpretation()

Gets the photometric interpretation.

Returns:

the photometric interpretation

getPlateID

public java.lang.String getPlateID()

Gets the plate id.

Returns:

the plate id

getKVP

public java.lang.String getKVP()

Gets the kVP.

Returns:

the kVP

getDistanceSourceToDetector

public java.lang.String getDistanceSourceToDetector()

Gets the distance source to detector.

Returns:

the distance source to detector

getDistanceSourceToPatient

public java.lang.String getDistanceSourceToPatient()

Gets the distance source to patient.

Returns:

the distance source to patient

getExposureTime

public java.lang.String getExposureTime()

Gets the exposure time.

Returns:

the exposure time

getXrayTubeCurrent

public java.lang.String getXrayTubeCurrent()

Gets the xray tube current.

Returns:

the xray tube current

getExposure

public java.lang.String getExposure()

Gets the exposure.

Returns:

the exposure

getExposureinMicroAs

public java.lang.String getExposureinMicroAs()

Gets the exposurein micro as.

Returns:

the exposurein micro as

getFilterType

public java.lang.String getFilterType()

Gets the filter type.

Returns:

the filter type

getImagerPixelSpacing

public java.lang.String[] getImagerPixelSpacing()

Gets the imager pixel spacing.

Returns:

the imager pixel spacing

getBasicPixelSpacingCalibrationMacro

public BasicPixelSpacingCalibrationMacro getBasicPixelSpacingCalibrationMacro()

Get the Instance of Basic Pixel Spacing Calibration Macro Attributes. 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 Basic Pixel Spacing Calibration MacroAttributes which the user programmer can populate

getGeneratorPower

public java.lang.String getGeneratorPower()

Gets the generator power.

Returns:

the generator power

getAcquisitionDeviceProcessingDescription

public java.lang.String getAcquisitionDeviceProcessingDescription()

Gets the acquisition device processing description.

Returns:

the acquisition device processing description

getAcquisitionDeviceProcessingCode

public java.lang.String getAcquisitionDeviceProcessingCode()

Gets the acquisition device processing code.

Returns:

the acquisition device processing code

getCassetteOrientation

public java.lang.String getCassetteOrientation()

Gets the cassette orientation.

Returns:

the cassette orientation

getCassetteSize

public java.lang.String getCassetteSize()

Gets the cassette size.

Returns:

the cassette size

getExposuresOnPlate

public short getExposuresOnPlate()

Gets the exposures on plate.

Returns:

the exposures on plate

getRelativeXRayExposure

public java.lang.String getRelativeXRayExposure()

Gets the relative x ray exposure.

Returns:

the relative x ray exposure

getSensitivity

public java.lang.String getSensitivity()

Gets the sensitivity.

Returns:

the sensitivity

getGeneralAnatomyOptionalMacro

public GeneralAnatomyOptionalMacro getGeneralAnatomyOptionalMacro()

Retrieves the instance of GeneralAnatomyOptionalMacro. If the instance is not already present a new instance is created and returned. It is used to set the attribtues of GeneralAnatomyOptionalMacro in CR Image Module.

Returns:

- instance of GeneralAnatomyOptionalMacro.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the collection of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

collection of Tags - returns the vector containing the collection of tags