Package org.dcm4che.typeddicom.dataelements

Class RecommendedDisplayFrameRate

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RecommendedDisplayFrameRate

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class RecommendedDisplayFrameRate
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Recommended Display Frame Rate
Keyword: RecommendedDisplayFrameRate
Tag: (0008,2144)
Value Representation: IS
Value Multiplicity: 1

• Described in the contexts:
  • Intravascular OCT Image Module > Recommended Display Frame Rate
  as follows:
  Attribute Name: Recommended Display Frame Rate
  Type: 3
  Attribute Description:

  Recommended rate at which the frames of an Intravascular OCT image should be displayed in frames/second.

  
  
• Described in the contexts:
  • Cine Module > Recommended Display Frame Rate
  as follows:
  Attribute Name: Recommended Display Frame Rate
  Type: 3
  Attribute Description:

  Recommended rate at which the frames of a Multi-frame image should be displayed in frames/second.

  
  
• Described in the contexts:
  • Hanging Protocol Display Module > Display Sets Sequence > Image Boxes Sequence > Recommended Display Frame Rate
  • Structured Display Image Box Module > Structured Display Image Box Sequence > Recommended Display Frame Rate
  as follows:
  Attribute Name: Recommended Display Frame Rate
  Type: 1C
  Attribute Description:

  Recommended rate at which the frames of a multi-frame image shall be displayed, in frames/second. Shall have a value greater than zero. Overrides any Recommended Display Frame Rate (0008,2144) value in the image objects being displayed.

  Required if the value of Image Box Layout Type (0072,0304) is CINE and if Cine Relative to Real-Time (0072,0330) is not present.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
RecommendedDisplayFrameRate()	Creates a new Recommended Display Frame Rate object which wraps a new and empty Attributes object.
RecommendedDisplayFrameRate(org.dcm4che3.data.Attributes attributes)	Creates a new Recommended Display Frame Rate object which wraps the provided attributes.

Method Summary

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

RecommendedDisplayFrameRate

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

Creates a new Recommended Display Frame Rate object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RecommendedDisplayFrameRate

public RecommendedDisplayFrameRate()

Creates a new Recommended Display Frame Rate object which wraps a new and empty Attributes object.

Method Details

copy

public RecommendedDisplayFrameRate copy()

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

Returns:

a new Recommended Display Frame Rate which wraps a copy of the Attributes wrapped in this Recommended Display Frame Rate.

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.