cdac.medinfo.sdk.dcm30_04.baselibs

Class VOILUTMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.VOILUTMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class VOILUTMacro
extends Macro

This class specifies the default set of attributes encapsulated in the VOI LUT Macro.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VOILUTMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
VOILUTMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
VOILUTMacro(IItem objItem) This constructor constructs a Macro with the specified Item
VOILUTMacro(IItem objItem, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with the specified Item and DictionaryReader

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getVOILUTFunction() Return type of VOILUT Function.
VOILUTSequence	getVOILUTSequence() Retrieves pre-initialized object of VOI 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[]	getWindowCenter() Retrieves Window Center.
java.lang.String[]	getWindowCenterWidthExplanation() Return user-defined label identifier for Window Center & WidthExplanation.
java.lang.String[]	getWindowWidth() Retrieves Window Width.
void	setVOILUTFunction(EnumVOILUTFunction enumVOILUTFunction) Describes a VOI LUT function to apply to the values of Window Center(0028,1050) and Window Width (0028,1051).
void	setWindowCenter(java.lang.String[] strWindowCenter) Sets Window Center.
void	setWindowCenterWidthExplanation(java.lang.String[] strArrWindowCenterWidthExplanation) Sets Window Center & WidthExplanation.
void	setWindowWidth(java.lang.String[] strWindowWidth) Sets Window Width.
boolean	validate() Validates all the attributes in VOI LUT Macro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in VOI LUT Macro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in VOI LUT Macro that are present in the DataSet

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

addDataElement, clone, contains, getDataElement, getTransferSyntax

Methods inherited from class java.lang.Object

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

Constructor Detail

VOILUTMacro

public VOILUTMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

VOILUTMacro

public VOILUTMacro(IDataSet objDataSet,
           IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with specified DataSet and DictionaryReader

Parameters:

objDataSet - specifies the DataSet

objDictionaryReader - specifies the DICOM Dictionary reader to be used

VOILUTMacro

public VOILUTMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

VOILUTMacro

public VOILUTMacro(IItem objItem,
           IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with the specified Item and DictionaryReader

Parameters:

objItem - specifies instance of Item class

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

getVOILUTSequence

public VOILUTSequence getVOILUTSequence()

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

VOILUTSequence - instance of VOILUTSequence.

setWindowCenter

public void setWindowCenter(java.lang.String[] strWindowCenter)

Sets Window Center.

Parameters:

strWindowCenter - String value of Window Center.

getWindowCenter

public java.lang.String[] getWindowCenter()

Retrieves Window Center.

Returns:

String - value of Window Center.

setWindowWidth

public void setWindowWidth(java.lang.String[] strWindowWidth)

Sets Window Width.

Parameters:

strWindowWidth - String value of Window Width.

getWindowWidth

public java.lang.String[] getWindowWidth()

Retrieves Window Width.

Returns:

String - value of Window Width.

setWindowCenterWidthExplanation

public void setWindowCenterWidthExplanation(java.lang.String[] strArrWindowCenterWidthExplanation)

Sets Window Center & WidthExplanation.

Parameters:

strArrWindowCenterWidthExplanation - String value of Window Center & WidthExplanation.

getWindowCenterWidthExplanation

public java.lang.String[] getWindowCenterWidthExplanation()

Return user-defined label identifier for Window Center & WidthExplanation.

Returns:

String - value of Window Center & WidthExplanation.

setVOILUTFunction

public void setVOILUTFunction(EnumVOILUTFunction enumVOILUTFunction)

Describes a VOI LUT function to apply to the values of Window Center(0028,1050) and Window Width (0028,1051). See Section C.11.2.1.3 for further explanation. Defined Terms: LINEAR SIGMOID

Parameters:

enumVOILUTFunction - enum value of VOILUT Function.

getVOILUTFunction

public java.lang.String getVOILUTFunction()

Return type of VOILUT Function.

Returns:

String - value of VOILUT Function.

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in VOI LUT Macro

Returns:

boolean - Success -true, Failure -false.

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IDataSet objIDataSet)
                        throws InvalidMacroException

Validates all the attributes in VOI LUT Macro that are present in the DataSet

Parameters:

objIDataSet - collection of DataElements

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IItem objIItem)
                        throws InvalidMacroException

Validates all the attributes in VOI LUT Macro that are present in the DataSet

Parameters:

objIItem - collection of DataElements in a sequence

Returns:

boolean Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.