Package org.dcm4che.typeddicom.dataelements

Class ContrastFrameAveraging

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ContrastFrameAveraging

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class ContrastFrameAveraging
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Contrast Frame Averaging
Keyword: ContrastFrameAveraging
Tag: (0028,6112)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • Presentation State Mask Module > Mask Subtraction Sequence > Contrast Frame Averaging
  as follows:
  Attribute Name: Contrast Frame Averaging
  Type: 1C
  Attribute Description:

  Specified the number of contrast frames to average together before performing the mask operation.

  Required if Mask Frame Numbers (0028,6110) specifies more than one frame (i.e., is multi-valued).

  Note

  The requirement in this Module is conditional and overrides the optional requirements of the DICOM Standard Part 3 - Section C.7.6.10.

  
  
• Described in the contexts:
  • XA/XRF Presentation State Mask Module > Mask Subtraction Sequence > Contrast Frame Averaging
  • Mask Module > Mask Subtraction Sequence > Contrast Frame Averaging
  as follows:
  Attribute Name: Contrast Frame Averaging
  Type: 3
  Attribute Description:

  Specifies the number of contrast frames to average together before performing the mask operation. If the Attribute is missing, no averaging is performed.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

ContrastFrameAveraging

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

Creates a new Contrast Frame Averaging object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ContrastFrameAveraging

public ContrastFrameAveraging()

Creates a new Contrast Frame Averaging object which wraps a new and empty Attributes object.

Method Details

copy

public ContrastFrameAveraging copy()

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

Returns:

a new Contrast Frame Averaging which wraps a copy of the Attributes wrapped in this Contrast Frame Averaging.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.