cdac.medinfo.sdk.dcm30_04.baselibs

Class HistogramSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.HistogramSequenceItem

All Implemented Interfaces:

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

public class HistogramSequenceItem
extends Item

This item class contains methods to set,get and validate the attributes in the Histogram Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
short	getHistogramBinWidth() Retrieves the number of consecutive stored pixel values included in a bin.
short	getHistogramFirstBinValue() Retrieves the stored pixel value corresponding to the lowest pixel value counted in the first bin.
short	getHistogramLastBinValue() Retrieves the stored pixel value corresponding to the highest pixel value counted in the last bin.
short	getHistogramNumberOfBins() Retrieves the number of �bins� (entries) in the histogram.
int[]	getInterpretationData() Retreives Histogram Data encoded as 32 bit unsigned counts of the number of pixel values in each bin.
java.lang.String	getInterpretationExplanation() Retreives free form text explanation of the meaning of the LUT.
void	setHistogramBinWidth(short shHistogramBinWidth) Sets the number of consecutive stored pixel values included in a bin.
void	setHistogramFirstBinValue(short shHistogramFirstBinValue) Sets the stored pixel value corresponding to the lowest pixel value counted in the first bin.
void	setHistogramLastBinValue(short shHistogramLastBinValue) Sets the stored pixel value corresponding to the highest pixel value counted in the last bin.
void	setHistogramNumberOfBins(short shHistogramNumberOfBins) Sets the number of �bins� (entries) in the histogram.
void	setInterpretationData(int[] arrIntInterpretationData) Sets Histogram Data encoded as 32 bit unsigned counts of the number of pixel values in each bin.
void	setInterpretationExplanation(java.lang.String strInterpretationExplanation) Sets free form text explanation of the meaning of the LUT.
boolean	validateForModule() Validates all the attributes in HistogramSequenceItem 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 HistogramSequenceItem 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.

setHistogramNumberOfBins

public void setHistogramNumberOfBins(short shHistogramNumberOfBins)

Sets the number of �bins� (entries) in the histogram.

Parameters:

shHistogramNumberOfBins - short value of Histogram Number of Bins.

getHistogramNumberOfBins

public short getHistogramNumberOfBins()

Retrieves the number of �bins� (entries) in the histogram.

Returns:

short - short value of Histogram Number of Bins.

setHistogramFirstBinValue

public void setHistogramFirstBinValue(short shHistogramFirstBinValue)

Sets the stored pixel value corresponding to the lowest pixel value counted in the first bin. All image pixel values less than this value are not included in the histogram.

Parameters:

shHistogramFirstBinValue - short value of Histogram First Bin Value.

getHistogramFirstBinValue

public short getHistogramFirstBinValue()

Retrieves the stored pixel value corresponding to the lowest pixel value counted in the first bin.

Returns:

short - short value of Histogram Number of Bins.

setHistogramLastBinValue

public void setHistogramLastBinValue(short shHistogramLastBinValue)

Sets the stored pixel value corresponding to the highest pixel value counted in the last bin. All image pixel values greater than this value are not included in the histogram.

Parameters:

shHistogramLastBinValue - short value of Histogram Last Bin Value.

getHistogramLastBinValue

public short getHistogramLastBinValue()

Retrieves the stored pixel value corresponding to the highest pixel value counted in the last bin.

Returns:

short - short value of Histogram Last Bin Value.

setHistogramBinWidth

public void setHistogramBinWidth(short shHistogramBinWidth)

Sets the number of consecutive stored pixel values included in a bin. All bins shall be of equal width.

Parameters:

shHistogramBinWidth - short value of Histogram Bin Width.

getHistogramBinWidth

public short getHistogramBinWidth()

Retrieves the number of consecutive stored pixel values included in a bin. All bins shall be of equal width.

Returns:

short - short value of Histogram Bin Width.

setInterpretationExplanation

public void setInterpretationExplanation(java.lang.String strInterpretationExplanation)

Sets free form text explanation of the meaning of the LUT.

Parameters:

strInterpretationExplanation - String value of Interpretation Explanation.

getInterpretationExplanation

public java.lang.String getInterpretationExplanation()

Retreives free form text explanation of the meaning of the LUT.

Returns:

String - value of Interpretation Explanation.

setInterpretationData

public void setInterpretationData(int[] arrIntInterpretationData)

Sets Histogram Data encoded as 32 bit unsigned counts of the number of pixel values in each bin.

Parameters:

arrIntInterpretationData - Integer array of Interpretation Data.

getInterpretationData

public int[] getInterpretationData()

Retreives Histogram Data encoded as 32 bit unsigned counts of the number of pixel values in each bin.

Returns:

int[] - Integer array of Interpretation Data.