cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class SCMultiFrameVectorModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SCMultiFrameVectorModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class SCMultiFrameVectorModule
extends Module

\* This module contains IOD Attributes that may be the target of the Frame Increment Pointer (0028,0009) for SC Multi-frame images.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SCMultiFrameVectorModule(IDataSet objIDataSet) Instantiates a new sC multi frame vector module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getDisplayWindowLabelVector() Retrieves An array which contains, for each of the image frames, a label or number of the display window of a graphical user interface from which the frame was captured.
java.lang.String[]	getFrameLabelVector() Return multi-valued attribute that contains a descriptive label for each of the image.
java.lang.String[]	getFramePrimaryAngleVector() Retrieves an array for each of the image frames, the primary angle of rotation about an undefined axis,in degrees.
java.lang.String[]	getFrameSecondaryAngleVector() Retrieves an array for each of the image frames, the secondary angle of rotation about an undefined axis,in degrees.
java.lang.String[]	getFrameTimeVector() Retrieves An array that contains the real time increments (in msec) between frames for a Multi-frame image.
java.lang.String[]	getPageNumberVector() Retrieves an array which contains, for each of the image frames, the corresponding page numbers of the original document.
java.lang.String[]	getSliceLocationVector() Retrieves Relative position of exposure expressed in mm, as defined for Slice Location (0020,1041).
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setDisplayWindowLabelVector(java.lang.String[] arrStrDisplayWindowLabelVector) Sets An array which contains, for each of the image frames, a label or number of the display window of a graphical user interface from which the frame was captured.
void	setFrameLabelVector(java.lang.String[] arrStrFrameLabelVector) Sets a multi-valued attribute that contains a descriptive label for each of the image frames.
void	setFramePrimaryAngleVector(java.lang.String[] arrStrFramePrimaryAngleVector) Sets an array for each of the image frames, the primary angle of rotation about an undefined axis, in degrees.
void	setFrameSecondaryAngleVector(java.lang.String[] arrStrFrameSecondaryAngleVector) Sets an array for each of the image frames, the secondary angle of rotation about an undefined axis, i.e.
void	setFrameTimeVector(java.lang.String[] arrStrFrameTimeVector) Sets an array that contains the real time increments (in msec) between frames for a Multi-frame image.
void	setPageNumberVector(java.lang.String[] arrStrPageNumberVector) Sets an array which contains, for each of the image frames, the corresponding page numbers of the original document.
void	setSliceLocationVector(java.lang.String[] arrStrSliceLocationVector) Sets Relative position of exposure expressed in mm, as defined for Slice Location (0020,1041).
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

SCMultiFrameVectorModule

public SCMultiFrameVectorModule(IDataSet objIDataSet)

Instantiates a new sC multi frame vector 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 as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setFrameTimeVector

public void setFrameTimeVector(java.lang.String[] arrStrFrameTimeVector)

Sets an array that contains the real time increments (in msec) between frames for a Multi-frame image. Required if Frame Increment Pointer (0028,0009) points to Frame Time Vector.

Parameters:

arrStrFrameTimeVector - - String array of Frame Time values.

getFrameTimeVector

public java.lang.String[] getFrameTimeVector()

Retrieves An array that contains the real time increments (in msec) between frames for a Multi-frame image.

Returns:

String[] - String array of Frame Time values.

setPageNumberVector

public void setPageNumberVector(java.lang.String[] arrStrPageNumberVector)

Sets an array which contains, for each of the image frames, the corresponding page numbers of the original document.

Parameters:

arrStrPageNumberVector - - String array of Page Number Vector.

getPageNumberVector

public java.lang.String[] getPageNumberVector()

Retrieves an array which contains, for each of the image frames, the corresponding page numbers of the original document.

Returns:

String[] - String array of Page Number Vector.

setFrameLabelVector

public void setFrameLabelVector(java.lang.String[] arrStrFrameLabelVector)

Sets a multi-valued attribute that contains a descriptive label for each of the image frames.

Parameters:

arrStrFrameLabelVector - the arr str frame label vector

getFrameLabelVector

public java.lang.String[] getFrameLabelVector()

Return multi-valued attribute that contains a descriptive label for each of the image.

Returns:

String[] - String Array of String array of FrameLabelVector

setFramePrimaryAngleVector

public void setFramePrimaryAngleVector(java.lang.String[] arrStrFramePrimaryAngleVector)

Sets an array for each of the image frames, the primary angle of rotation about an undefined axis, in degrees. May be used for annotative purposes for cine loops of 3D reprojected images.

Parameters:

arrStrFramePrimaryAngleVector - - String array of Frame Primary Angle Vector.

getFramePrimaryAngleVector

public java.lang.String[] getFramePrimaryAngleVector()

Retrieves an array for each of the image frames, the primary angle of rotation about an undefined axis,in degrees.

Returns:

String[] - String array of Frame Primary Angle Vector.

setFrameSecondaryAngleVector

public void setFrameSecondaryAngleVector(java.lang.String[] arrStrFrameSecondaryAngleVector)

Sets an array for each of the image frames, the secondary angle of rotation about an undefined axis, i.e. orthogonal to that used for Frame Primary Angle Vector (0018,2003), in degrees. May be used for annotative purposes for cine loops of 3D reprojected images.

Parameters:

arrStrFrameSecondaryAngleVector - - String array of Frame Secondary Angle Vector.

getFrameSecondaryAngleVector

public java.lang.String[] getFrameSecondaryAngleVector()

Retrieves an array for each of the image frames, the secondary angle of rotation about an undefined axis,in degrees.

Returns:

String[] - String array of Frame secondary Angle Vector.

setSliceLocationVector

public void setSliceLocationVector(java.lang.String[] arrStrSliceLocationVector)

Sets Relative position of exposure expressed in mm, as defined for Slice Location (0020,1041).

Parameters:

arrStrSliceLocationVector - - String array of Slice Location Vector.

getSliceLocationVector

public java.lang.String[] getSliceLocationVector()

Retrieves Relative position of exposure expressed in mm, as defined for Slice Location (0020,1041).

Returns:

String[] - String array of Slice Location Vector.

setDisplayWindowLabelVector

public void setDisplayWindowLabelVector(java.lang.String[] arrStrDisplayWindowLabelVector)

Sets An array which contains, for each of the image frames, a label or number of the display window of a graphical user interface from which the frame was captured.

Parameters:

arrStrDisplayWindowLabelVector - - String array of Display Window Label Vector.

getDisplayWindowLabelVector

public java.lang.String[] getDisplayWindowLabelVector()

Retrieves An array which contains, for each of the image frames, a label or number of the display window of a graphical user interface from which the frame was captured.

Returns:

String[] - String array of Display Window Label Vector.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

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

Overrides:

getVectorOfKeys in class Module

Returns:

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