Package org.dcm4che.typeddicom.dataelements

Class AmbientLightValueSource

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.AmbientLightValueSource

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class AmbientLightValueSource
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Ambient Light Value Source
Keyword: AmbientLightValueSource
Tag: (0028,7025)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Target Luminance Characteristics Module > Target Luminance Characteristics Sequence > Ambient Light Value Source
  as follows:
  Attribute Name: Ambient Light Value Source
  Type:
  Attribute Description:

  Source of the reflected ambient light value.

  Enumerated Values:

  DEFAULT

  a configured default value was used.

  MEASURED

  the value was measured at the time of the other measurements.

  PROVIDED

  the value was provided by an external source.

  Required if Reflected Ambient Light (2010,0160) is present.

  
  
• Described in the contexts:
  • Luminance Result Macro > Ambient Light Value Source
  • Luminance Uniformity Result Macro > Ambient Light Value Source
  as follows:
  Attribute Name: Ambient Light Value Source
  Type:
  Attribute Description:

  Source of the ambient light value.

  Enumerated Values:

  DEFAULT

  a configured default value was used.

  MEASURED

  the value was measured at the time of the other measurements.

  PROVIDED

  the value was provided by an external source.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AmbientLightValueSource.Builder<SELF extends AmbientLightValueSource.Builder<SELF,T>,T extends AmbientLightValueSource.Holder>
static interface	AmbientLightValueSource.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Ambient Light Value Source" (see AmbientLightValueSource)
static class	AmbientLightValueSource.SimpleHolder

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

CodeStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends CodeStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRIVATE_CREATOR	The Private Creator associated with this class.
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
AmbientLightValueSource()	Creates a new Ambient Light Value Source object which wraps a new and empty Attributes object.
AmbientLightValueSource(org.dcm4che3.data.Attributes attributes)	Creates a new Ambient Light Value Source object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
AmbientLightValueSource	copy()	Returns a new Ambient Light Value Source which wraps a copy of the Attributes wrapped in this Ambient Light Value Source.
String	getPrivateCreator()
int	getTag()

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.valuerepresentations.CodeStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

getString, setString

Field Details

PRIVATE_CREATOR

public static final String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

AmbientLightValueSource

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

Creates a new Ambient Light Value Source object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

AmbientLightValueSource

public AmbientLightValueSource()

Creates a new Ambient Light Value Source object which wraps a new and empty Attributes object.

Method Details

copy

public AmbientLightValueSource copy()

Returns a new Ambient Light Value Source which wraps a copy of the Attributes wrapped in this Ambient Light Value Source. (see Attributes(Attributes)

Returns:

a new Ambient Light Value Source which wraps a copy of the Attributes wrapped in this Ambient Light Value Source.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.