cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class IntravascularOCTProcessingParametersModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IntravascularOCTProcessingParametersModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class IntravascularOCTProcessingParametersModule
extends Module

\* This module describes attributes in Intravascular OCT Processing Parameters Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
IntravascularOCTProcessingParametersModule(IDataSet objIDataSet) Creates Intravascular OCT Processing Parameters Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
double	getAlinePixelSpacing() Retrieves A-line Pixel Spacing.
double	getFirstAlineLocation() Retrieves First A-line Location.
java.lang.String	getOCTZOffsetApplied() Retrieves OCT Z Offset Applied.
java.lang.String	getPixelIntensityRelationship() Retrieves Pixel Intensity Relationship.
java.lang.String	getRefractiveIndexApplied() Retrieves Refractive Index Applied.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
void	setAlinePixelSpacing(double dAlinePixelSpacing) Sets A-line Pixel Spacing.
void	setFirstAlineLocation(double dFirstAlineLocation) Sets First A-line Location.
void	setOCTZOffsetApplied(EnumOCTZOffsetApplied enumOCTZOffsetApplied) Sets OCT Z Offset Applied.
void	setPixelIntensityRelationship(EnumPixelIntensityRelationship enumPixelIntensityRelationship) Sets Pixel Intensity Relationship.
void	setRefractiveIndexApplied(EnumRefractiveIndexApplied enumRefractiveIndexApplied) Sets Refractive Index Applied.
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

IntravascularOCTProcessingParametersModule

public IntravascularOCTProcessingParametersModule(IDataSet objIDataSet)

Creates Intravascular OCT Processing Parameters 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

setOCTZOffsetApplied

public void setOCTZOffsetApplied(EnumOCTZOffsetApplied enumOCTZOffsetApplied)

Sets OCT Z Offset Applied. Indicates whether or not Z offset correction was applied to the OCT image frames. Enumerated Values: 1) YES 2) NO

Parameters:

enumOCTZOffsetApplied - the enum OCT Z Offset Applied

getOCTZOffsetApplied

public java.lang.String getOCTZOffsetApplied()

Retrieves OCT Z Offset Applied.

Returns:

String - String value of OCT Z Offset Applied.

setRefractiveIndexApplied

public void setRefractiveIndexApplied(EnumRefractiveIndexApplied enumRefractiveIndexApplied)

Sets Refractive Index Applied. Indicates whether or not Refractive Index correction was applied. Enumerated Values: 1) YES 2) NO

Parameters:

enumRefractiveIndexApplied - the enum Refractive Index Applied

getRefractiveIndexApplied

public java.lang.String getRefractiveIndexApplied()

Retrieves Refractive Index Applied.

Returns:

String - String value of Refractive Index Applied.

setAlinePixelSpacing

public void setAlinePixelSpacing(double dAlinePixelSpacing)

Sets A-line Pixel Spacing. Spacing of pixels in the A-line (X-axis), in mm.

Parameters:

dAlinePixelSpacing - double value of A-line Pixel Spacing.

getAlinePixelSpacing

public double getAlinePixelSpacing()

Retrieves A-line Pixel Spacing. Spacing of pixels in the A-line (X-axis), in mm.

Returns:

double - double value of A-line Pixel Spacing.

setPixelIntensityRelationship

public void setPixelIntensityRelationship(EnumPixelIntensityRelationship enumPixelIntensityRelationship)

Sets Pixel Intensity Relationship. The relationship between the pixel sample values and the IVOCTA-line intensity. Enumerated Values: 1) LIN 2) LOG

Parameters:

enumPixelIntensityRelationship - the enum Refractive Index Applied

getPixelIntensityRelationship

public java.lang.String getPixelIntensityRelationship()

Retrieves Pixel Intensity Relationship.

Returns:

String - String value of Pixel Intensity Relationship.

setFirstAlineLocation

public void setFirstAlineLocation(double dFirstAlineLocation)

Sets First A-line Location. Orientation in degrees at which the 1st A-line in the frame should be displayed.

Parameters:

dFirstAlineLocation - double value of First A-line Location.

getFirstAlineLocation

public double getFirstAlineLocation()

Retrieves First A-line Location.

Returns:

double - double value of First A-line Location.

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