Package org.dcm4che.typeddicom.dataelements

Class FocalDistance

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FocalDistance

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementMultiWrapper, IntegerStringMultiWrapper, StringDataElementMultiWrapper

public class FocalDistance
extends AbstractDataElementWrapper
implements IntegerStringMultiWrapper

Name: Focal Distance
Keyword: FocalDistance
Tag: (0018,1182)
Value Representation: IS
Value Multiplicity: 1-2

• Described in the contexts:
  • NM Detector Module > Detector Information Sequence > Focal Distance
  as follows:
  Attribute Name: Focal Distance
  Type: 2
  Attribute Description:

  Focal distance, in mm. A value of 0 means infinite distance for parallel collimation. See DICOM Standard Part 3 - Section C.8.4.11.1.1 for further specialization.

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.IntegerStringMultiWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
FocalDistance()	Creates a new Focal Distance object which wraps a new and empty Attributes object.
FocalDistance(org.dcm4che3.data.Attributes attributes)	Creates a new Focal Distance object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
FocalDistance	copy()	Returns a new Focal Distance which wraps a copy of the Attributes wrapped in this Focal Distance.
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, getPrivateCreator, getValue

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

getInt, getInts, setInts

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

getValueRepresentation

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

getString, getString, getStrings, setStrings

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

FocalDistance

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

Creates a new Focal Distance object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

FocalDistance

public FocalDistance()

Creates a new Focal Distance object which wraps a new and empty Attributes object.

Method Details

copy

public FocalDistance copy()

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

Returns:

a new Focal Distance which wraps a copy of the Attributes wrapped in this Focal Distance.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.