Package org.dcm4che.typeddicom.dataelements

Class ROIPhysicalProperty

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ROIPhysicalProperty

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class ROIPhysicalProperty
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: ROI Physical Property
Keyword: ROIPhysicalProperty
Tag: (3006,00B2)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT ROI Observations Module > RT ROI Observations Sequence > ROI Physical Properties Sequence > ROI Physical Property
  as follows:
  Attribute Name: ROI Physical Property
  Type: 1
  Attribute Description:

  Physical property specified by ROI Physical Property Value (3006,00B4).

  Defined Terms:

  REL_MASS_DENSITY

  mass density relative to water

  REL_ELEC_DENSITY

  electron density relative to water

  EFFECTIVE_Z

  effective atomic number

  EFF_Z_PER_A

  ratio of effective atomic number to mass (AMU^-1)

  REL_STOP_RATIO

  ratio of linear stopping power of material relative to linear stopping power of water

  ELEM_FRACTION

  elemental composition of the material

  MEAN_EXCI_ENERGY

  Mean Excitation Energy of the material (eV)

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ROIPhysicalProperty()	Creates a new ROI Physical Property object which wraps a new and empty Attributes object.
ROIPhysicalProperty(org.dcm4che3.data.Attributes attributes)	Creates a new ROI Physical Property object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ROIPhysicalProperty	copy()	Returns a new ROI Physical Property which wraps a copy of the Attributes wrapped in this ROI Physical Property.
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.valuerepresentations.CodeStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

ROIPhysicalProperty

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

Creates a new ROI Physical Property object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ROIPhysicalProperty

public ROIPhysicalProperty()

Creates a new ROI Physical Property object which wraps a new and empty Attributes object.

Method Details

copy

public ROIPhysicalProperty copy()

Returns a new ROI Physical Property which wraps a copy of the Attributes wrapped in this ROI Physical Property. (see Attributes(Attributes)

Returns:

a new ROI Physical Property which wraps a copy of the Attributes wrapped in this ROI Physical Property.

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.