cdac.medinfo.sdk.dcm30_04.baselibs

Class ImageBoxesSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.ImageBoxesSequenceItem

All Implemented Interfaces:

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

public class ImageBoxesSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Image Boxes Sequence .

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
double	getCineRelativetoRealTime() Retrieves the Minimal value of Chemical Shift Frequency in ppm.
double	getDisplayEnvironmentSpatialPosition() Retrieves the Minimal value of Display Environment Spatial Position.
short[]	getImageBoxLargeScrollAmount() Retrieves Image Box Large Scroll Amount.
java.lang.String	getImageBoxLargeScrollType() Retrieves type of the value encoded in this Item
java.lang.String	getImageBoxLayoutType() Retrieves type of the value encoded in this Item
short[]	getImageBoxNumber() Retrieves order of image boxes for scrolling.
short[]	getImageBoxOverlapPriority() Retrieves Image Box Overlap Priority.
java.lang.String	getImageBoxScrollDirection() Retrieves type of the value encoded in this Item
short[]	getImageBoxSmallScrollAmount() Retrieves one or more frames in a Multi-frame SOP Instance.
java.lang.String	getImageBoxSmallScrollType() Retrieves type of the value encoded in this Item
short[]	getImageBoxTileHorizontalDimension() Retrieves Image Box Tile Horizontal Dimension in a Multi-frame SOP Instance.
short[]	getImageBoxTileVerticalDimension() Retrieves Image Box Tile Horizontal Dimension in a Multi-frame SOP Instance.
short	getPreferredPlaybackSequencing() Retrieves Preferred Play back Sequencing.
java.lang.String	getRecommendedDisplayFrameRate() Retrieves Recommended Display Frame Rate.
void	setCineRelativetoRealTime(double dblCineRelativetoRealTime) Sets the Cine Relative to Real Time.
void	setDisplayEnvironmentSpatialPosition(double dblDisplayEnvironmentSpatialPosition) Sets the Minimal value of Chemical Shift Frequency in ppm.
void	setImageBoxLargeScrollAmount(short[] arrImageBoxLargeScrollAmount) Sets the Value Type Defined in Image Box Large Scroll Amount Defines the positive integer number of pages, rows, columns, or images per large increment scroll, It is based on the values of Image Box Large Scroll Type(0072,0316) and Image Box Scroll Direction (0072,0310).
void	setImageBoxLargeScrollType(EnumImageBoxLargeScrollType enumImageBoxLargeScrollType) Sets the Value Type Defined in EnumImageBoxLargeScrollType PAGE - In a TILED image box, replace all image slots with the next N x M images in the set, ROW_COLUMN - In a TILED image box, move each row or column of images to the next row or column, depending on Image Box Scroll Direction IMAGE - In a TILED image box, move each image to the next slot, either horizontally or vertically, depending on Image Box ScrollDirection (0072,0310).
void	setImageBoxLayoutType(EnumImageBoxLayoutType enumImageBoxLayoutType) Sets the Image Box Layout Type Defined Type of layout of the image box
void	setImageBoxNumber(short[] arrImageBoxNumber)
void	setImageBoxOverlapPriority(short[] arrImageBoxOverlapPriority) Sets the Value Type Defined in Image Box Overlap Priority If this Image Box overlaps in spatial position with others, this attribute indicates the layer of this Image Box in relation to the others.
void	setImageBoxScrollDirection(EnumImageBoxScrollDirection enumImageBoxScrollDirection) Sets the Value Type Defined in EnumImageBoxScrollDirection as VERTICAL - scroll images by row, HORIZONTAL - scroll images by column
void	setImageBoxSmallScrollAmount(short[] arrImageBoxSmallScrollAmount) Sets the Image Box Small Scroll Amount
void	setImageBoxSmallScrollType(EnumImageBoxSmallScrollType enumImageBoxSmallScrollType) Sets the Value Type Defined in EnumImageBoxSmallScrollType PAGE - In a TILED image box, replace all image slots with the next N x M images in the set, ROW_COLUMN - In a TILED image box, move each row or column of images to the next row or column, depending on Image Box Scroll Direction IMAGE - In a TILED image box, move each image to the next slot, either horizontally or vertically, depending on Image Box ScrollDirection (0072,0310).
void	setImageBoxTileHorizontalDimension(short[] arrImageBoxTileHorizontalDimension) Sets the Image Box Tile Horizontal Dimension
void	setImageBoxTileVerticalDimension(short[] arrImageBoxTileVerticalDimension) Sets the Image Box Tile Horizontal Dimension
void	setPreferredPlaybackSequencing(short shPreferredPlaybackSequencing) Sets the Value Type Defined in Preferred Play back Sequencing Describes the preferred play back sequencing for the Image Box.
void	setRecommendedDisplayFrameRate(java.lang.String strRecommendedDisplayFrameRate) Sets Recommended Display Frame Rate.
boolean	validateForModule() Validates all the attributes in FillStyleSequenceItem 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 FillStyleSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Conditional element fails.

setImageBoxNumber

public void setImageBoxNumber(short[] arrImageBoxNumber)

getImageBoxNumber

public short[] getImageBoxNumber()

Retrieves order of image boxes for scrolling.

Returns:

short Array - frames in a Multi-frame SOP Instance.

setDisplayEnvironmentSpatialPosition

public void setDisplayEnvironmentSpatialPosition(double dblDisplayEnvironmentSpatialPosition)

Sets the Minimal value of Chemical Shift Frequency in ppm.

Parameters:

dblChemicalShiftsMinimumIntegrationLimitOnppm - Double value of coordinates

getDisplayEnvironmentSpatialPosition

public double getDisplayEnvironmentSpatialPosition()

Retrieves the Minimal value of Display Environment Spatial Position.

Returns:

double - double value of DisplayEnvironmentSpatialPosition

setImageBoxLayoutType

public void setImageBoxLayoutType(EnumImageBoxLayoutType enumImageBoxLayoutType)

Sets the Image Box Layout Type Defined Type of layout of the image box

Parameters:

strImageBoxLayoutType - Specifies type of the value encoded in this Item

getImageBoxLayoutType

public java.lang.String getImageBoxLayoutType()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setImageBoxTileHorizontalDimension

public void setImageBoxTileHorizontalDimension(short[] arrImageBoxTileHorizontalDimension)

Sets the Image Box Tile Horizontal Dimension

Parameters:

arrImageBoxTileHorizontalDimension - which is Positive integer defining the horizontal Image Box tile dimension

getImageBoxTileHorizontalDimension

public short[] getImageBoxTileHorizontalDimension()

Retrieves Image Box Tile Horizontal Dimension in a Multi-frame SOP Instance.

Returns:

short Array - Image Box Tile Horizontal Dimension in a Multi-frame SOP Instance.

setImageBoxTileVerticalDimension

public void setImageBoxTileVerticalDimension(short[] arrImageBoxTileVerticalDimension)

Sets the Image Box Tile Horizontal Dimension

Parameters:

arrImageBoxTileHorizontalDimension - which is Positive integer defining the horizontal Image Box tile dimension

getImageBoxTileVerticalDimension

public short[] getImageBoxTileVerticalDimension()

Retrieves Image Box Tile Horizontal Dimension in a Multi-frame SOP Instance.

Returns:

short Array - Image Box Tile Horizontal Dimension in a Multi-frame SOP Instance.

setImageBoxScrollDirection

public void setImageBoxScrollDirection(EnumImageBoxScrollDirection enumImageBoxScrollDirection)

Sets the Value Type Defined in EnumImageBoxScrollDirection as VERTICAL - scroll images by row, HORIZONTAL - scroll images by column

Parameters:

enumImageBoxScrollDirection - Specifies type of the value encoded in this Item

getImageBoxScrollDirection

public java.lang.String getImageBoxScrollDirection()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setImageBoxSmallScrollType

public void setImageBoxSmallScrollType(EnumImageBoxSmallScrollType enumImageBoxSmallScrollType)

Sets the Value Type Defined in EnumImageBoxSmallScrollType PAGE - In a TILED image box, replace all image slots with the next N x M images in the set, ROW_COLUMN - In a TILED image box, move each row or column of images to the next row or column, depending on Image Box Scroll Direction IMAGE - In a TILED image box, move each image to the next slot, either horizontally or vertically, depending on Image Box ScrollDirection (0072,0310).

Parameters:

enumImageBoxSmallScrollType - Specifies type of the value encoded in this Item

getImageBoxSmallScrollType

public java.lang.String getImageBoxSmallScrollType()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setImageBoxSmallScrollAmount

public void setImageBoxSmallScrollAmount(short[] arrImageBoxSmallScrollAmount)

Sets the Image Box Small Scroll Amount

Parameters:

arrImageBoxTileHorizontalDimension - which is Positive integer defining the horizontal Image Box tile dimension

getImageBoxSmallScrollAmount

public short[] getImageBoxSmallScrollAmount()

Retrieves one or more frames in a Multi-frame SOP Instance.

Returns:

short Array - frames in a Multi-frame SOP Instance.

setImageBoxLargeScrollType

public void setImageBoxLargeScrollType(EnumImageBoxLargeScrollType enumImageBoxLargeScrollType)

Sets the Value Type Defined in EnumImageBoxLargeScrollType PAGE - In a TILED image box, replace all image slots with the next N x M images in the set, ROW_COLUMN - In a TILED image box, move each row or column of images to the next row or column, depending on Image Box Scroll Direction IMAGE - In a TILED image box, move each image to the next slot, either horizontally or vertically, depending on Image Box ScrollDirection (0072,0310).

Parameters:

enumImageBoxSmallScrollType - Specifies type of the value encoded in this Item

getImageBoxLargeScrollType

public java.lang.String getImageBoxLargeScrollType()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setImageBoxLargeScrollAmount

public void setImageBoxLargeScrollAmount(short[] arrImageBoxLargeScrollAmount)

Sets the Value Type Defined in Image Box Large Scroll Amount Defines the positive integer number of pages, rows, columns, or images per large increment scroll, It is based on the values of Image Box Large Scroll Type(0072,0316) and Image Box Scroll Direction (0072,0310).

Parameters:

arrImageBoxLargeScrollAmount - Specifies type of the value encoded in this Item

getImageBoxLargeScrollAmount

public short[] getImageBoxLargeScrollAmount()

Retrieves Image Box Large Scroll Amount.

Returns:

short Array - frames in SOP Instance.

setImageBoxOverlapPriority

public void setImageBoxOverlapPriority(short[] arrImageBoxOverlapPriority)

Sets the Value Type Defined in Image Box Overlap Priority If this Image Box overlaps in spatial position with others, this attribute indicates the layer of this Image Box in relation to the others.

Parameters:

arrImageBoxOverlapPriority - Specifies type of the value encoded in this Item

getImageBoxOverlapPriority

public short[] getImageBoxOverlapPriority()

Retrieves Image Box Overlap Priority.

Returns:

short Array - frames in SOP Instance.

setPreferredPlaybackSequencing

public void setPreferredPlaybackSequencing(short shPreferredPlaybackSequencing)

Sets the Value Type Defined in Preferred Play back Sequencing Describes the preferred play back sequencing for the Image Box. Overrides any,any Preferred Play back Sequencing (0018,1244) value in the image objects being displayed.

Parameters:

arrPreferredPlaybackSequencing - Specifies type of the value encoded in this Item

getPreferredPlaybackSequencing

public short getPreferredPlaybackSequencing()

Retrieves Preferred Play back Sequencing.

Returns:

short Array - frames in SOP Instance.

setRecommendedDisplayFrameRate

public void setRecommendedDisplayFrameRate(java.lang.String strRecommendedDisplayFrameRate)

Sets Recommended Display Frame Rate. Recommended rate at which the frames of a multi-frame image shall bedisplayed, in frames/second.

Parameters:

strReferencedReferenceImageNumber - String value of Referenced Reference Image Number.

getRecommendedDisplayFrameRate

public java.lang.String getRecommendedDisplayFrameRate()

Retrieves Recommended Display Frame Rate. Overrides any Recommended Display Frame Rate (0008,2144) value in the image objects being displayed.

Returns:

String - value of Referenced Reference Image Number.

setCineRelativetoRealTime

public void setCineRelativetoRealTime(double dblCineRelativetoRealTime)

Sets the Cine Relative to Real Time.

Parameters:

dblCineRelativetoRealTime - Double value of coordinates

getCineRelativetoRealTime

public double getCineRelativetoRealTime()

Retrieves the Minimal value of Chemical Shift Frequency in ppm.

Returns:

double - double value of ChemicalShiftsMinimumIntegrationLimitOnppm