cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class UltrasoundFrameofReferenceModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.UltrasoundFrameofReferenceModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class UltrasoundFrameofReferenceModule
extends Module

\* This module specifies the Attributes that describe Ultrasound Frame of Reference Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
UltrasoundFrameofReferenceModule(IDataSet objIDataSet) Creates Ultrasound Frameof Reference Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
double[]	getApexPosition() Retrieves the Apex Position.
java.lang.String	getPatientFrameofReferenceSource() Retrieves Patient Frame of Reference Source.
java.lang.String	getTableFrameofReferenceUID() Retrieves the Table Frame of Reference UID.
java.lang.String	getUltrasoundAcquisitionGeometry() Retrieves Ultrasound Acquisition Geometry.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
java.lang.String	getVolumeFrameofReferenceUID() Retrieves Volume Frame of Reference UID.
double[]	getVolumetoTableMappingMatrix() Retrieves the Volume to Table Mapping Matrix.
double[]	getVolumetoTransducerMappingMatrix() Retrieves the Volume to Transducer Mapping Matrix.
java.lang.String	getVolumetoTransducerRelationship() Retrieves Volume to Transducer Relationship.
void	setApexPosition(double[] dblArrApexPosition) Sets the Apex Position
void	setPatientFrameofReferenceSource(EnumPatientFrameofReferenceSource enumPatientFrameofReferenceSource) Sets Patient Frame of Reference Source.
void	setTableFrameofReferenceUID(java.lang.String strTableFrameofReferenceUID) Sets Table Frame of Reference UID.
void	setUltrasoundAcquisitionGeometry(EnumUltrasoundAcquisitionGeometry enumUltrasoundAcquisitionGeometry) Sets Ultrasound Acquisition Geometry.
void	setVolumeFrameofReferenceUID(java.lang.String strVolumeFrameofReferenceUID) Sets Volume Frame of Reference UID.
void	setVolumetoTableMappingMatrix(double[] dblArrVolumetoTableMappingMatrix) Sets the Volume to Table Mapping Matrix
void	setVolumetoTransducerMappingMatrix(double[] dblArrVolumetoTransducerMappingMatrix) Sets the Volume to Transducer Mapping Matrix
void	setVolumetoTransducerRelationship(EnumVolumetoTransducerRelationship enumVolumetoTransducerRelationship) Sets Volume to Transducer Relationship.
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

UltrasoundFrameofReferenceModule

public UltrasoundFrameofReferenceModule(IDataSet objIDataSet)

Creates Ultrasound Frameof Reference Module with default initialization.

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:

true, if validate module

Throws:

InvalidModuleException - - If validation of Module fails

setVolumeFrameofReferenceUID

public void setVolumeFrameofReferenceUID(java.lang.String strVolumeFrameofReferenceUID)

Sets Volume Frame of Reference UID. Uniquely identifies this Volume Frame of Reference.

Parameters:

strVolumeFrameofReferenceUID - - Volume Frame of Reference UID.

getVolumeFrameofReferenceUID

public java.lang.String getVolumeFrameofReferenceUID()

Retrieves Volume Frame of Reference UID. Uniquely identifies this Volume Frame of Reference.

Returns:

- returns the Volume Frame of Reference UID

setUltrasoundAcquisitionGeometry

public void setUltrasoundAcquisitionGeometry(EnumUltrasoundAcquisitionGeometry enumUltrasoundAcquisitionGeometry)

Sets Ultrasound Acquisition Geometry. Characteristic of the ultrasound acquisition geometry. Enumerated Values: 1) APEX

Parameters:

enumUltrasoundAcquisitionGeometry - the enum Ultrasound Acquisition Geometry

getUltrasoundAcquisitionGeometry

public java.lang.String getUltrasoundAcquisitionGeometry()

Retrieves Ultrasound Acquisition Geometry. Characteristic of the ultrasound acquisition geometry.

Returns:

String - String value of Ultrasound Acquisition Geometry.

setApexPosition

public void setApexPosition(double[] dblArrApexPosition)

Sets the Apex Position

Parameters:

dblArrApexPosition - Double value of Apex Position

getApexPosition

public double[] getApexPosition()

Retrieves the Apex Position.

Returns:

double - double value of Apex Position

setVolumetoTransducerRelationship

public void setVolumetoTransducerRelationship(EnumVolumetoTransducerRelationship enumVolumetoTransducerRelationship)

Sets Volume to Transducer Relationship. Relationship between the transducer and the acquired volume. Enumerated Values: 1) FIXED 2) POSITION_VAR 3) ORIENTATION_VAR 4) VARIABLE

Parameters:

enumVolumetoTransducerRelationship - the enumvalue Volume to Transducer Relationship

getVolumetoTransducerRelationship

public java.lang.String getVolumetoTransducerRelationship()

Retrieves Volume to Transducer Relationship. Relationship between the transducer and the acquired volume.

Returns:

String - String value of Volume to Transducer Relationship.

setVolumetoTransducerMappingMatrix

public void setVolumetoTransducerMappingMatrix(double[] dblArrVolumetoTransducerMappingMatrix)

Sets the Volume to Transducer Mapping Matrix

Parameters:

dblArrVolumetoTransducerMappingMatrix - Double value of Volume to Transducer Mapping Matrix

getVolumetoTransducerMappingMatrix

public double[] getVolumetoTransducerMappingMatrix()

Retrieves the Volume to Transducer Mapping Matrix.

Returns:

double - double value of Volume to Transducer Mapping Matrix

setPatientFrameofReferenceSource

public void setPatientFrameofReferenceSource(EnumPatientFrameofReferenceSource enumPatientFrameofReferenceSource)

Sets Patient Frame of Reference Source. Indicates how the supplied Image Position (Patient) (0020,0032) and ImageOrientation (Patient) (0020,0037) values are obtained. Enumerated Values: 1) TABLE 2) ESTIMATED 3) REGISTRATION

Parameters:

enumPatientFrameofReferenceSource - the enumvalue Patient Frame of Reference Source

getPatientFrameofReferenceSource

public java.lang.String getPatientFrameofReferenceSource()

Retrieves Patient Frame of Reference Source.

Returns:

String - String value of Patient Frame of Reference Source.

setTableFrameofReferenceUID

public void setTableFrameofReferenceUID(java.lang.String strTableFrameofReferenceUID)

Sets Table Frame of Reference UID. Uniquely identifies this Table Frame of Reference.

Parameters:

strTableFrameofReferenceUID - - Table Frame of Reference UID.

getTableFrameofReferenceUID

public java.lang.String getTableFrameofReferenceUID()

Retrieves the Table Frame of Reference UID. Uniquely identifies this Table Frame of Reference.

Returns:

- returns the Table Frame of Reference UID

setVolumetoTableMappingMatrix

public void setVolumetoTableMappingMatrix(double[] dblArrVolumetoTableMappingMatrix)

Sets the Volume to Table Mapping Matrix

Parameters:

dblArrVolumetoTableMappingMatrix - Double value of Volume to Table Mapping Matrix

getVolumetoTableMappingMatrix

public double[] getVolumetoTableMappingMatrix()

Retrieves the Volume to Table Mapping Matrix.

Returns:

double - double value of Volume to Table Mapping Matrix

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 collection containing the tags