Package org.dcm4che.typeddicom.dataelements

Class ImageFrameOrigin

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ImageFrameOrigin

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class ImageFrameOrigin
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Image Frame Origin
Keyword: ImageFrameOrigin
Tag: (60xx,0051)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • Multi-frame Overlay Module > Image Frame Origin
  as follows:
  Attribute Name: Image Frame Origin
  Type: 1C
  Attribute Description:

  Frame number of Multi-frame Image to which this Overlay applies; frames are numbered from 1.

  Required if the starting Image frame number to which this Multi-frame Overlay corresponds is not 1. May be present otherwise.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

ImageFrameOrigin

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

Creates a new Image Frame Origin object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ImageFrameOrigin

public ImageFrameOrigin()

Creates a new Image Frame Origin object which wraps a new and empty Attributes object.

Method Details

copy

public ImageFrameOrigin copy()

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

Returns:

a new Image Frame Origin which wraps a copy of the Attributes wrapped in this Image Frame Origin.

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.