Package org.dcm4che.typeddicom.dataelements

Class SubtractionItemID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SubtractionItemID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class SubtractionItemID
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Subtraction Item ID
Keyword: SubtractionItemID
Tag: (0028,9416)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • Frame Pixel Shift Macro > Frame Pixel Shift Sequence > Subtraction Item ID
  as follows:
  Attribute Name: Subtraction Item ID
  Type: 1
  Attribute Description:

  Identifier of the Subtraction Item in the Mask Subtraction Sequence (0028,6100) to which this pixel shift is associated.

  See DICOM Standard Part 3 - Section C.7.6.16.2.14.1.

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

  Identification of the Subtraction Item used to associate a certain Mask Sub-Pixel Shift (0028,6114) in the Frame Pixel Shift Functional Group.

  See DICOM Standard Part 3 - Section C.7.6.16.2.14.1.

  Required if SOP Class UID (0008,0016) equals "1.2.840.10008.5.1.4.1.1.12.1.1" or "1.2.840.10008.5.1.4.1.1.12.2.1". May be present otherwise.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SubtractionItemID.Builder<SELF extends SubtractionItemID.Builder<SELF,T>,T extends SubtractionItemID.Holder>
static interface	SubtractionItemID.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Subtraction Item ID" (see SubtractionItemID)
static class	SubtractionItemID.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 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.UnsignedShortWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
SubtractionItemID()	Creates a new Subtraction Item ID object which wraps a new and empty Attributes object.
SubtractionItemID(org.dcm4che3.data.Attributes attributes)	Creates a new Subtraction Item ID object which wraps the provided attributes.

Method Summary

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

getInt, setInt

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

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

SubtractionItemID

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

Creates a new Subtraction Item ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

SubtractionItemID

public SubtractionItemID()

Creates a new Subtraction Item ID object which wraps a new and empty Attributes object.

Method Details

copy

public SubtractionItemID copy()

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

Returns:

a new Subtraction Item ID which wraps a copy of the Attributes wrapped in this Subtraction Item ID.

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.