cdac.medinfo.sdk.dcm30_04.baselibs

Class DisplayedAreaSelectionSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.DisplayedAreaSelectionSequenceItem

All Implemented Interfaces:

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

public class DisplayedAreaSelectionSequenceItem
extends Item

A sequence of Items each of which describes the displayed area selection for a group of images or frames.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long[]	getDisplayedAreaBottomRightHandCorner() Retrieves the bottom right pixel in the referenced image to be displayed, given as column\row.
java.lang.Long[]	getDisplayedAreaTopLeftHandCorner() Retrieves the top left pixel in the referenced image to be displayed, given as column\row.
java.lang.String	getPixelOriginInterpretation() Return Pixel Origin Interpretation.
java.lang.String[]	getPresentationPixelAspectRatio() Retrieves the Ratio of the vertical size and the horizontal size of the pixels in the referenced image
float	getPresentationPixelMagnificationRatio() Retrieves the Ratio of displayed pixels to source pixels,specified in one dimension.
java.lang.String[]	getPresentationPixelSpacing() Retrieves Physical distance between the center of each pixel in the referenced image
java.lang.String	getPresentationSizeMode() Retrieves the Manner of selection of display size
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.
void	setDisplayedAreaBottomRightHandCorner(java.lang.Long[] lDisplayedAreaBottomRightHandCorner) Sets the bottom right pixel in the referenced image to be displayed, given as column\row.
void	setDisplayedAreaTopLeftHandCorner(java.lang.Long[] lDisplayedAreaTopLeftHandCorner) Sets the top left pixel in the referenced image to be displayed, given as column\row.
void	setPixelOriginInterpretation(EnumPixelOriginInterpretation enumPixelOriginInterpretation) Sets Pixel Origin Interpretation.
void	setPresentationPixelAspectRatio(java.lang.String[] arrstrPresentationPixelAspectRatio) Sets the Ratio of the vertical size and the horizontal size of the pixels in the referenced image
void	setPresentationPixelMagnificationRatio(float fPresentationPixelMagnificationRatio) Sets the Ratio of displayed pixels to source pixels,specified in one dimension.
void	setPresentationPixelSpacing(java.lang.String[] arrstrPresentationPixelSpacing) Sets the Physical distance between the center of each pixel in the referenced image
void	setPresentationSizeMode(EnumPresentationSizeMode enumPresentationSizeMode) Sets the Manner of selection of display size
boolean	validateForModule() Validates all the attributes in DisplayedAreaSelectionSequenceItem 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 DisplayedAreaSelectionSequenceItem 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 Mandatory or Conditional element fails.

setPixelOriginInterpretation

public void setPixelOriginInterpretation(EnumPixelOriginInterpretation enumPixelOriginInterpretation)

Sets Pixel Origin Interpretation. Defined Terms: 1) FRAME. 2) VOLUME.

Parameters:

enumPixelOriginInterpretation - enum value of Pixel Origin Interpretation.

getPixelOriginInterpretation

public java.lang.String getPixelOriginInterpretation()

Return Pixel Origin Interpretation.

Returns:

String - value of Pixel Origin Interpretation.

setDisplayedAreaTopLeftHandCorner

public void setDisplayedAreaTopLeftHandCorner(java.lang.Long[] lDisplayedAreaTopLeftHandCorner)

Sets the top left pixel in the referenced image to be displayed, given as column\row.

Parameters:

lDisplayedAreaTopLeftHandCorner - Long array of top left pixel in the referenced image to be displayed.

getDisplayedAreaTopLeftHandCorner

public java.lang.Long[] getDisplayedAreaTopLeftHandCorner()

Retrieves the top left pixel in the referenced image to be displayed, given as column\row.

Returns:

Long[] - Long array of top left pixel in the referenced image to be displayed.

setDisplayedAreaBottomRightHandCorner

public void setDisplayedAreaBottomRightHandCorner(java.lang.Long[] lDisplayedAreaBottomRightHandCorner)

Sets the bottom right pixel in the referenced image to be displayed, given as column\row.

Parameters:

lDisplayedAreaBottomRightHandCorner - Long array of bottom right pixel in the referenced image to be displayed.

getDisplayedAreaBottomRightHandCorner

public java.lang.Long[] getDisplayedAreaBottomRightHandCorner()

Retrieves the bottom right pixel in the referenced image to be displayed, given as column\row.

Returns:

Long[] - Long array of bottom right pixel in the referenced image to be displayed.

setPresentationSizeMode

public void setPresentationSizeMode(EnumPresentationSizeMode enumPresentationSizeMode)

Sets the Manner of selection of display size

Parameters:

enumPresentationSizeMode - Enum value of the Manner of selection of display size

getPresentationSizeMode

public java.lang.String getPresentationSizeMode()

Retrieves the Manner of selection of display size

Returns:

String - value of the Manner of selection of display size

setPresentationPixelSpacing

public void setPresentationPixelSpacing(java.lang.String[] arrstrPresentationPixelSpacing)

Sets the Physical distance between the center of each pixel in the referenced image

Parameters:

arrstrPresentationPixelSpacing - String array of Physical distance.

getPresentationPixelSpacing

public java.lang.String[] getPresentationPixelSpacing()

Retrieves Physical distance between the center of each pixel in the referenced image

Returns:

String[] - String array of Physical distance.

setPresentationPixelAspectRatio

public void setPresentationPixelAspectRatio(java.lang.String[] arrstrPresentationPixelAspectRatio)

Sets the Ratio of the vertical size and the horizontal size of the pixels in the referenced image

Parameters:

arrstrPresentationPixelAspectRatio - String array of the Ratio

getPresentationPixelAspectRatio

public java.lang.String[] getPresentationPixelAspectRatio()

Retrieves the Ratio of the vertical size and the horizontal size of the pixels in the referenced image

Returns:

String[] - String array of the Ratio.

setPresentationPixelMagnificationRatio

public void setPresentationPixelMagnificationRatio(float fPresentationPixelMagnificationRatio)

Sets the Ratio of displayed pixels to source pixels,specified in one dimension.

Parameters:

fPresentationPixelMagnificationRatio - Float value of the Ratio of displayed pixels to source pixels

getPresentationPixelMagnificationRatio

public float getPresentationPixelMagnificationRatio()

Retrieves the Ratio of displayed pixels to source pixels,specified in one dimension.

Returns:

float - Float value of the Ratio of displayed pixels to source pixels

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.