Package org.dcm4che.typeddicom.dataelements

Class FrameOfInterestDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FrameOfInterestDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringMultiWrapper, StringDataElementMultiWrapper

public class FrameOfInterestDescription
extends AbstractDataElementWrapper
implements LongStringMultiWrapper

Name: Frame of Interest Description
Keyword: FrameOfInterestDescription
Tag: (0028,6022)
Value Representation: LO
Value Multiplicity: 1-n

• Described in the contexts:
  • Frame Pointers Module > Frame Of Interest Description
  as follows:
  Attribute Name: Frame Of Interest Description
  Type: 3
  Attribute Description:

  Description of each one of the Frame(s) of Interest selected in (0028,6020). If multiple Frames of Interest are selected and this Attribute is used, it shall contain the same number of values as are in Frame Numbers of Interest (0028,6020).

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

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

FrameOfInterestDescription

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

Creates a new Frame of Interest Description object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

FrameOfInterestDescription

public FrameOfInterestDescription()

Creates a new Frame of Interest Description object which wraps a new and empty Attributes object.

Method Details

copy

public FrameOfInterestDescription copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.