Package org.dcm4che.typeddicom.dataelements

Class WhiteBalance

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.WhiteBalance

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class WhiteBalance
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: White Balance
Keyword: WhiteBalance
Tag: (0016,0043)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • VL Photographic Acquisition Module > White Balance
  as follows:
  Attribute Name: White Balance
  Type: 3
  Attribute Description:

  The white balance mode set when the image was shot.

  Defined Terms:

  0

  Auto white balance

  1

  Manual white balance

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
WhiteBalance	copy()	Returns a new White Balance which wraps a copy of the Attributes wrapped in this White Balance.
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.DataElementWrapper

exists, getPrivateCreator, getValue

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

getInt, setInt

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

getValueRepresentation

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

WhiteBalance

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

Creates a new White Balance object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

WhiteBalance

public WhiteBalance()

Creates a new White Balance object which wraps a new and empty Attributes object.

Method Details

copy

public WhiteBalance copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.