Package org.dcm4che.typeddicom.dataelements

Class HeartRate

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.HeartRate

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class HeartRate
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Heart Rate
Keyword: HeartRate
Tag: (0018,1088)
Value Representation: IS
Value Multiplicity: 1

• Described in the contexts:
  • NM Multi-Gated Acquisition Module > Heart Rate
  as follows:
  Attribute Name: Heart Rate
  Type: 3
  Attribute Description:

  Average number of heart beats per minute for the collection period for these frames. This shall include all accepted beats as well as rejected beats.

  
  
• Described in the contexts:
  • US Image Module > Heart Rate
  • MR Image Module > Heart Rate
  as follows:
  Attribute Name: Heart Rate
  Type: 3
  Attribute Description:

  Beats per minute.

  
  
• Described in the contexts:
  • PET Multi-Gated Acquisition Module > Heart Rate
  as follows:
  Attribute Name: Heart Rate
  Type: 3
  Attribute Description:

  Average number of heart beats per minute for the collection period for this image. This shall include all accepted beats as well as rejected beats.

  
  
• Described in the contexts:
  • Cardiac Synchronization Macro > Cardiac Synchronization Sequence > Heart Rate
  as follows:
  Attribute Name: Heart Rate
  Type: 3
  Attribute Description:

  Average number of heart beats per minute for the collection period for this frame. This shall include all accepted beats as well as rejected beats.

  Note

  During prolonged acquisitions the average heart rate may differ from the reciprocal of the nominal R-R interval.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HeartRate.Builder<SELF extends HeartRate.Builder<SELF,T>,T extends HeartRate.Holder>
static interface	HeartRate.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Heart Rate" (see HeartRate)
static class	HeartRate.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
HeartRate()	Creates a new Heart Rate object which wraps a new and empty Attributes object.
HeartRate(org.dcm4che3.data.Attributes attributes)	Creates a new Heart Rate object which wraps the provided attributes.

Method Summary

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

HeartRate

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

Creates a new Heart Rate object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

HeartRate

public HeartRate()

Creates a new Heart Rate object which wraps a new and empty Attributes object.

Method Details

copy

public HeartRate copy()

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

Returns:

a new Heart Rate which wraps a copy of the Attributes wrapped in this Heart 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.