cdac.medinfo.sdk.dcm30_04.baselibs

Class TargetLuminanceCharacteristicsSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.TargetLuminanceCharacteristicsSequenceItem

All Implemented Interfaces:

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

public class TargetLuminanceCharacteristicsSequenceItem
extends Item

This item class contains methods to validate, set and get the attributes of Target Luminance Characteristic sSequence .

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAmbientLightValueSource() Retrieves type of the value encoded in this Item
float	getCIExyWhitePoint() Retrieves the Ratio of displayed pixels to source pixels,specified in one dimension.
java.lang.String	getDisplayFunctionType() Retrieves type of the value encoded in this Item
float	getGammaValue() Retrieves GammaValue.The Gamma value for generating the target luminance curve.
short	getLuminanceCharacteristicsID() Retrieves Number of significant bits within the Luminance Characteristics ID
java.lang.String	getLuminanceResponseDescription() Return user-defined label identifier for Luminance Response Description.
short[]	getNumberofLuminancePoints() Retrieves one or more NumberofLuminancePoints.
LuminanceResponseSequence	getPrimaryFluenceModeSequence() Retrieves pre-initialized object of Luminance Response 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.
short	getReflectedAmbientLight() Retrieves Number of significant bits within the ReflectedAmbientLight samples
float	getTargetMaximumLuminance() Retrieves The maximum luminance value of the target luminance curve, in candelas per square meter (cd/m2).
float	getTargetMinimumLuminance() Retrieves The minimum luminance value of the target luminance curve, in candelas per square meter (cd/m2).
void	setCIExyWhitePoint(float fCIExyWhitePoint) Sets the Ratio of CIExyWhitePoint.
void	setDisplayFunctionType(java.lang.String strDisplayFunctionType) Sets the DisplayFunctionType Defined in Terms The type of Display Function used to define the target luminance curve.
void	setGammaValue(float fGammaValue) Sets GammaValue The Gamma value for generating the target luminance curve.
void	setLuminanceCharacteristicsID(short shLuminanceCharacteristicsID) Sets Number of significant bits within the LuminanceCharacteristicsID samples Number that identifies this Luminance Characteristics item.
void	setLuminanceResponseDescription(java.lang.String strLuminanceResponseDescription) Sets Luminance Response Description.User defined text to describe the user defined target luminance curve.
void	setNumberofLuminancePoints(short[] arrNumberofLuminancePoints)
void	setReflectedAmbientLight(short shReflectedAmbientLight) Sets Number of significant bits within the waveform samples
void	setTargetMaximumLuminance(float fTargetMaximumLuminance) Sets The maximum luminance value of the target luminance curve, in candelas per square meter (cd/m2).
void	setTargetMinimumLuminance(float fTargetMinimumLuminance) Sets the Ratio of Target Minimum Luminance,specified in one dimension.
void	setValueType(EnumAmbientLightValueSource enumAmbientLightValueSource) Sets the Ambient Light Value Source Defined in Terms of TEXT,NUMERIC,CODE,DATE,TIME,PNAME

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, validateForModule, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setLuminanceCharacteristicsID

public void setLuminanceCharacteristicsID(short shLuminanceCharacteristicsID)

Sets Number of significant bits within the LuminanceCharacteristicsID samples Number that identifies this Luminance Characteristics item. The value shall be unique within the Target Luminance Characteristics Sequence (0028,7008).

Parameters:

shLuminanceCharacteristicsID - short value of Number of significant bits

getLuminanceCharacteristicsID

public short getLuminanceCharacteristicsID()

Retrieves Number of significant bits within the Luminance Characteristics ID

Returns:

short - short value of Number of significant bits

setDisplayFunctionType

public void setDisplayFunctionType(java.lang.String strDisplayFunctionType)

Sets the DisplayFunctionType Defined in Terms The type of Display Function used to define the target luminance curve.

Parameters:

strDisplayFunctionType - Specifies type of the value encoded in this Item

getDisplayFunctionType

public java.lang.String getDisplayFunctionType()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setTargetMinimumLuminance

public void setTargetMinimumLuminance(float fTargetMinimumLuminance)

Sets the Ratio of Target Minimum Luminance,specified in one dimension.

Parameters:

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

getTargetMinimumLuminance

public float getTargetMinimumLuminance()

Retrieves The minimum luminance value of the target luminance curve, in candelas per square meter (cd/m2).

Returns:

float - Float value of the Ratio of Target Minimum Luminance to source pixels

setTargetMaximumLuminance

public void setTargetMaximumLuminance(float fTargetMaximumLuminance)

Sets The maximum luminance value of the target luminance curve, in candelas per square meter (cd/m2).

Parameters:

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

getTargetMaximumLuminance

public float getTargetMaximumLuminance()

Retrieves The maximum luminance value of the target luminance curve, in candelas per square meter (cd/m2).

Returns:

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

setGammaValue

public void setGammaValue(float fGammaValue)

Sets GammaValue The Gamma value for generating the target luminance curve. Required if the value of Display Function Type (0028,7019) is GAMMA.

Parameters:

fGammaValue - Float value of the Gamma Value

getGammaValue

public float getGammaValue()

Retrieves GammaValue.The Gamma value for generating the target luminance curve. Required if the value of Display Function Type (0028,7019) is GAMMA.

Returns:

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

setNumberofLuminancePoints

public void setNumberofLuminancePoints(short[] arrNumberofLuminancePoints)

getNumberofLuminancePoints

public short[] getNumberofLuminancePoints()

Retrieves one or more NumberofLuminancePoints.

Returns:

short Array -Number of Luminance Points.

getPrimaryFluenceModeSequence

public LuminanceResponseSequence getPrimaryFluenceModeSequence()

Retrieves pre-initialized object of Luminance Response 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:

LuminanceResponseSequence - instance of LuminanceResponseSequence.

setLuminanceResponseDescription

public void setLuminanceResponseDescription(java.lang.String strLuminanceResponseDescription)

Sets Luminance Response Description.User defined text to describe the user defined target luminance curve.

Parameters:

strLuminanceResponseDescription - String value of Rescale Type.

getLuminanceResponseDescription

public java.lang.String getLuminanceResponseDescription()

Return user-defined label identifier for Luminance Response Description.

Returns:

String - value of LuminanceResponseDescription.

setCIExyWhitePoint

public void setCIExyWhitePoint(float fCIExyWhitePoint)

Sets the Ratio of CIExyWhitePoint.

Parameters:

fCIExyWhitePoint - Float value of the CIExy White Point

getCIExyWhitePoint

public float getCIExyWhitePoint()

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

setReflectedAmbientLight

public void setReflectedAmbientLight(short shReflectedAmbientLight)

Sets Number of significant bits within the waveform samples

Parameters:

shReflectedAmbientLight - short value of Number of significant bits

getReflectedAmbientLight

public short getReflectedAmbientLight()

Retrieves Number of significant bits within the ReflectedAmbientLight samples

Returns:

short - short value of Number of significant bits

setValueType

public void setValueType(EnumAmbientLightValueSource enumAmbientLightValueSource)

Sets the Ambient Light Value Source Defined in Terms of TEXT,NUMERIC,CODE,DATE,TIME,PNAME

Parameters:

enumAmbientLightValueSource - Specifies type of the value encoded in this Item

getAmbientLightValueSource

public java.lang.String getAmbientLightValueSource()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item