cdac.medinfo.sdk.dcm30_04.baselibs

Class OpticalPathSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.OpticalPathSequenceItem

All Implemented Interfaces:

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

public class OpticalPathSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Optical Path Sequence .

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
ChannelDescriptionCodeSequence	getChannelDescriptionCodeSequence() Retrieves pre-initialized object of Channel Description CodeSequence.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	getCondenserLensPower() Retrieves CondenserLensPower.
ISingleCollection<byte[]>	getICCProfile() Retrieves the ICC Profile .
IlluminationColorCodeSequence	getIlluminationColorCodeSequence() Retrieves pre-initialized object of Illumination Color Code 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.
IlluminationTypeCodeSequence	getIlluminationTypeCodeSequence() Retrieves pre-initialized object of Illumination Color Code 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.
float	getIlluminationWaveLength() Retrieves the IlluminationWaveLength.
IlluminatorTypeCodeSequence	getIlluminatorTypeCodeSequence() Retrieves pre-initialized object of Illumination Type Code 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.
LensesCodeSequence	getLensesCodeSequence() Retrieves pre-initialized object of Lenses Code 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	getLightPathFilterPassBand() Retrieves the LightPathFilterPassBand.
short	getLightPathFilterPassThroughWavelength() Retrieves the LightPathFilterPassThroughWavelengthn.
LightPathFilterTypeStackCodeSequence	getLightPathFilterTypeStackCodeSequence() Retrieves pre-initialized object of Light Path Filter Type Stack Code 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	getObjectiveLensNumericalAperture() Retrieves ObjectiveLensNumericalAperture.
java.lang.String	getObjectiveLensPower() Retrieves ObjectiveLensPower.
java.lang.String	getOpticalPathDescription() Retrieves Optical Path Description.
java.lang.String	getOpticalPathIdentifier() Retrieves OpticalPathIdentifier.
PaletteColorLookupTableSequence	getPaletteColorLookupTableSequence() Retrieves pre-initialized object of Palette Color Lookup TableSequence.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.
void	setCondenserLensPower(java.lang.String strCondenserLensPower) Sets Condenser Lens Power.
void	setICCProfile(ISingleCollection<byte[]> vectICCProfile) Sets the ICC Profile An ICC Profile encoding the transformation of device-dependent stored pixel values into PCS-Values.
void	setIlluminationWaveLength(float fIlluminationWaveLength) Sets the Illumination Wave Length.
void	setLightPathFilterPassBand(short sLightPathFilterPassBand) Sets Light Path Filter Pass-Through Wavelength.
void	setLightPathFilterPassThroughWavelength(short sLightPathFilterPassThroughWavelength) Sets Light Path Filter Pass-Through Wavelength.
void	setObjectiveLensNumericalAperture(java.lang.String strObjectiveLensNumericalAperture) Sets ObjectiveLensNumericalAperture.
void	setObjectiveLensPower(java.lang.String strObjectiveLensPower) Sets ObjectiveLensPower.
void	setOpticalPathDescription(java.lang.String strOpticalPathDescription) Sets OpticalPathDescription.
void	setOpticalPathIdentifier(java.lang.String strOpticalPathIdentifier) Sets the uniquely identified path described in the Optical PathSequence (0048,0105) by reference to an Item with the sameOptical Path Identifier (0048,0106) value..
boolean	validateForModule() Validates all the attributes in OpticalPathSequenceItem 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 OpticalPathSequenceItem 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.

setOpticalPathIdentifier

public void setOpticalPathIdentifier(java.lang.String strOpticalPathIdentifier)

Sets the uniquely identified path described in the Optical PathSequence (0048,0105) by reference to an Item with the sameOptical Path Identifier (0048,0106) value..

Parameters:

strOpticalPathIdentifier -

getOpticalPathIdentifier

public java.lang.String getOpticalPathIdentifier()

Retrieves OpticalPathIdentifier.

Returns:

String - value of Optical Path Identifier.

setOpticalPathDescription

public void setOpticalPathDescription(java.lang.String strOpticalPathDescription)

Sets OpticalPathDescription.

Parameters:

strOpticalPathDescription - String value of Optical Path Description.

getOpticalPathDescription

public java.lang.String getOpticalPathDescription()

Retrieves Optical Path Description.

Returns:

String - value of Optical Path Description.

getIlluminationColorCodeSequence

public IlluminationColorCodeSequence getIlluminationColorCodeSequence()

Retrieves pre-initialized object of Illumination Color Code 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:

IlluminationColorCodeSequence - instance of Illumination Color Code Sequence.

getIlluminatorTypeCodeSequence

public IlluminatorTypeCodeSequence getIlluminatorTypeCodeSequence()

Retrieves pre-initialized object of Illumination Type Code 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:

IlluminationColorCodeSequence - instance of Illumination Color Code Sequence.

setIlluminationWaveLength

public void setIlluminationWaveLength(float fIlluminationWaveLength)

Sets the Illumination Wave Length.

Parameters:

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

getIlluminationWaveLength

public float getIlluminationWaveLength()

Retrieves the IlluminationWaveLength.

Returns:

float - Float value of the Illumination WaveLength .

getIlluminationTypeCodeSequence

public IlluminationTypeCodeSequence getIlluminationTypeCodeSequence()

Retrieves pre-initialized object of Illumination Color Code 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:

IlluminationColorCodeSequence - instance of Illumination Color Code Sequence.

getLightPathFilterTypeStackCodeSequence

public LightPathFilterTypeStackCodeSequence getLightPathFilterTypeStackCodeSequence()

Retrieves pre-initialized object of Light Path Filter Type Stack Code 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:

LightPathFilterTypeStackCodeSequence - instance of Light Path Filter Type Stack Code Sequence.

setLightPathFilterPassThroughWavelength

public void setLightPathFilterPassThroughWavelength(short sLightPathFilterPassThroughWavelength)

Sets Light Path Filter Pass-Through Wavelength.

Parameters:

sLightPathFilterPassThroughWavelength - short value of Light Path Filter Pass-Through Wavelength.

getLightPathFilterPassThroughWavelength

public short getLightPathFilterPassThroughWavelength()

Retrieves the LightPathFilterPassThroughWavelengthn.

Returns:

short - short value of LightPathFilterPassThroughWavelength.

setLightPathFilterPassBand

public void setLightPathFilterPassBand(short sLightPathFilterPassBand)

Sets Light Path Filter Pass-Through Wavelength.

Parameters:

sLightPathFilterPassBand - short value of Light Path Filter Pass-Through Wavelength.

getLightPathFilterPassBand

public short getLightPathFilterPassBand()

Retrieves the LightPathFilterPassBand.

Returns:

short - short value of LightPathFilterPassBand.

getLensesCodeSequence

public LensesCodeSequence getLensesCodeSequence()

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

LensesCodeSequence - instance of Light Path Filter Type Stack Code Sequence.

setCondenserLensPower

public void setCondenserLensPower(java.lang.String strCondenserLensPower)

Sets Condenser Lens Power.

Parameters:

strCondenserLensPower - String value of Condenser Lens Power.

getCondenserLensPower

public java.lang.String getCondenserLensPower()

Retrieves CondenserLensPower.

Returns:

String - value of CondenserLensPower.

setObjectiveLensPower

public void setObjectiveLensPower(java.lang.String strObjectiveLensPower)

Sets ObjectiveLensPower.

Parameters:

strObjectiveLensPower - String value of ObjectiveLensPower.

getObjectiveLensPower

public java.lang.String getObjectiveLensPower()

Retrieves ObjectiveLensPower.

Returns:

String - value of ObjectiveLensPower.

setObjectiveLensNumericalAperture

public void setObjectiveLensNumericalAperture(java.lang.String strObjectiveLensNumericalAperture)

Sets ObjectiveLensNumericalAperture.

Parameters:

strObjectiveLensNumericalAperture - String value of ObjectiveLensNumericalAperture.

getObjectiveLensNumericalAperture

public java.lang.String getObjectiveLensNumericalAperture()

Retrieves ObjectiveLensNumericalAperture.

Returns:

String - value of ObjectiveLensNumericalAperturer.

getChannelDescriptionCodeSequence

public ChannelDescriptionCodeSequence getChannelDescriptionCodeSequence()

Retrieves pre-initialized object of Channel Description CodeSequence.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:

ChannelDescriptionCodeSequence - instance of Light Path Filter Type Stack Code Sequence.

getPaletteColorLookupTableSequence

public PaletteColorLookupTableSequence getPaletteColorLookupTableSequence()

Retrieves pre-initialized object of Palette Color Lookup TableSequence.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:

PaletteColorLookupTableSequence - instance of Palette Color Lookup TableSequence.

setICCProfile

public void setICCProfile(ISingleCollection<byte[]> vectICCProfile)

Sets the ICC Profile An ICC Profile encoding the transformation of device-dependent stored pixel values into PCS-Values.

Parameters:

vectICCProfile - collection of byte array of ICC Profile values.

getICCProfile

public ISingleCollection<byte[]> getICCProfile()

Retrieves the ICC Profile .

Returns:

ISingleCollection - collection of byte array of ICC Profile.