Package org.dcm4che.typeddicom.dataelements

Class Saturation

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.Saturation

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class Saturation
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Saturation
Keyword: Saturation
Tag: (0016,0049)
Value Representation: US
Value Multiplicity: 1

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

  The direction of saturation processing applied by the camera.

  Defined Terms:

  0

  Normal

  1

  Low saturation

  2

  High saturation

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Saturation.Builder<SELF extends Saturation.Builder<SELF,T>,T extends Saturation.Holder>
static interface	Saturation.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Saturation" (see Saturation)
static class	Saturation.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
Saturation()	Creates a new Saturation object which wraps a new and empty Attributes object.
Saturation(org.dcm4che3.data.Attributes attributes)	Creates a new Saturation object which wraps the provided attributes.

Method Summary

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

Saturation

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

Creates a new Saturation object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

Saturation

public Saturation()

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

Method Details

copy

public Saturation copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.