Package org.dcm4che.typeddicom.dataelements

Class RelativeOpacity

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RelativeOpacity

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointSingleWrapper

public class RelativeOpacity
extends AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Relative Opacity
Keyword: RelativeOpacity
Tag: (0070,0403)
Value Representation: FL
Value Multiplicity: 1

• Described in the contexts:
  • Presentation State Blending Module > Relative Opacity
  as follows:
  Attribute Name: Relative Opacity
  Type: 1
  Attribute Description:

  A value from 0.0 to 1.0 indicating the relative opacity of the pixels of the superimposed image, where 1.0 means that pixels of the superimposed image completely replace the pixels of the underlying image, and 0.0 means that the pixels of the underlying image completely replace the pixels of the superimposed image.

  See PS3.4 PS3.4 for a detailed description of the blending operation.

  
  
• Described in the contexts:
  • Advanced Blending Presentation State Display Module > Blending Display Sequence > Relative Opacity
  as follows:
  Attribute Name: Relative Opacity
  Type: 1C
  Attribute Description:

  Specifies Relative Opacity for the visible pixels of the set referenced by the first Blending Input Number (0070,1B02)

  Required if Blending Mode (0070,1B06) is equal to FOREGROUND

  
  

Nested Class Summary

Nested Classes

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

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

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

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.FloatingPointSingleWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

exists, getValue

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

getDouble, setDouble

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

getFloat, setFloat

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

getValueRepresentation

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

RelativeOpacity

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

Creates a new Relative Opacity object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RelativeOpacity

public RelativeOpacity()

Creates a new Relative Opacity object which wraps a new and empty Attributes object.

Method Details

copy

public RelativeOpacity copy()

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

Returns:

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

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.