Package org.dcm4che.typeddicom.dataelements

Class PlaneIdentification

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PlaneIdentification

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class PlaneIdentification
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Plane Identification
Keyword: PlaneIdentification
Tag: (0018,9457)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Performed XA Acquisition Module > Acquisition Protocol Element Sequence > XA Plane Details Sequence > Plane Identification
  as follows:
  Attribute Name: Plane Identification
  Type: 1
  Attribute Description:

  Identification of the plane to which the parameters of this sequence item applies.

  Defined Terms:

  MONOPLANE

  PLANE A

  PLANE B

  
  
• Described in the contexts:
  • X-Ray 3D Angiographic Image Contributing Sources Module > Contributing Sources Sequence > Plane Identification
  as follows:
  Attribute Name: Plane Identification
  Type: 1C
  Attribute Description:

  Identification of the plane used to acquire this image.

  Defined Terms:

  MONOPLANE

  PLANE A

  PLANE B

  Required if present and consistent in the contributing SOP Instances.

  
  
• Described in the contexts:
  • Enhanced XA/XRF Image Module Table > Plane Identification
  as follows:
  Attribute Name: Plane Identification
  Type: 1C
  Attribute Description:

  Identification of the plane used to acquire this image.

  Defined Terms:

  MONOPLANE

  PLANE A

  PLANE B

  Note

  1. MONOPLANE is only permitted to be used for a single plane system

  2. PLANE A and PLANE B must be used for two plane systems, independent if the acquisition is single plane or biplane.

  3. The value has to be in accordance with the value of Planes in Acquisition (0018,9410). If this value is SINGLE PLANE all three Defined Term are applicable.

  Required if Planes in Acquisition (0018,9410) is not equal to UNDEFINED.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

PlaneIdentification

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

Creates a new Plane Identification object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

PlaneIdentification

public PlaneIdentification()

Creates a new Plane Identification object which wraps a new and empty Attributes object.

Method Details

copy

public PlaneIdentification copy()

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

Returns:

a new Plane Identification which wraps a copy of the Attributes wrapped in this Plane Identification.

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.