Package org.dcm4che.typeddicom.dataelements

Class EnergyWeightingFactor

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.EnergyWeightingFactor

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointSingleWrapper

public class EnergyWeightingFactor
extends AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Energy Weighting Factor
Keyword: EnergyWeightingFactor
Tag: (0018,9353)
Value Representation: FL
Value Multiplicity: 1

• Described in the contexts:
  • CT Image Module > CT Additional X-Ray Source Sequence > Energy Weighting Factor
  as follows:
  Attribute Name: Energy Weighting Factor
  Type: 1C
  Attribute Description:

  The weighting factor of the data from this additional source in a multiple energy composition image. This factor incorporates the effects of

  • the specific X-Ray source and kV value

  • examination specific characteristics.

  Required if one Derivation Code Sequence (0008,9215) Item value is PS3.16 DCM113097(113097, DCM, "Multi-energy proportional weighting"). May be present otherwise.

  
  
• Described in the contexts:
  • CT Image Module > Energy Weighting Factor
  as follows:
  Attribute Name: Energy Weighting Factor
  Type: 1C
  Attribute Description:

  The weighting factor of the data from the primary source in a multiple energy composition image. This factor incorporates the effects of

  • the specific X-Ray source and kV value

  • examination specific characteristics.

  Required if one Derivation Code Sequence (0008,9215) Item value is PS3.16 DCM113097(113097, DCM, "Multi-energy proportional weighting"). May be present otherwise.

  
  
• Described in the contexts:
  • CT X-Ray Details Macro > CT X-Ray Details Sequence > Energy Weighting Factor
  as follows:
  Attribute Name: Energy Weighting Factor
  Type: 1C
  Attribute Description:

  The weighting factor of the data from this Sequence Item.

  Required if Required if Frame Type (0008,9007) Value 4 of this frame is ENERGY_PROP_WT or Image Type (0008,0008) Value 4 is ENERGY_PROP_WT. May be present otherwise.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
EnergyWeightingFactor()	Creates a new Energy Weighting Factor object which wraps a new and empty Attributes object.
EnergyWeightingFactor(org.dcm4che3.data.Attributes attributes)	Creates a new Energy Weighting Factor object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
EnergyWeightingFactor	copy()	Returns a new Energy Weighting Factor which wraps a copy of the Attributes wrapped in this Energy Weighting Factor.
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.DoubleDataElementWrapper

getDouble, setDouble

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

getFloat, setFloat

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

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

EnergyWeightingFactor

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

Creates a new Energy Weighting Factor object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

EnergyWeightingFactor

public EnergyWeightingFactor()

Creates a new Energy Weighting Factor object which wraps a new and empty Attributes object.

Method Details

copy

public EnergyWeightingFactor copy()

Returns a new Energy Weighting Factor which wraps a copy of the Attributes wrapped in this Energy Weighting Factor. (see Attributes(Attributes)

Returns:

a new Energy Weighting Factor which wraps a copy of the Attributes wrapped in this Energy Weighting Factor.

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.