Package org.dcm4che.typeddicom.dataelements

Class EntranceDose

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.EntranceDose

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class EntranceDose
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Entrance Dose
Keyword: EntranceDose
Tag: (0040,0302)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • X-Ray Acquisition Dose Module > Entrance Dose
  as follows:
  Attribute Name: Entrance Dose
  Type: 3
  Attribute Description:

  Average entrance dose value measured in dGy at the surface of the patient during the acquisition of this image.

  Note

  This may be an estimated value based on assumptions about the patient's body size and habitus.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
EntranceDose()	Creates a new Entrance Dose object which wraps a new and empty Attributes object.
EntranceDose(org.dcm4che3.data.Attributes attributes)	Creates a new Entrance Dose object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
EntranceDose	copy()	Returns a new Entrance Dose which wraps a copy of the Attributes wrapped in this Entrance Dose.
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.UnsignedShortWrapper

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

EntranceDose

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

Creates a new Entrance Dose object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

EntranceDose

public EntranceDose()

Creates a new Entrance Dose object which wraps a new and empty Attributes object.

Method Details

copy

public EntranceDose copy()

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

Returns:

a new Entrance Dose which wraps a copy of the Attributes wrapped in this Entrance Dose.

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.