cdac.medinfo.sdk.dcm30_04.baselibs

Class MaskSubtractionSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.MaskSubtractionSequenceItem

All Implemented Interfaces:

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

public class MaskSubtractionSequenceItem
extends Item

This item class contains methods to set,get and validate attributes of Mask Subtraction Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
short[]	getApplicableFrameRange() Return Applicable Frame Range.
short	getContrastFrameAveraging() Return number of contrast frames to average together before performing the mask operation..
short[]	getMaskFrameNumbers() Return frame numbers of the pixel data used to generate this mask.
java.lang.String	getMaskOperation() Return type of mask operation to be performed.
java.lang.String	getMaskOperationExplanation() Return Free form explanation of this particular mask operation.
java.lang.String	getMaskSelectionMode() Retrieves type of the MaskSelectionMode encoded in this Item
float[]	getMaskSubPixelShift() Retrieves Mask Sub Pixel Shift.
short	getSubtractionItemID() Sets Identification of the Subtraction Item used to associate a certain Mask Sub-PixelShift (0028,6114)
short	getTIDOffset() Return offset to be subtracted from the current frame number in order to locate the mask frame in TID mode.
void	setApplicableFrameRange(short[] arrShMaskOperation) Sets Applicable Frame Range.
void	setContrastFrameAveraging(short shContrastFrameAveraging) Sets the number of contrast frames to average together before performing the mask operation.
void	setMaskFrameNumbers(short[] arrMaskFrameNumbers) Sets the frame numbers of the pixel data used to generate this mask.
void	setMaskOperation(EnumMaskOperation enumEnumMaskOperation) Sets the type of mask operation to be performed.
void	setMaskOperationExplanation(java.lang.String strMaskOperationExplanation) Sets Free form explanation of this particular mask operation.
void	setMaskSelectionMode(EnumMaskSelectionMode enumMaskSelectionMode) Sets the Specifies the method of selection of the mask operations of this item.
void	setMaskSubPixelShift(float[] arrFMaskSubPixelShift) Sets a pair of floating point numbers specifying the fractional vertical [adjacent row spacing] and horizontal [adjacent column spacing] pixel shift applied to the mask before subtracting it from the contrast frame.
void	setSubtractionItemID(short shSubtractionItemID) Sets Identification of the Subtraction Item used to associate a certain Mask Sub-PixelShift (0028,6114)
void	setTIDOffset(short shTIDOffset) Sets the offset to be subtracted from the current frame number in order to locate the mask frame in TID mode.
boolean	validateForModule() Validates all the attributes in Mask Subtraction Sequence Item 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 Mask Subtraction Sequence Item 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.

setMaskOperation

public void setMaskOperation(EnumMaskOperation enumEnumMaskOperation)

Sets the type of mask operation to be performed.

Parameters:

enumEnumMaskOperation - Specifies Enum value of Mask Operation

getMaskOperation

public java.lang.String getMaskOperation()

Return type of mask operation to be performed.

Returns:

String - Specifies String value of Mask Operation

setSubtractionItemID

public void setSubtractionItemID(short shSubtractionItemID)

Sets Identification of the Subtraction Item used to associate a certain Mask Sub-PixelShift (0028,6114)

Parameters:

shSubtractionItemID - short value of Number of significant bits

getSubtractionItemID

public short getSubtractionItemID()

Sets Identification of the Subtraction Item used to associate a certain Mask Sub-PixelShift (0028,6114)

Parameters:

shSubtractionItemID - short value of Number of significant bits

setApplicableFrameRange

public void setApplicableFrameRange(short[] arrShMaskOperation)

Sets Applicable Frame Range. Each pair of numbers in this multivalued attribute specify a beginning and ending frame number inclusive of a range where this particular mask operation is valid. Discontinuous ranges are represented by multiple pairs of numbers. Frames in a Multiframe Image are specified by sequentially increasing number values beginning with 1. If this Attribute is missing in this particular sequence item, then the mask operation is applicable throughout the entire Multiframe Image, subject to certain limits

Parameters:

arrShMaskOperation - short array of frame numbers

getApplicableFrameRange

public short[] getApplicableFrameRange()

Return Applicable Frame Range.

Returns:

short [] - short array of Applicable Frames.

setMaskFrameNumbers

public void setMaskFrameNumbers(short[] arrMaskFrameNumbers)

Sets the frame numbers of the pixel data used to generate this mask. Frames in a Multi-frame Image are specified by sequentially increasing number values beginning with 1. Required if the Mask Operation (0028,6101) is AVG_SUB.

Parameters:

arrMaskFrameNumbers - short array of Mask Frame Numbers

getMaskFrameNumbers

public short[] getMaskFrameNumbers()

Return frame numbers of the pixel data used to generate this mask.

Returns:

short [] - short array of Mask Frame Numbers.

setContrastFrameAveraging

public void setContrastFrameAveraging(short shContrastFrameAveraging)

Sets the number of contrast frames to average together before performing the mask operation. If the Attribute is missing, no averaging is performed.

Parameters:

shContrastFrameAveraging - short value of Contrast Frame Averaging

getContrastFrameAveraging

public short getContrastFrameAveraging()

Return number of contrast frames to average together before performing the mask operation..

Returns:

short - short value of Contrast Frame Averaging

setMaskSubPixelShift

public void setMaskSubPixelShift(float[] arrFMaskSubPixelShift)

Sets a pair of floating point numbers specifying the fractional vertical [adjacent row spacing] and horizontal [adjacent column spacing] pixel shift applied to the mask before subtracting it from the contrast frame.

Parameters:

arrFMaskSubPixelShift - pair of floating point numbers

getMaskSubPixelShift

public float[] getMaskSubPixelShift()

Retrieves Mask Sub Pixel Shift.

Returns:

float[] - Float array of Mask Sub Pixel Shift.

setTIDOffset

public void setTIDOffset(short shTIDOffset)

Sets the offset to be subtracted from the current frame number in order to locate the mask frame in TID mode. If zero length, TID Offset defaults to 1. Required if Mask Operation (0028,6101) is TID.

Parameters:

shTIDOffset - short value of TID Offset.

getTIDOffset

public short getTIDOffset()

Return offset to be subtracted from the current frame number in order to locate the mask frame in TID mode.

Returns:

short - short value of TID Offset

setMaskOperationExplanation

public void setMaskOperationExplanation(java.lang.String strMaskOperationExplanation)

Sets Free form explanation of this particular mask operation.

Parameters:

strMaskOperationExplanation - String value of Mask Operation Explanation

getMaskOperationExplanation

public java.lang.String getMaskOperationExplanation()

Return Free form explanation of this particular mask operation.

Returns:

String - Specifies String value of Mask Operation Explanation

setMaskSelectionMode

public void setMaskSelectionMode(EnumMaskSelectionMode enumMaskSelectionMode)

Sets the Specifies the method of selection of the mask operations of this item. Enumerated Values: SYSTEM USER

Parameters:

enumMaskSelectionMode - Specifies type of the value encoded in this Item

getMaskSelectionMode

public java.lang.String getMaskSelectionMode()

Retrieves type of the MaskSelectionMode encoded in this Item

Returns:

String - Type of the Mask Selection Mode encoded in this Item