cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class NMMultiFrameModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NMMultiFrameModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class NMMultiFrameModule
extends Module

\* This module specifies the Attributes of a NM Multi-frame Image. This module is always included in a NM SOP instance, even if there is only one frame in the image.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
NMMultiFrameModule(IDataSet objIDataSet) Instantiates a new nM multi frame module.

Method Summary

Methods

Modifier and Type	Method and Description
short[]	getAngularViewVector() Retrieves An array which contains the angular view number for each frame.
short[]	getDetectorVector() Retrieves An array which contains the detector number for each frame.
short[]	getEnergyWindowVector() Retrieves An array which contains the energy window number for each frame.
ISingleCollection<ITag>	getFrameIncrementPointer() Retrieves Data Element Tags of one or more frame index vectors.
short	getNumberOfDetectors() Retrieves Number of detectors.
short	getNumberofEnergyWindows() Retrieves Number of energy window groupings.
short	getNumberOfPhases() Retrieves Number of phases.
short	getNumberOfRotations() Retrieves Number of rotations.
short	getNumberOfRRIntervals() Retrieves Number of R-R intervals.
short	getNumberOfSlices() Retrieves Number of slices.
short	getNumberOfTimeSlots() Retrieves Number of time slots.
short[]	getPhaseVector() Retrieves An array which contains the phase number for each frame.
short[]	getRotationVector() Retrieves An array which contains the rotation number for each frame.
short[]	getRRIntervalVector() Retrieves R-R Interval Vector, array which contains the R-R interval number for each frame..
short[]	getSliceVector() Retrieves An array which contains the spatial slice number for each frame.
short[]	getTimeSliceVector() Retrieves An array which contains the time slice number for each frame.
short[]	getTimeSlotVector() Retrieves An array which contains the time slot number for each frame.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setAngularViewVector(short[] arrShAngularViewVector) Sets An array which contains the angular view number for each frame.
void	setDetectorVector(short[] arrShDetectorVector) Sets An array which contains the detector number for each frame.
void	setEnergyWindowVector(short[] arrShEnergyWindowVector) Sets An array which contains the energy window number for each frame.
void	setFrameIncrementPointer(ISingleCollection<ITag> objSingleCollection) Contains the Data Element Tags of one or more frame index vectors.
void	setNumberOfDetectors(short shNumberOfDetectors) Sets Number of detectors.
void	setNumberofEnergyWindows(short shNumberofEnergyWindows) Sets Number of energy window groupings.
void	setNumberOfPhases(short shNumberOfPhases) Sets Number of phases.
void	setNumberOfRotations(short shNumberOfRotations) Sets Number of rotations.
void	setNumberOfRRIntervals(short shNumberOfRRIntervals) Sets Number of R-R Intervals.
void	setNumberOfSlices(short shNumberOfTimeSlices) Sets Number of Slices.
void	setNumberOfTimeSlots(short shNumberOfTimeSlots) Sets Number of Time Slots.
void	setPhaseVector(short[] arrShPhaseVector) Sets An array which contains the phase number for each frame.
void	setRotationVector(short[] arrShRotationVector) Sets An array which contains the rotation number for each frame.
void	setRRIntervalVector(short[] arrShRRIntervalVector) Sets An array which contains the R-R interval number for each frame.
void	setSliceVector(short[] arrShSliceVector) Sets An array which contains the spatial slice number for each frame.
void	setTimeSliceVector(short[] arrShTimeSliceVector) Sets An array which contains the time slice number for each frame.
void	setTimeSlotVector(short[] arrShTimeSlotVector) Sets An array which contains the time slot number for each frame.
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

NMMultiFrameModule

public NMMultiFrameModule(IDataSet objIDataSet)

Instantiates a new nM multi frame 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

setFrameIncrementPointer

public void setFrameIncrementPointer(ISingleCollection<ITag> objSingleCollection)

Contains the Data Element Tags of one or more frame index vectors.

Parameters:

objSingleCollection - - ISingleCollection of tags.

setEnergyWindowVector

public void setEnergyWindowVector(short[] arrShEnergyWindowVector)

Sets An array which contains the energy window number for each frame.

Parameters:

arrShEnergyWindowVector - - Short array which contains the energy window number for each frame.

setNumberofEnergyWindows

public void setNumberofEnergyWindows(short shNumberofEnergyWindows)

Sets Number of energy window groupings.

Parameters:

shNumberofEnergyWindows - - Short value of Number of energy window groupings.

setDetectorVector

public void setDetectorVector(short[] arrShDetectorVector)

Sets An array which contains the detector number for each frame.

Parameters:

arrShDetectorVector - - Short array which contains the detector number for each frame.

setNumberOfDetectors

public void setNumberOfDetectors(short shNumberOfDetectors)

Sets Number of detectors.

Parameters:

shNumberOfDetectors - - Short value of Number of detectors.

setPhaseVector

public void setPhaseVector(short[] arrShPhaseVector)

Sets An array which contains the phase number for each frame.

Parameters:

arrShPhaseVector - - Short Array which contains the phase number for each frame.

setNumberOfPhases

public void setNumberOfPhases(short shNumberOfPhases)

Sets Number of phases.

Parameters:

shNumberOfPhases - - Short value of Number of phases.

setRotationVector

public void setRotationVector(short[] arrShRotationVector)

Sets An array which contains the rotation number for each frame.

Parameters:

arrShRotationVector - - Short array which contains the rotation number for each frame.

setNumberOfRotations

public void setNumberOfRotations(short shNumberOfRotations)

Sets Number of rotations.

Parameters:

shNumberOfRotations - - Short value of Number of rotations .

setRRIntervalVector

public void setRRIntervalVector(short[] arrShRRIntervalVector)

Sets An array which contains the R-R interval number for each frame.

Parameters:

arrShRRIntervalVector - - Short array of RRIntervalVector

setNumberOfRRIntervals

public void setNumberOfRRIntervals(short shNumberOfRRIntervals)

Sets Number of R-R Intervals.

Parameters:

shNumberOfRRIntervals - the sh number of rr intervals

setTimeSlotVector

public void setTimeSlotVector(short[] arrShTimeSlotVector)

Sets An array which contains the time slot number for each frame.

Parameters:

arrShTimeSlotVector - - Short array of Time Slot Vector.

setNumberOfTimeSlots

public void setNumberOfTimeSlots(short shNumberOfTimeSlots)

Sets Number of Time Slots.

Parameters:

shNumberOfTimeSlots - the sh number of time slots

setSliceVector

public void setSliceVector(short[] arrShSliceVector)

Sets An array which contains the spatial slice number for each frame.

Parameters:

arrShSliceVector - - Short array of Slice Vector.

setNumberOfSlices

public void setNumberOfSlices(short shNumberOfTimeSlices)

Sets Number of Slices.

Parameters:

shNumberOfTimeSlices - - Short value of Number Of Time Slices.

setAngularViewVector

public void setAngularViewVector(short[] arrShAngularViewVector)

Sets An array which contains the angular view number for each frame.

Parameters:

arrShAngularViewVector - - Short array of Angular View Vector.

setTimeSliceVector

public void setTimeSliceVector(short[] arrShTimeSliceVector)

Sets An array which contains the time slice number for each frame.

Parameters:

arrShTimeSliceVector - - Short array of Time Slice Vector.

getFrameIncrementPointer

public ISingleCollection<ITag> getFrameIncrementPointer()

Retrieves Data Element Tags of one or more frame index vectors.

Returns:

ISingleCollection - ISingleCollection of tags.

getEnergyWindowVector

public short[] getEnergyWindowVector()

Retrieves An array which contains the energy window number for each frame.

Returns:

Short[] - Short array of Energy Window Vector.

getNumberofEnergyWindows

public short getNumberofEnergyWindows()

Retrieves Number of energy window groupings.

Returns:

Short - Number of Energy Windows

getDetectorVector

public short[] getDetectorVector()

Retrieves An array which contains the detector number for each frame.

Returns:

Short[] - Short array of Detector Vector.

getNumberOfDetectors

public short getNumberOfDetectors()

Retrieves Number of detectors.

Returns:

Short - Short value of Number Of Detectors

getPhaseVector

public short[] getPhaseVector()

Retrieves An array which contains the phase number for each frame.

Returns:

short[] - Short array of Phase Vector.

getNumberOfPhases

public short getNumberOfPhases()

Retrieves Number of phases.

Returns:

short - Short array of Number of Phases.

getRotationVector

public short[] getRotationVector()

Retrieves An array which contains the rotation number for each frame.

Returns:

short[] - Short array of Rotation number for each frame.

getNumberOfRotations

public short getNumberOfRotations()

Retrieves Number of rotations.

Returns:

short - Short value of Number Of Rotation.

getRRIntervalVector

public short[] getRRIntervalVector()

Retrieves R-R Interval Vector, array which contains the R-R interval number for each frame..

Returns:

short[] - Short array which contains the R-R interval number for each frame.

getNumberOfRRIntervals

public short getNumberOfRRIntervals()

Retrieves Number of R-R intervals.

Returns:

short - Number of R-R intervals.

getTimeSlotVector

public short[] getTimeSlotVector()

Retrieves An array which contains the time slot number for each frame.

Returns:

short[] - Short array which contains the time slot number for each frame.

getNumberOfTimeSlots

public short getNumberOfTimeSlots()

Retrieves Number of time slots.

Returns:

short - Number of time slots.

getSliceVector

public short[] getSliceVector()

Retrieves An array which contains the spatial slice number for each frame.

Returns:

short[] - short array which contains the spatial slice number for each frame.

getNumberOfSlices

public short getNumberOfSlices()

Retrieves Number of slices.

Returns:

short - short value of Number of slices..

getAngularViewVector

public short[] getAngularViewVector()

Retrieves An array which contains the angular view number for each frame.

Returns:

short[] - Short array which contains the angular view number for each frame.

getTimeSliceVector

public short[] getTimeSliceVector()

Retrieves An array which contains the time slice number for each frame.

Returns:

short[] - Short array which contains the time slice number for each frame.

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