Package org.dcm4che.typeddicom.dataelements

Class FrameLaterality

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FrameLaterality

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class FrameLaterality
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Frame Laterality
Keyword: FrameLaterality
Tag: (0020,9072)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Frame Anatomy Macro > Frame Anatomy Sequence > Frame Laterality
  as follows:
  Attribute Name: Frame Laterality
  Type: 1
  Attribute Description:

  Laterality of (possibly paired) body parts (as described in Anatomic Region Sequence (0008,2218)) examined.

  Enumerated Values:

  R

  right

  L

  left

  U

  unpaired

  B

  both left and right

  Note

  This Attribute is mandatory, in order to ensure that frames maybe positioned correctly relative to one another for display.

  Shall be consistent with any laterality information contained in Primary Anatomic Structure Modifier Sequence (0008,2230), if present.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

FrameLaterality

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

Creates a new Frame Laterality object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

FrameLaterality

public FrameLaterality()

Creates a new Frame Laterality object which wraps a new and empty Attributes object.

Method Details

copy

public FrameLaterality copy()

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

Returns:

a new Frame Laterality which wraps a copy of the Attributes wrapped in this Frame Laterality.

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.