cdac.medinfo.sdk.dcm30_04.baselibs

Class ImageBoxContentSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.ImageBoxContentSequenceItem

All Implemented Interfaces:

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

public class ImageBoxContentSequenceItem
extends Item

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

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getConfigurationInformation() Return character string that contains either the ID of the printer configuration table that contains a set of values for implementation specific print parameters (e.g.
short	getImagePosition() Retrieves the position of the image on the film, based on Image Display Format (2010,0010).
java.lang.String	getMagnificationType() Retrieves Magnification Type.
java.lang.String	getPolarity() Retrieves whether minimum pixel values (after VOI LUT transformation) are to printed black or white.
ReferencedImageOverlayBoxSequence	getReferencedImageOverlayBoxSequence() Retrieves pre-initialized object of Referenced Image Overlay Box 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
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
ReferencedPresentationLUTSequence	getReferencedPresentationLUTSequence() Retrieves pre-initialized object of Referenced Presentation LUT 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
java.lang.String	getRequestedDecimateOrCropBehavior() Return whether image pixels are to be decimated or cropped if the image rows or columns is greater than the available printable pixels in an Image Box.
java.lang.String	getRequestedImageSize() Return width (x-dimension) in mm of the image to be printed.
java.lang.String	getSmoothingType() Return value that specifies the type of the interpolation function.
java.lang.String	getSOPInstanceUID() Retrieves SOP Instance UID of the contained Image Box SOP Class.
void	setConfigurationInformation(java.lang.String strConfigurationInformation) Sets character string that contains either the ID of the printer configuration table that contains a set of values for implementation specific print parameters (e.g.
void	setImagePosition(short sImagePosition) Sets the position of the image on the film, based on Image Display Format (2010,0010).
void	setMagnificationType(EnumMagnificationType enumMagnificationType) Sets interpolation type by which the printer magnifies or decimates the image in order to fit the image in the image box on film.
void	setPolarity(EnumPolarity enumPolarity) Sets whether minimum pixel values (after VOI LUT transformation) are to printed black or white.
void	setRequestedDecimateOrCropBehavior(EnumDecimateOrCropBehavior enumDecimateOrCropBehavior) Sets whether image pixels are to be decimated or cropped if the image rows or columns is greater than the available printable pixels in an Image Box.
void	setRequestedImageSize(java.lang.String strRequestedImageSize) Sets width (x-dimension) in mm of the image to be printed.
void	setSmoothingType(java.lang.String strSmoothingType) Sets value that specifies the type of the interpolation function.
void	setSOPInstanceUID(java.lang.String strSOPInstanceUID) Sets SOP Instance UID of the contained Image Box SOP Class.
boolean	validateForModule() Validates all the attributes in ImageBoxContentSequenceItem 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

setSOPInstanceUID

public void setSOPInstanceUID(java.lang.String strSOPInstanceUID)

Sets SOP Instance UID of the contained Image Box SOP Class. Required if Sequence is sent.

Parameters:

strSOPInstanceUID - String value of SOP Instance UID of the contained Image Box SOP Class.

getSOPInstanceUID

public java.lang.String getSOPInstanceUID()

Retrieves SOP Instance UID of the contained Image Box SOP Class. Required if Image Box Content Sequence is sent.

Returns:

String - value of SOP Instance UID.

setImagePosition

public void setImagePosition(short sImagePosition)

Sets the position of the image on the film, based on Image Display Format (2010,0010).

Parameters:

sImagePosition - short value of Image Position.

getImagePosition

public short getImagePosition()

Retrieves the position of the image on the film, based on Image Display Format (2010,0010).

Returns:

short - short value of Image Position.

setPolarity

public void setPolarity(EnumPolarity enumPolarity)

Sets whether minimum pixel values (after VOI LUT transformation) are to printed black or white. Enumerated Values: 1) NORMAL = pixels shall be printed as specified by the Photometric Interpretation (0028,0004) 2) REVERSE = pixels shall be printed with the opposite polarity as specified by the Photometric Interpretation (0028,0004). If Polarity (2020,0020) is not specified by the SCU, the SCP shall print with NORMAL polarity.

Parameters:

enumPolarity - Enum value of Polarity.

getPolarity

public java.lang.String getPolarity()

Retrieves whether minimum pixel values (after VOI LUT transformation) are to printed black or white.

Returns:

String - value of Polarity.

setMagnificationType

public void setMagnificationType(EnumMagnificationType enumMagnificationType)

Sets interpolation type by which the printer magnifies or decimates the image in order to fit the image in the image box on film. Defined Terms: 1) REPLICATE 2) BILINEAR 3) CUBIC 4) NONE

Parameters:

enumMagnificationType - Enum value of Magnification Type.

getMagnificationType

public java.lang.String getMagnificationType()

Retrieves Magnification Type.

Returns:

String - value of Magnification Type.

setSmoothingType

public void setSmoothingType(java.lang.String strSmoothingType)

Sets value that specifies the type of the interpolation function. Values are defined in Conformance Statement. Only valid for Magnification Type (2010,0060) = CUBIC.

Parameters:

strSmoothingType - String value of Smoothing Type.

getSmoothingType

public java.lang.String getSmoothingType()

Return value that specifies the type of the interpolation function.

Returns:

String - value of Smoothing Type.

setRequestedImageSize

public void setRequestedImageSize(java.lang.String strRequestedImageSize)

Sets width (x-dimension) in mm of the image to be printed. This value overrides the size that corresponds with optimal filling of the Image Box.

Parameters:

strRequestedImageSize - String value of Requested Image Size.

getRequestedImageSize

public java.lang.String getRequestedImageSize()

Return width (x-dimension) in mm of the image to be printed. This value overrides the size that corresponds with optimal filling of the Image Box.

Returns:

String - value of Requested Image Size.

setRequestedDecimateOrCropBehavior

public void setRequestedDecimateOrCropBehavior(EnumDecimateOrCropBehavior enumDecimateOrCropBehavior)

Sets whether image pixels are to be decimated or cropped if the image rows or columns is greater than the available printable pixels in an Image Box. Enumerated Values: 1) DECIMATE = a magnification factor <1 to be applied to the image. 2) CROP = some image rows and/or columns are to be deleted before printing. The specific algorithm for cropping shall be described in the SCP Conformance Statement. 3) FAIL = the SCP shall not crop or decimate.

Parameters:

enumDecimateOrCropBehavior - Enum value of Requested Decimate/Crop Behavior.

getRequestedDecimateOrCropBehavior

public java.lang.String getRequestedDecimateOrCropBehavior()

Return whether image pixels are to be decimated or cropped if the image rows or columns is greater than the available printable pixels in an Image Box.

Returns:

String - value of Requested Decimate/Crop Behavior.

setConfigurationInformation

public void setConfigurationInformation(java.lang.String strConfigurationInformation)

Sets character string that contains either the ID of the printer configuration table that contains a set of values for implementation specific print parameters (e.g. perception LUT related parameters) or one or more configuration data values, encoded as characters.

Parameters:

strConfigurationInformation - String value of Configuration Information.

getConfigurationInformation

public java.lang.String getConfigurationInformation()

Return character string that contains either the ID of the printer configuration table that contains a set of values for implementation specific print parameters (e.g. perception LUT related parameters) or one or more configuration data values, encoded as characters.

Returns:

String - value of Configuration Information.

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.

getReferencedImageOverlayBoxSequence

public ReferencedImageOverlayBoxSequence getReferencedImageOverlayBoxSequence()

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

ReferencedImageOverlayBoxSequence - instance of Referenced Image Overlay Box Sequence.

getReferencedPresentationLUTSequence

public ReferencedPresentationLUTSequence getReferencedPresentationLUTSequence()

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

ReferencedPresentationLUTSequence - instance of Referenced Presentation LUT Sequence.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in ImageBoxContentSequenceItem 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.