cdac.medinfo.sdk.dcm30_04.baselibs

Class ReferencedImageNavigationSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.SOPInstanceReferenceMacroDependentItem

cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedImageNavigationSequenceItem

All Implemented Interfaces:

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

public class ReferencedImageNavigationSequenceItem
extends SOPInstanceReferenceMacroDependentItem

This class is for identification of correspondence between areas of Pixel Data(07FE,0010) and frames of higher resolution images.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
short[]	getBottomRightHandCornerOfLocalizerArea() Retrieves Top Left Hand Corner of Localizer image pixel areacorresponding to referenced frame,specified as column\row.Column is the horizontal offset and row is the vertical offset.
java.lang.String	getOpticalPathIdentifier() Retrieves the optical path used in acquiring the referenced Frameby reference to an Item in the Optical Path Sequence(0048,0105) of the current SOP Instance.
java.lang.String[]	getPixelSpacing() Retrieves Pixel Spacing in Referenced Image,specified as a numeric pair- adjacent row spacing \ adjacent column spacing, in mm.
java.lang.String[]	getReferencedFrameNumber() Retrieves Referenced Frame Number within Referenced Image.
short	getSamplesPerPixel() Retrieves the number of samples (color planes) containing information inthe referenced image.
short[]	getTopLeftHandCornerOfLocalizerArea() Retrieves Top Left Hand Corner of Localizer image pixel areacorresponding to referenced frame,specified as column\row.Column is the horizontal offset and row is the vertical offset.
java.lang.String	getZOffsetInSlideCoordinateSystem() Retrieves the Z offset of the referenced frame from the Slide CoordinatesSystem reference plane, in microns
void	setBottomRightHandCornerOfLocalizerArea(short[] arrShBottomRightHandCornerOfLocalizerArea)
void	setOpticalPathIdentifier(java.lang.String strOpticalPathIdentifier) Sets the optical path used in acquiring the referenced Frameby reference to an Item in the Optical Path Sequence(0048,0105) of the current SOP Instance.
void	setPixelSpacing(java.lang.String[] strPixelSpacing) Sets Pixel Spacing in Referenced Image,specified as a numeric pair- adjacent row spacing \ adjacent column spacing, in mm.
void	setReferencedFrameNumber(java.lang.String strReferencedFrameNumber) Sets Referenced Frame Number within Referenced Image.
void	setSamplesPerPixel(short shSamplesPerPixel) Sets the number of samples (color planes) containing information inthe referenced image.
void	setTopLeftHandCornerOfLocalizerArea(short[] arrShTopLeftHandCornerOfLocalizerArea)
void	setZOffsetInSlideCoordinateSystem(java.lang.String strZOffsetInSlideCoordinateSystem) Sets the Z offset of the referenced frame from the Slide CoordinatesSystem reference plane, in microns
boolean	validateForModule() Validates all the attributes in ReferencedImageNavigationSequenceItem that are present in the DataSet.

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

getSOPInstanceReferenceMacro

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

setReferencedFrameNumber

public void setReferencedFrameNumber(java.lang.String strReferencedFrameNumber)

Sets Referenced Frame Number within Referenced Image. Only asingle value shall be present.

Parameters:

strReferencedFrameNumber - String Value component of a Name/Value pair when the Concept implied by Concept Name

getReferencedFrameNumber

public java.lang.String[] getReferencedFrameNumber()

Retrieves Referenced Frame Number within Referenced Image. Only asingle value shall be present.

Returns:

String Array - Value of ReferencedFrameNumber

setTopLeftHandCornerOfLocalizerArea

public void setTopLeftHandCornerOfLocalizerArea(short[] arrShTopLeftHandCornerOfLocalizerArea)

getTopLeftHandCornerOfLocalizerArea

public short[] getTopLeftHandCornerOfLocalizerArea()

Retrieves Top Left Hand Corner of Localizer image pixel areacorresponding to referenced frame,specified as column\row.Column is the horizontal offset and row is the vertical offset.

Returns:

short Array - TopLeftHandCornerOfLocalizerArea.

setBottomRightHandCornerOfLocalizerArea

public void setBottomRightHandCornerOfLocalizerArea(short[] arrShBottomRightHandCornerOfLocalizerArea)

getBottomRightHandCornerOfLocalizerArea

public short[] getBottomRightHandCornerOfLocalizerArea()

Retrieves Top Left Hand Corner of Localizer image pixel areacorresponding to referenced frame,specified as column\row.Column is the horizontal offset and row is the vertical offset.

Returns:

short Array - TopLeftHandCornerOfLocalizerArea.

setPixelSpacing

public void setPixelSpacing(java.lang.String[] strPixelSpacing)

Sets Pixel Spacing in Referenced Image,specified as a numeric pair- adjacent row spacing \ adjacent column spacing, in mm.

Parameters:

strPixelSpacing - String value of Pixel Spacing.

getPixelSpacing

public java.lang.String[] getPixelSpacing()

Retrieves Pixel Spacing in Referenced Image,specified as a numeric pair- adjacent row spacing \ adjacent column spacing, in mm.

Returns:

String - value of Pixel Spacing.

setZOffsetInSlideCoordinateSystem

public void setZOffsetInSlideCoordinateSystem(java.lang.String strZOffsetInSlideCoordinateSystem)

Sets the Z offset of the referenced frame from the Slide CoordinatesSystem reference plane, in microns

Parameters:

strZOffsetInSlideCoordinateSystem - String value of Z Offset in Slide CoordinateSystem.

getZOffsetInSlideCoordinateSystem

public java.lang.String getZOffsetInSlideCoordinateSystem()

Retrieves the Z offset of the referenced frame from the Slide CoordinatesSystem reference plane, in microns

Returns:

String - value of Z Offset in Slide CoordinateSystem

setSamplesPerPixel

public void setSamplesPerPixel(short shSamplesPerPixel)

Sets the number of samples (color planes) containing information inthe referenced image.

Parameters:

shSamplesPerPixel - short value of Samples per Pixel

getSamplesPerPixel

public short getSamplesPerPixel()

Retrieves the number of samples (color planes) containing information inthe referenced image.

Returns:

short - short value of Samples per Pixel

setOpticalPathIdentifier

public void setOpticalPathIdentifier(java.lang.String strOpticalPathIdentifier)

Sets the optical path used in acquiring the referenced Frameby reference to an Item in the Optical Path Sequence(0048,0105) of the current SOP Instance.

Parameters:

strOpticalPathIdentifier -

getOpticalPathIdentifier

public java.lang.String getOpticalPathIdentifier()

Retrieves the optical path used in acquiring the referenced Frameby reference to an Item in the Optical Path Sequence(0048,0105) of the current SOP Instance.

Returns:

String - value of Optical Path Identifier.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in ReferencedImageNavigationSequenceItem that are present in the DataSet.

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class SOPInstanceReferenceMacroDependentItem

Returns:

boolean - returns validation success as success or Failure

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.