cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class CineModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CineModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class CineModule
extends Module

\* This module specifies the Attributes of a Multi-frame Cine Image.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CineModule(IDataSet objIDataSet) Instantiates a new cine module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getActualFrameDuration() Retrieves Elapsed time of data acquisition in msec per each frame.
java.lang.String	getCineRate() Retrieves Number of frames per second.
CodeSequenceMacro	getCodeSequenceMacro() Get the Instance of Code Sequence Macro.Attributes related to Code Sequence Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first.
java.lang.String	getEffectiveDuration() Retrieves Total time in seconds that data was actually taken for the entire Multi-frame image.
java.lang.String	getFrameDelay() Retrieves Time (in msec) from Content Time (0008,0033) to the start of the first frame in a Multi-frame image.
java.lang.String	getFrameTime() Retrieves Nominal time (in msec) per individual frame.
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	getImageTriggerDelay() Retrieves Delay time in milliseconds from trigger (e.g., X-ray on pulse) to the first frame of a Multi-frame image.
MultiplexedAudioChannelsDescriptionCodeSequence	getMultiplexedAudioChannelsDescriptionCodeSequence() Provides the pre-initialized instance of Multiplexed Audio Channels Description Code 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
short	getPreferredPlaybackSequencing() Retrieves the preferred playback sequencing for a multi-frame image.
java.lang.String	getRecommendedDisplayFrameRate() Retrieves recommended rate at which the frames of a Multi-frame image should be displayed in frames/second.
java.lang.String	getStartTrim() Retrieves the frame number of the first frame of the Multi-frame image to be displayed.
java.lang.String	getStopTrim() Retrieves the Frame Number of the last frame of a Multi-frame image to be displayed.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
void	setActualFrameDuration(java.lang.String strActualFrameDuration) Sets elapsed time of data acquisition in msec per each frame.
void	setCineRate(java.lang.String strCineRate) Sets number of frames per second.
void	setEffectiveDuration(java.lang.String strEffectiveDuration) Sets total time in seconds that data was actually taken for the entire Multi-frame image.
void	setFrameDelay(java.lang.String strFrameDelay) Sets time (in msec) from Content Time (0008,0033) to the start of the first frame in a Multi-frame image.
void	setFrameTime(java.lang.String strFrameTime) Sets Nominal time (in msec) per individual frame.Required if Frame Increment Pointer (0028,0009) points to Frame Time.
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	setImageTriggerDelay(java.lang.String strImageTriggerDelay) Sets delay time in milliseconds from trigger (e.g., X-ray on pulse) to the first frame of a Multi-frame image.
void	setPreferredPlaybackSequencing(short sPreferredPlaybackSequencing) Sets the preferred playback sequencing for a multi-frame image.
void	setRecommendedDisplayFrameRate(java.lang.String strRecommendedDisplayFrameRate) Sets recommended rate at which the frames of a Multi-frame image should be displayed in frames/second.
void	setStartTrim(java.lang.String strStartTrim) Sets the frame number of the first frame of the Multi-frame image to be displayed.
void	setStopTrim(java.lang.String strStopTrim) Sets the Frame Number of the last frame of a Multi-frame image to be displayed.
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

CineModule

public CineModule(IDataSet objIDataSet)

Instantiates a new cine 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:

true, if validate module

Throws:

InvalidModuleException - - If validation of Module fails

setPreferredPlaybackSequencing

public void setPreferredPlaybackSequencing(short sPreferredPlaybackSequencing)

Sets the preferred playback sequencing for a multi-frame image. Enumerated Values: 0 = Looping (1,2...n,1,2,...n,1,2,....n,...) 1 = Sweeping (1,2,...n,n-1,...2,1,2,...n,...).

Parameters:

sPreferredPlaybackSequencing - short value of Preferred Playback Sequencing.

setFrameTime

public void setFrameTime(java.lang.String strFrameTime)

Sets Nominal time (in msec) per individual frame.Required if Frame Increment Pointer (0028,0009) points to Frame Time.

Parameters:

strFrameTime - String value of Frame Time.

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.

setStartTrim

public void setStartTrim(java.lang.String strStartTrim)

Sets the frame number of the first frame of the Multi-frame image to be displayed.

Parameters:

strStartTrim - String value of Start Trim.

setStopTrim

public void setStopTrim(java.lang.String strStopTrim)

Sets the Frame Number of the last frame of a Multi-frame image to be displayed.

Parameters:

strStopTrim - String value of Stop Trim.

setRecommendedDisplayFrameRate

public void setRecommendedDisplayFrameRate(java.lang.String strRecommendedDisplayFrameRate)

Sets recommended rate at which the frames of a Multi-frame image should be displayed in frames/second.

Parameters:

strRecommendedDisplayFrameRate - String value of Recommended Display Frame Rate.

setCineRate

public void setCineRate(java.lang.String strCineRate)

Sets number of frames per second.

Parameters:

strCineRate - String value of Cine Rate.

setFrameDelay

public void setFrameDelay(java.lang.String strFrameDelay)

Sets time (in msec) from Content Time (0008,0033) to the start of the first frame in a Multi-frame image.

Parameters:

strFrameDelay - String value of Frame Delay.

setImageTriggerDelay

public void setImageTriggerDelay(java.lang.String strImageTriggerDelay)

Sets delay time in milliseconds from trigger (e.g., X-ray on pulse) to the first frame of a Multi-frame image.

Parameters:

strImageTriggerDelay - String value of Image Trigger Delay.

setEffectiveDuration

public void setEffectiveDuration(java.lang.String strEffectiveDuration)

Sets total time in seconds that data was actually taken for the entire Multi-frame image.

Parameters:

strEffectiveDuration - String value of Effective Duration.

setActualFrameDuration

public void setActualFrameDuration(java.lang.String strActualFrameDuration)

Sets elapsed time of data acquisition in msec per each frame.

Parameters:

strActualFrameDuration - String value of Actual Frame Duration.

getPreferredPlaybackSequencing

public short getPreferredPlaybackSequencing()

Retrieves the preferred playback sequencing for a multi-frame image. Enumerated Values: 0 = Looping (1,2...n,1,2,...n,1,2,....n,...) 1 = Sweeping (1,2,...n,n-1,...2,1,2,...n,...)

Returns:

short - short value of Preferred Playback Sequencing.

getFrameTime

public java.lang.String getFrameTime()

Retrieves Nominal time (in msec) per individual frame.

Returns:

String - String value of Frame Time.

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.

getStartTrim

public java.lang.String getStartTrim()

Retrieves the frame number of the first frame of the Multi-frame image to be displayed.

Returns:

String - String value of Start Trim.

getStopTrim

public java.lang.String getStopTrim()

Retrieves the Frame Number of the last frame of a Multi-frame image to be displayed.

Returns:

String - String value of Stop Trim.

getRecommendedDisplayFrameRate

public java.lang.String getRecommendedDisplayFrameRate()

Retrieves recommended rate at which the frames of a Multi-frame image should be displayed in frames/second.

Returns:

String - String value of Recommended Display Frame Rate.

getCineRate

public java.lang.String getCineRate()

Retrieves Number of frames per second.

Returns:

String - String value of Cine Rate.

getFrameDelay

public java.lang.String getFrameDelay()

Retrieves Time (in msec) from Content Time (0008,0033) to the start of the first frame in a Multi-frame image.

Returns:

String - String value of Frame Delay.

getImageTriggerDelay

public java.lang.String getImageTriggerDelay()

Retrieves Delay time in milliseconds from trigger (e.g., X-ray on pulse) to the first frame of a Multi-frame image.

Returns:

String - String value of Image Trigger Delay.

getEffectiveDuration

public java.lang.String getEffectiveDuration()

Retrieves Total time in seconds that data was actually taken for the entire Multi-frame image.

Returns:

String - String value of Effective Duration.

getActualFrameDuration

public java.lang.String getActualFrameDuration()

Retrieves Elapsed time of data acquisition in msec per each frame.

Returns:

String - String value of Actual Frame Duration.

getMultiplexedAudioChannelsDescriptionCodeSequence

public MultiplexedAudioChannelsDescriptionCodeSequence getMultiplexedAudioChannelsDescriptionCodeSequence()

Provides the pre-initialized instance of Multiplexed Audio Channels Description Code 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:

- instance of Multiplexed Audio Channels Description Code Sequence.

getCodeSequenceMacro

public CodeSequenceMacro getCodeSequenceMacro()

Get the Instance of Code Sequence Macro.Attributes related to Code Sequence Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was set in the last call to its setter method.

Returns:

- object of code sequence macro which the user programmer can populate

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