cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class MammographyImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.MammographyImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class MammographyImageModule
extends Module

\* This module contains IOD Attributes that describe a Digital Mammography X-Ray Image including its acquisition and positioning.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MammographyImageModule(IDataSet objIDataSet) Instantiates a new mammography image module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDistanceSourceToDetector() Return Distance in mm from transmission source to the detector face.
java.lang.String	getDistanceSourceToPatient() Retrieves Distance in mm from source to isocenter.
java.lang.String	getImageLaterality() Retrieves Laterality of (possibly paired) body part (as described in Anatomic Region Sequence(0008,2218)) examined.
java.lang.String	getImageType() Retrieves type of the value encoded in this Item
java.lang.String	getImplantPresent() Retrieves whether or not an implant is present.
java.lang.String	getOrganExposed() Retrieves Organ to which Organ Dose (0040,0316) applies.
java.lang.String	getPartialView() Retrieves value that indicates whether this image is a partial view.
java.lang.String	getPartialViewDescription() Retrieves Free text description of the portion of the breast captured in a partial view image.
java.lang.String	getPositionerPrimaryAngle() Sets position of the X-Ray beam about the patient from the RAO to LAO direction where movement from RAO to vertical is positive, if Positioner Type (0018,1508) is CARM.
java.lang.String	getPositionerSecondaryAngle() Retrievs position of the X-Ray beam about the patient from the CAU to CRA direction where movement from RAO to vertical is positive, if Positioner Type (0018,1508) is CARM.
java.lang.String	getPositionerType() Sets Positioner Type.
ISingleCollection<ITag>	getVectorOfKeys() Returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.
void	setDistanceSourceToDetector(java.lang.String strDistanceSourceToDetector) Sets Distance in mm from transmission source to the detector face.
void	setDistanceSourceToPatient(java.lang.String strDistanceSourceToPatient) Sets Distance in mm from source to isocenter.
void	setImageLaterality(EnumImageLaterality enumImageLaterality) Sets Laterality of (possibly paired) body part (as described in Anatomic Region Sequence(0008,2218)) examined.
void	setImageType(java.lang.String strImageType) Sets the Value Type Defined in Terms of TEXT,NUMERIC,CODE,DATE,TIME,PNAME
void	setImplantPresent(EnumImplantPresent enumImplantPresent) Sets whether or not an implant is present.
void	setOrganExposed(EnumOrganExposed enumOrganExposed) Sets Organ to which Organ Dose (0040,0316) applies.
void	setPartialView(EnumPartialView enumPartialView) Sets value that indicates whether this image is a partial view, that is a subset of a single view of the breast.
void	setPartialViewDescription(java.lang.String strPartialViewDescription) Sets Free text description of the portion of the breast captured in a partial view image.
void	setPositionerPrimaryAngle(java.lang.String strPositionerPrimaryAngle) Sets position of the X-Ray beam about the patient from the RAO to LAO direction where movement from RAO to vertical is positive, if Positioner Type (0018,1508) is CARM.
void	setPositionerSecondaryAngle(java.lang.String strPositionerSecondaryAngle) Sets Position of the X-Ray beam about the patient from the CAU to CRA direction where movement from CAU to vertical is positive, if Positioner Type (0018,1508) is CARM.
void	setPositionerType(EnumPositionerType enumPositionerType) Sets Positioner Type.
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

MammographyImageModule

public MammographyImageModule(IDataSet objIDataSet)

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

- validation status as success or failure

Throws:

InvalidModuleException - - when the module is invalid

setImageType

public void setImageType(java.lang.String strImageType)

Sets the Value Type Defined in Terms of TEXT,NUMERIC,CODE,DATE,TIME,PNAME

Parameters:

strImageType - Specifies type of the value encoded in this Item

getImageType

public java.lang.String getImageType()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setPositionerType

public void setPositionerType(EnumPositionerType enumPositionerType)

Sets Positioner Type. Enumerated Values: MAMMOGRAPHIC,NONE.

Parameters:

enumPositionerType - - Enum value of Positioner Type.

getPositionerType

public java.lang.String getPositionerType()

Sets Positioner Type.

Returns:

String - String value of Positioner Type.

setDistanceSourceToPatient

public void setDistanceSourceToPatient(java.lang.String strDistanceSourceToPatient)

Sets Distance in mm from source to isocenter.

Parameters:

strDistanceSourceToPatient - - String value of Distance of Source To Patient

getDistanceSourceToPatient

public java.lang.String getDistanceSourceToPatient()

Retrieves Distance in mm from source to isocenter.

Returns:

String value of Distance of Source To Patient

setDistanceSourceToDetector

public void setDistanceSourceToDetector(java.lang.String strDistanceSourceToDetector)

Sets Distance in mm from transmission source to the detector face. Required if Image Type (0008,0008) Value 4 is TRANSMISSION, Value 3 is not TOMO, and a sequence Item is present.

Parameters:

strDistanceSourceToDetector - - String value of Distance Source to Detector

getDistanceSourceToDetector

public java.lang.String getDistanceSourceToDetector()

Return Distance in mm from transmission source to the detector face.

Returns:

String - String value of Distance Source to Detector

setPositionerPrimaryAngle

public void setPositionerPrimaryAngle(java.lang.String strPositionerPrimaryAngle)

Sets position of the X-Ray beam about the patient from the RAO to LAO direction where movement from RAO to vertical is positive, if Positioner Type (0018,1508) is CARM.

Parameters:

strPositionerPrimaryAngle - - String value of Positioner Primary Angle

getPositionerPrimaryAngle

public java.lang.String getPositionerPrimaryAngle()

Sets position of the X-Ray beam about the patient from the RAO to LAO direction where movement from RAO to vertical is positive, if Positioner Type (0018,1508) is CARM.

Returns:

String - String value of Positioner Primary Angle

setPositionerSecondaryAngle

public void setPositionerSecondaryAngle(java.lang.String strPositionerSecondaryAngle)

Sets Position of the X-Ray beam about the patient from the CAU to CRA direction where movement from CAU to vertical is positive, if Positioner Type (0018,1508) is CARM.

Parameters:

strPositionerSecondaryAngle - - String value of Positioner Secondary Angle

getPositionerSecondaryAngle

public java.lang.String getPositionerSecondaryAngle()

Retrievs position of the X-Ray beam about the patient from the CAU to CRA direction where movement from RAO to vertical is positive, if Positioner Type (0018,1508) is CARM.

Returns:

String - String value of Positioner Secondary Angle

setImageLaterality

public void setImageLaterality(EnumImageLaterality enumImageLaterality)

Sets Laterality of (possibly paired) body part (as described in Anatomic Region Sequence(0008,2218)) examined. Enumerated Values: R = right L = left U = unpaired B = both left and right

Parameters:

enumImageLaterality - the enum image laterality

getImageLaterality

public java.lang.String getImageLaterality()

Retrieves Laterality of (possibly paired) body part (as described in Anatomic Region Sequence(0008,2218)) examined.

Returns:

String value of Image Laterality.

setOrganExposed

public void setOrganExposed(EnumOrganExposed enumOrganExposed)

Sets Organ to which Organ Dose (0040,0316) applies. Defined Terms:BREAST,GONADS,BONE MARROW,FETUS,LENS.

Parameters:

enumOrganExposed - the enum organ exposed

getOrganExposed

public java.lang.String getOrganExposed()

Retrieves Organ to which Organ Dose (0040,0316) applies.

Returns:

String - String value of Organ Dose.

setImplantPresent

public void setImplantPresent(EnumImplantPresent enumImplantPresent)

Sets whether or not an implant is present. Enumerated Values: YES,NO.

Parameters:

enumImplantPresent - - enum value of Implant Present.

getImplantPresent

public java.lang.String getImplantPresent()

Retrieves whether or not an implant is present.

Returns:

String - String value of Implant Present.

setPartialView

public void setPartialView(EnumPartialView enumPartialView)

Sets value that indicates whether this image is a partial view, that is a subset of a single view of the breast. Enumerated Values: YES, NO.

Parameters:

enumPartialView - - enum value of Partial View.

getPartialView

public java.lang.String getPartialView()

Retrieves value that indicates whether this image is a partial view.

Returns:

String - String value of Partial View.

setPartialViewDescription

public void setPartialViewDescription(java.lang.String strPartialViewDescription)

Sets Free text description of the portion of the breast captured in a partial view image.

Parameters:

strPartialViewDescription - - String value of Partial View Description.

getPartialViewDescription

public java.lang.String getPartialViewDescription()

Retrieves Free text description of the portion of the breast captured in a partial view image.

Returns:

String - String value of Partial View Description.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

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