Package org.dcm4che.typeddicom.dataelements

Class VolumeToTransducerRelationship

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.VolumeToTransducerRelationship

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class VolumeToTransducerRelationship
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Volume to Transducer Relationship
Keyword: VolumeToTransducerRelationship
Tag: (0020,930B)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Ultrasound Frame of Reference Module > Volume to Transducer Relationship
  as follows:
  Attribute Name: Volume to Transducer Relationship
  Type: 1C
  Attribute Description:

  Relationship between the transducer and the acquired volume.

  Enumerated Values:

  FIXED

  The transducer position and orientation relative to the volume is constant and specified by Volume to Transducer Mapping Matrix (0020,9309).

  POSITION_VAR

  The transducer position relative to the volume varies during acquisition and the position specified by Volume to Transducer Mapping Matrix (0020,9309) is a nominal value. The transducer orientation relative to the volume is constant and specified by Volume to Transducer Mapping Matrix (0020,9309).

  ORIENTATION_VAR

  The transducer orientation relative to the volume varies during acquisition and the orientation specified by Volume to Transducer Mapping Matrix (0020,9309) is a nominal value. The transducer position relative to the volume is constant and specified by Volume to Transducer Mapping Matrix (0020,9309).

  VARIABLE

  The transducer position and orientation relative to the volume varies during acquisition and the position and orientation specified by Volume to Transducer Mapping Matrix (0020,9309) are nominal.

  Required if the transducer position and/or orientation relative to the volume is not constant. May be present otherwise.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
VolumeToTransducerRelationship	copy()	Returns a new Volume to Transducer Relationship which wraps a copy of the Attributes wrapped in this Volume to Transducer Relationship.
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

VolumeToTransducerRelationship

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

Creates a new Volume to Transducer Relationship object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

VolumeToTransducerRelationship

public VolumeToTransducerRelationship()

Creates a new Volume to Transducer Relationship object which wraps a new and empty Attributes object.

Method Details

copy

public VolumeToTransducerRelationship copy()

Returns a new Volume to Transducer Relationship which wraps a copy of the Attributes wrapped in this Volume to Transducer Relationship. (see Attributes(Attributes)

Returns:

a new Volume to Transducer Relationship which wraps a copy of the Attributes wrapped in this Volume to Transducer Relationship.

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.