Package org.dcm4che.typeddicom.dataelements

Class MaskFrameNumbers

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.MaskFrameNumbers

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementMultiWrapper, UnsignedShortMultiWrapper

public class MaskFrameNumbers
extends AbstractDataElementWrapper
implements UnsignedShortMultiWrapper

Name: Mask Frame Numbers
Keyword: MaskFrameNumbers
Tag: (0028,6110)
Value Representation: US
Value Multiplicity: 1-n

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

  Specifies the frame numbers of the pixel data used to generate this mask. Frames in a Multi-frame Image are specified by sequentially increasing number values beginning with 1. Required if Mask Operation (0028,6101) is AVG_SUB.

  
  
• Described in the contexts:
  • XA/XRF Presentation State Mask Module > Mask Subtraction Sequence > Mask Frame Numbers
  as follows:
  Attribute Name: Mask Frame Numbers
  Type: 1C
  Attribute Description:

  Specifies the frame numbers of the pixel data used to generate this mask. Frames in a Multi-frame Image are specified by sequentially increasing number values beginning with 1. Required if the Mask Operation (0028,6101) is AVG_SUB.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
MaskFrameNumbers()	Creates a new Mask Frame Numbers object which wraps a new and empty Attributes object.
MaskFrameNumbers(org.dcm4che3.data.Attributes attributes)	Creates a new Mask Frame Numbers object which wraps the provided attributes.

Method Summary

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

getInt, getInts, setInts

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

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

MaskFrameNumbers

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

Creates a new Mask Frame Numbers object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

MaskFrameNumbers

public MaskFrameNumbers()

Creates a new Mask Frame Numbers object which wraps a new and empty Attributes object.

Method Details

copy

public MaskFrameNumbers copy()

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

Returns:

a new Mask Frame Numbers which wraps a copy of the Attributes wrapped in this Mask Frame Numbers.

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.