cdac.medinfo.sdk.dcm30_04.baselibs

Class StructuredDisplayImageBoxSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.StructuredDisplayImageBoxSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class StructuredDisplayImageBoxSequenceItem
extends Item

This item class contains methods to validate, set and get the attributes of Structured Display Image Box Sequence .

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
double	getCineRelativeToRealTime() Retrieves the positive dimensionless floating point numeric factor equal to playbackrate divided by acquisition rate.
void	getCineRelativeToRealTime(double dblCineRelativeToRealTime) Sets the positive dimensionless floating point numeric factor equal to playbackrate divided by acquisition rate.
double[]	getDisplayEnvironmentSpatialPosition() Retrieves the Display Environment SpatialPosition
java.lang.String	getDisplaySetHorizontalJustification() Return Display Set Horizontal Justification
java.lang.String	getDisplaySetVerticalJustification() Return Display Set Vertical Justification
java.lang.String	getImageBoxLayoutType() Return type of layout of the Image Box.
short	getImageBoxNumber() Retrieves Image Box Number
short	getImageBoxOverlapPriority() Retrieves Image Box Overlap Priority
short	getImageBoxTileHorizontalDimension() Retrieves Image Box Tile HorizontalDimension
short	getImageBoxTileVerticalDimension() Retrieves Image Box Tile Vertical Dimension
java.lang.String	getInitialCineRunState() Return Initial Cine Run State
java.lang.String	getPreferredPlaybackSequencing() Return Preferred Playback Sequencing
ReferencedFirstFrameSequence	getPrimaryFluenceModeSequence() Retrieves pre-initialized object of Referenced First FrameSequence.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.
java.lang.String	getRecommendedDisplayFrameRate() Retrieves recommended rate at which the frames of a multi-frame image shall bedisplayed, in frames/second.
ReferencedImageSequence	getReferencedImageSequence() Retrieves pre-initialized object of Referenced Image 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.
ReferencedInstanceSequence	getReferencedInstanceSequence() Retrieves pre-initialized object of Referenced Instance 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.
ReferencedPresentationStateSequence	getReferencedPresentationStateSequence() Retrieves pre-initialized object of Referenced Presentation StateSequence.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.
ReferencedStereometricInstanceSequence	getReferencedStereometricInstanceSequence() Retrieves pre-initialized object of Referenced Stereometric InstanceSequence.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.
java.lang.String	getStartTrim() Retrieves frame number of the first frame of the multi-frame image to bedisplayed in a CINE Image Box.
java.lang.String	getStopTrim() Retrieves Frame Number of the last frame of the multi-frame image to bedisplayed in a CINE Image Box.
void	setDisplayEnvironmentSpatialPosition(double[] dblArrDisplayEnvironmentSpatialPosition) Sets the Display Environment SpatialPosition
void	setDisplaySetHorizontalJustification(EnumDisplaySetHorizontalJustification enumDisplaySetHorizontalJustification) Sets direction in which to horizontally justify the image within anImage Box that is not the same shape (aspect ratio) as the image.
void	setDisplaySetVerticalJustification(EnumDisplaySetVerticalJustification enumDisplaySetVerticalJustification) Sets direction in which to vertically justify the image within anImage Box that is not the same shape (aspect ratio) as the image.
void	setImageBoxLayoutType(EnumImageBoxLayoutType enumImageBoxLayoutType) Sets type of layout of the Image Box.
void	setImageBoxNumber(short shImageBoxNumber) Sets Image Box Number
void	setImageBoxOverlapPriority(short shImageBoxOverlapPriority) Sets Image Box Overlap Priority
void	setImageBoxTileHorizontalDimension(short shImageBoxTileHorizontalDimension) Sets Image Box Tile HorizontalDimension
void	setImageBoxTileVerticalDimension(short shImageBoxTileVerticalDimension) Sets Image Box Tile Vertical Dimension
void	setInitialCineRunState(EnumInitialCineRunState enumInitialCineRunState) Sets Initial Cine Run State
void	setPreferredPlaybackSequencing(EnumPreferredPlaybackSequencing enumPreferredPlaybackSequencing) Sets the preferred playback sequencing for the Image Box.
void	setRecommendedDisplayFrameRate(java.lang.String strRecommendedDisplayFrameRate) Sets recommended rate at which the frames of a multi-frame image shall bedisplayed, in frames/second.
void	setStartTrim(java.lang.String strStartTrim) Sets frame number of the first frame of the multi-frame image to bedisplayed in a CINE Image Box.
void	setStopTrim(java.lang.String strStopTrim) Sets Frame Number of the last frame of the multi-frame image to bedisplayed in a CINE Image Box.
boolean	validateForModule() Validates all the attributes in StructuredDisplayImageBoxSequenceItem that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in StructuredDisplayImageBoxSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

MandatoryMissingException - throws MandatoryMissingException If Conditional element fails.

InvalidItemException - Signals Item Validation is failed.

setDisplayEnvironmentSpatialPosition

public void setDisplayEnvironmentSpatialPosition(double[] dblArrDisplayEnvironmentSpatialPosition)

Sets the Display Environment SpatialPosition

Parameters:

dblArrDisplayEnvironmentSpatialPosition - Double value of Display Environment SpatialPosition

getDisplayEnvironmentSpatialPosition

public double[] getDisplayEnvironmentSpatialPosition()

Retrieves the Display Environment SpatialPosition

Returns:

double - double value of DisplayEnvironmentSpatialPosition

setImageBoxNumber

public void setImageBoxNumber(short shImageBoxNumber)

Sets Image Box Number

Parameters:

shImageBoxNumber - short value of Image Box Number

getImageBoxNumber

public short getImageBoxNumber()

Retrieves Image Box Number

Returns:

short - short value of Image Box Number

setImageBoxLayoutType

public void setImageBoxLayoutType(EnumImageBoxLayoutType enumImageBoxLayoutType)

Sets type of layout of the Image Box.

Parameters:

enumImageBoxLayoutType - enum value of ImageBoxLayoutType

getImageBoxLayoutType

public java.lang.String getImageBoxLayoutType()

Return type of layout of the Image Box.

Returns:

String - value of ImageBoxLayoutType.

setImageBoxTileHorizontalDimension

public void setImageBoxTileHorizontalDimension(short shImageBoxTileHorizontalDimension)

Sets Image Box Tile HorizontalDimension

Parameters:

shImageBoxTileHorizontalDimension - short value of Image Box Tile HorizontalDimension

getImageBoxTileHorizontalDimension

public short getImageBoxTileHorizontalDimension()

Retrieves Image Box Tile HorizontalDimension

Returns:

short - short value of Image Box Tile HorizontalDimension

setImageBoxTileVerticalDimension

public void setImageBoxTileVerticalDimension(short shImageBoxTileVerticalDimension)

Sets Image Box Tile Vertical Dimension

Parameters:

shImageBoxTileVerticalDimension - short value of Image Box Tile Vertical Dimension

getImageBoxTileVerticalDimension

public short getImageBoxTileVerticalDimension()

Retrieves Image Box Tile Vertical Dimension

Returns:

short - short value of Image Box Tile Vertical Dimension

setImageBoxOverlapPriority

public void setImageBoxOverlapPriority(short shImageBoxOverlapPriority)

Sets Image Box Overlap Priority

Parameters:

shImageBoxOverlapPriority - short value of Image Box Overlap Priority

getImageBoxOverlapPriority

public short getImageBoxOverlapPriority()

Retrieves Image Box Overlap Priority

Returns:

short - short value of Image Box Overlap Priority

setDisplaySetHorizontalJustification

public void setDisplaySetHorizontalJustification(EnumDisplaySetHorizontalJustification enumDisplaySetHorizontalJustification)

Sets direction in which to horizontally justify the image within anImage Box that is not the same shape (aspect ratio) as the image.

Parameters:

enumDisplaySetHorizontalJustification - enum value of Display Set Horizontal Justification

getDisplaySetHorizontalJustification

public java.lang.String getDisplaySetHorizontalJustification()

Return Display Set Horizontal Justification

Returns:

String - value of Display Set Horizontal Justification

setDisplaySetVerticalJustification

public void setDisplaySetVerticalJustification(EnumDisplaySetVerticalJustification enumDisplaySetVerticalJustification)

Sets direction in which to vertically justify the image within anImage Box that is not the same shape (aspect ratio) as the image.

Parameters:

enumDisplaySetVerticalJustification - enum value of Display Set Vertical Justification

getDisplaySetVerticalJustification

public java.lang.String getDisplaySetVerticalJustification()

Return Display Set Vertical Justification

Returns:

String - value of Display Set Vertical Justification

setPreferredPlaybackSequencing

public void setPreferredPlaybackSequencing(EnumPreferredPlaybackSequencing enumPreferredPlaybackSequencing)

Sets the preferred playback sequencing for the Image Box. Overridesany Preferred Playback Sequencing (0018,1244) value in the imageobjects being displayed.

Parameters:

enumPreferredPlaybackSequencing - value of Preferred Playback Sequencing

getPreferredPlaybackSequencing

public java.lang.String getPreferredPlaybackSequencing()

Return Preferred Playback Sequencing

Returns:

String - value of Preferred Playback Sequencing

setRecommendedDisplayFrameRate

public void setRecommendedDisplayFrameRate(java.lang.String strRecommendedDisplayFrameRate)

Sets recommended rate at which the frames of a multi-frame image shall bedisplayed, in frames/second.

Parameters:

strRecommendedDisplayFrameRate - String value of Recommended Display FrameRate

getRecommendedDisplayFrameRate

public java.lang.String getRecommendedDisplayFrameRate()

Retrieves recommended rate at which the frames of a multi-frame image shall bedisplayed, in frames/second.

Returns:

String - value of Recommended Display FrameRate

getCineRelativeToRealTime

public void getCineRelativeToRealTime(double dblCineRelativeToRealTime)

Sets the positive dimensionless floating point numeric factor equal to playbackrate divided by acquisition rate.

Parameters:

dblCineRelativeToRealTime - Double value of Cine Relative toReal-Time

getCineRelativeToRealTime

public double getCineRelativeToRealTime()

Retrieves the positive dimensionless floating point numeric factor equal to playbackrate divided by acquisition rate.

Returns:

double - double value of Cine Relative toReal-Time

setInitialCineRunState

public void setInitialCineRunState(EnumInitialCineRunState enumInitialCineRunState)

Sets Initial Cine Run State

Parameters:

enumInitialCineRunState - enum value of Initial Cine Run State

getInitialCineRunState

public java.lang.String getInitialCineRunState()

Return Initial Cine Run State

Returns:

String - value of Initial Cine Run State

setStartTrim

public void setStartTrim(java.lang.String strStartTrim)

Sets frame number of the first frame of the multi-frame image to bedisplayed in a CINE Image Box.

Parameters:

strStartTrim - String value of Start Trim

getStartTrim

public java.lang.String getStartTrim()

Retrieves frame number of the first frame of the multi-frame image to bedisplayed in a CINE Image Box.

Returns:

String - value of Start Trim

setStopTrim

public void setStopTrim(java.lang.String strStopTrim)

Sets Frame Number of the last frame of the multi-frame image to bedisplayed in a CINE Image Box.

Parameters:

strStopTrim - String value of Stop Trim

getStopTrim

public java.lang.String getStopTrim()

Retrieves Frame Number of the last frame of the multi-frame image to bedisplayed in a CINE Image Box.

Returns:

String - value of Stop Trim

getPrimaryFluenceModeSequence

public ReferencedFirstFrameSequence getPrimaryFluenceModeSequence()

Retrieves pre-initialized object of Referenced First FrameSequence.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:

ReferencedFirstFrameSequence - instance of Referenced First FrameSequence.

getReferencedImageSequence

public ReferencedImageSequence getReferencedImageSequence()

Retrieves pre-initialized object of Referenced Image 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:

ReferencedImageSequence - instance of Referenced Image Sequence

getReferencedPresentationStateSequence

public ReferencedPresentationStateSequence getReferencedPresentationStateSequence()

Retrieves pre-initialized object of Referenced Presentation StateSequence.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:

ReferencedPresentationStateSequence - instance of Referenced Presentation StateSequence

getReferencedInstanceSequence

public ReferencedInstanceSequence getReferencedInstanceSequence()

Retrieves pre-initialized object of Referenced Instance 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:

ReferencedInstanceSequence - instance of Referenced Instance Sequence

getReferencedStereometricInstanceSequence

public ReferencedStereometricInstanceSequence getReferencedStereometricInstanceSequence()

Retrieves pre-initialized object of Referenced Stereometric InstanceSequence.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:

ReferencedStereometricInstanceSequence - instance of Referenced Stereometric InstanceSequence