Package org.dcm4che.typeddicom.dataelements

Class NumberOfFrames

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.NumberOfFrames

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper, IntegerStringWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

public class NumberOfFrames
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Number of Frames
Keyword: NumberOfFrames
Tag: (0028,0008)
Value Representation: IntegerString
Value Multiplicity: 1

• Described in the contexts:
  • Inventory Module > Inventoried Studies Sequence > Inventoried Series Sequence > Inventoried Instances Sequence > Number of Frames
  as follows:
  Attribute Name: Number of Frames
  Type: 3
  Attribute Description:

  Number of frames in the inventoried Image SOP Instance.

  
  
• Described in the contexts:
  • ROI Contour Module > ROI Contour Sequence > Source Pixel Planes Characteristics Sequence > Number of Frames
  as follows:
  Attribute Name: Number of Frames
  Type: 1
  Attribute Description:

  Number of source pixel planes.

  
  
• Described in the contexts:
  • Whole Slide Microscopy Image Module > Number of Frames
  as follows:
  Attribute Name: Number of Frames
  Type: 1
  Attribute Description:

  Number of frames in a multi-frame image.

  Enumerated Values if Image Type (0008,0008) Value 3 is THUMBNAIL, LABEL or OVERVIEW:

  1

  Note

  This Enumerated Value of 1 previously applied to Image Type (0008,0008) Value 3 of LOCALIZER, which has been retired. See http://dicom.nema.org/medical/dicom/2021c/output/pdf/part03.pdfPS3.3-2021c.

  
  
• Described in the contexts:
  • Multi-frame Module > Number of Frames
  as follows:
  Attribute Name: Number of Frames
  Type: 1
  Attribute Description:

  Number of frames in a Multi-frame Image. See DICOM Standard Part 3 - Section C.7.6.6.1.1 for further explanation.

  
  
• Described in the contexts:
  • Multi-frame Functional Groups Module > Number of Frames
  • Sparse Multi-frame Functional Groups Module > Number of Frames
  as follows:
  Attribute Name: Number of Frames
  Type: 1
  Attribute Description:

  Number of frames in a multi-frame image. See DICOM Standard Part 3 - Section C.7.6.6.1.1 for further explanation.

  
  

Nested Class Summary

Nested Classes

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

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

IntegerStringWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends IntegerStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.IntegerStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
NumberOfFrames()	Creates a new Number of Frames object which wraps a new and empty Attributes object.
NumberOfFrames(org.dcm4che3.data.Attributes attributes)	Creates a new Number of Frames object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
NumberOfFrames	copy()	Returns a new Number of Frames which wraps a copy of the Attributes wrapped in this Number of Frames.
java.lang.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, getKnownAttributeTags, getUnknownAttributeTags, 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.IntegerStringWrapper

getValueRepresentation

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

getString, setString

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

NumberOfFrames

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

Creates a new Number of Frames object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

NumberOfFrames

public NumberOfFrames()

Creates a new Number of Frames object which wraps a new and empty Attributes object.

Method Detail

copy

public NumberOfFrames copy()

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

Returns:

a new Number of Frames which wraps a copy of the Attributes wrapped in this Number of Frames.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper