Package org.dcm4che.typeddicom.dataelements

Class FrameLabelVector

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FrameLabelVector

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringMultiWrapper, StringDataElementMultiWrapper

public class FrameLabelVector
extends AbstractDataElementWrapper
implements ShortStringMultiWrapper

Name: Frame Label Vector
Keyword: FrameLabelVector
Tag: (0018,2002)
Value Representation: SH
Value Multiplicity: 1-n

• Described in the contexts:
  • X-Ray Image Module > Frame Label Vector
  as follows:
  Attribute Name: Frame Label Vector
  Type: 3
  Attribute Description:

  A multi-valued Attribute that contains a descriptive label for each of the image frames. The number of values shall equal the number of frames.

  
  
• Described in the contexts:
  • SC Multi-frame Vector Module > Frame Label Vector
  as follows:
  Attribute Name: Frame Label Vector
  Type: 1C
  Attribute Description:

  An array that contains, for each of the image frames, a descriptive label.

  Required if Frame Increment Pointer (0028,0009) points to Frame Label Vector (0018,2002).

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getValueRepresentation

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

getString, getString, getStrings, setStrings

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

FrameLabelVector

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

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

Parameters:

attributes - The Attributes object to be wrapped.

FrameLabelVector

public FrameLabelVector()

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

Method Details

copy

public FrameLabelVector copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.