cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class SlideCoordinatesModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SlideCoordinatesModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class SlideCoordinatesModule
extends Module

\* This module describes the attributes in Slide Coordinates Module. Slide Coordinates provide a means to position a robotic Microscope Stage reproducibly with respect to the pixel plane of the digital Microscope.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SlideCoordinatesModule(IDataSet objIDataSet) Creates Slide Coordinates Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
ImageCenterPointCoordinatesSequence	getImageCenterPointCoordinatesSequence() Retrieves pre-initialized object of Image Center Point Coordinates Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
PixelSpacingSequence	getPixelSpacingSequence() Retrieves pre-initialized object of Pixel Spacing Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
ISingleCollection<ITag>	getVectorOfKeys() This method returns the custom collection containing the list of DataElements belonging to the Slide Coordinates Module specified by DICOM Standard.
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

SlideCoordinatesModule

public SlideCoordinatesModule(IDataSet objIDataSet)

Creates Slide Coordinates 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:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - If validation of Module fails

getImageCenterPointCoordinatesSequence

public ImageCenterPointCoordinatesSequence getImageCenterPointCoordinatesSequence()

Retrieves pre-initialized object of Image Center Point Coordinates Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

ImageCenterPointCoordinatesSequence - instance of Image Center Point Coordinates Sequence.

getPixelSpacingSequence

public PixelSpacingSequence getPixelSpacingSequence()

Retrieves pre-initialized object of Pixel Spacing Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

PixelSpacingSequence - instance of Pixel Spacing Sequence.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

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

Overrides:

getVectorOfKeys in class Module

Returns:

collection - custom collection containing the list of DataElements belonging to the Slide Coordinates Module