Package org.dcm4che.typeddicom.dataelements

Class FrameLabel

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FrameLabel

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class FrameLabel
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Frame Label
Keyword: FrameLabel
Tag: (0020,9453)
Value Representation: LO
Value Multiplicity: 1

• Described in the contexts:
  • Frame Content Macro > Frame Content Sequence > Frame Label
  as follows:
  Attribute Name: Frame Label
  Type: 3
  Attribute Description:

  Label corresponding to a specific dimension index value. Selected from a set of dimension values defined by the application.

  This Attribute may be referenced by the Dimension Index Pointer (0020,9165) Attribute in the DICOM Standard Part 3 - Section C.7.6.17.

  See DICOM Standard Part 3 - Section C.7.6.16.2.2.5 for further explanation.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getValueRepresentation

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

getString, setString

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

FrameLabel

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

Creates a new Frame Label object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

FrameLabel

public FrameLabel()

Creates a new Frame Label object which wraps a new and empty Attributes object.

Method Details

copy

public FrameLabel copy()

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

Returns:

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

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.