Package org.dcm4che.typeddicom.dataelements

Class PatientFrameOfReferenceSource

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PatientFrameOfReferenceSource

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class PatientFrameOfReferenceSource
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Patient Frame of Reference Source
Keyword: PatientFrameOfReferenceSource
Tag: (0020,930C)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Ultrasound Frame of Reference Module > Patient Frame of Reference Source
  as follows:
  Attribute Name: Patient Frame of Reference Source
  Type: 1C
  Attribute Description:

  Indicates how the supplied Image Position (Patient) (0020,0032) and Image Orientation (Patient) (0020,0037) values are obtained.

  Enumerated Values:

  TABLE

  A positioning device, such as a gantry, was used to generate these values.

  ESTIMATED

  Estimated patient position / orientation (e.g., estimated by the user), or if reliable information is not available.

  REGISTRATION

  Acquisition has been spatially registered to a prior image set.

  Required if either Image Position (Patient) (0020,0032) or Image Orientation (Patient) (0020,0037) is present.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
PatientFrameOfReferenceSource	copy()	Returns a new Patient Frame of Reference Source which wraps a copy of the Attributes wrapped in this Patient Frame of Reference Source.
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

PatientFrameOfReferenceSource

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

Creates a new Patient Frame of Reference Source object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

PatientFrameOfReferenceSource

public PatientFrameOfReferenceSource()

Creates a new Patient Frame of Reference Source object which wraps a new and empty Attributes object.

Method Details

copy

public PatientFrameOfReferenceSource copy()

Returns a new Patient Frame of Reference Source which wraps a copy of the Attributes wrapped in this Patient Frame of Reference Source. (see Attributes(Attributes)

Returns:

a new Patient Frame of Reference Source which wraps a copy of the Attributes wrapped in this Patient Frame of Reference Source.

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.