Package org.dcm4che.typeddicom.dataelements

Class Illumination

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.Illumination

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class Illumination
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Illumination
Keyword: Illumination
Tag: (2010,015E)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • Basic Film Box Presentation Module > Illumination
  as follows:
  Attribute Name: Illumination
  Type:
  Attribute Description:

  Luminance of lightbox illuminating a piece of transmissive film, or for the case of reflective media, luminance obtainable from diffuse reflection of the illumination present. Expressed as L0, in candelas per square meter (cd/m²).

  
  
• Described in the contexts:
  • SC Multi-frame Image Module > Illumination
  as follows:
  Attribute Name: Illumination
  Type: 3
  Attribute Description:

  Luminance of a hypothetical viewing device illuminating a piece of monochrome transmissive film, or for the case of reflective media, luminance obtainable from diffuse reflection of the illumination present. Expressed as L0, in candelas per square meter (cd/m²).

  Note

  May be used together with Reflected Ambient Light (2010,0160) to recover Optical Density information from P-Values. See DICOM Standard Part 3 - Section C.8.6.3.1.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Illumination.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Illumination" (see Illumination)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
Illumination()	Creates a new Illumination object which wraps a new and empty Attributes object.
Illumination(org.dcm4che3.data.Attributes attributes)	Creates a new Illumination object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
Illumination	copy()	Returns a new Illumination which wraps a copy of the Attributes wrapped in this Illumination.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

equals, exists, getValue, hashCode, toString

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

getAttributes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper

getInt, setInt

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

Illumination

public Illumination(org.dcm4che3.data.Attributes attributes)

Creates a new Illumination object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

Illumination

public Illumination()

Creates a new Illumination object which wraps a new and empty Attributes object.

Method Details

copy

public Illumination copy()

Returns a new Illumination which wraps a copy of the Attributes wrapped in this Illumination. (see Attributes(Attributes)

Returns:

a new Illumination which wraps a copy of the Attributes wrapped in this Illumination.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.