Package org.dcm4che.typeddicom.dataelements

Class FrameNumbersOfInterest

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FrameNumbersOfInterest

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementMultiWrapper, UnsignedShortMultiWrapper

public class FrameNumbersOfInterest
extends AbstractDataElementWrapper
implements UnsignedShortMultiWrapper

Name: Frame Numbers of Interest (FOI)
Keyword: FrameNumbersOfInterest
Tag: (0028,6020)
Value Representation: US
Value Multiplicity: 1-n

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

  Frame number(s) selected as frames of interest. A frame number may appear more than once.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getInt, getInts, setInts

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

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

FrameNumbersOfInterest

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

Creates a new Frame Numbers of Interest (FOI) object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

FrameNumbersOfInterest

public FrameNumbersOfInterest()

Creates a new Frame Numbers of Interest (FOI) object which wraps a new and empty Attributes object.

Method Details

copy

public FrameNumbersOfInterest copy()

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

Returns:

a new Frame Numbers of Interest (FOI) which wraps a copy of the Attributes wrapped in this Frame Numbers of Interest (FOI).

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.