Package org.dcm4che.typeddicom.dataelements

Class PlanarConfiguration

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PlanarConfiguration

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper, UnsignedShortWrapper

public class PlanarConfiguration
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Planar Configuration
Keyword: PlanarConfiguration
Tag: (0028,0006)
Value Representation: UnsignedShort
Value Multiplicity: 1

• Described in the contexts:
  • Whole Slide Microscopy Image Module > Planar Configuration
  as follows:
  Attribute Name: Planar Configuration
  Type: 1C
  Attribute Description:

  Indicates whether the pixel data are encoded color-by-plane or color-by-pixel. Required if Samples per Pixel (0028,0002) has a value greater than 1.

  Enumerated Values:

  0

  
  
• Described in the contexts:
  • Ophthalmic Photography Image Module > Planar Configuration
  as follows:
  Attribute Name: Planar Configuration
  Type: 1C
  Attribute Description:

  Indicates whether the pixel data are encoded color-by-plane or color-by-pixel.

  Required if Samples per Pixel (0028,0002) has a value greater than 1.

  Enumerated Values:

  0

  
  
• Described in the contexts:
  • Image Box Pixel Presentation Module > Basic Color Image Sequence > Planar Configuration
  as follows:
  Attribute Name: Planar Configuration
  Type:
  Attribute Description:

  See DICOM Standard Part 3 - Section C.7.6.3 for description.

  Enumerated Values:

  1

  
  
• Described in the contexts:
  • VL Image Module > Planar Configuration
  as follows:
  Attribute Name: Planar Configuration
  Type: 1C
  Attribute Description:

  Indicates whether the pixel data are encoded color-by-plane or color-by-pixel. Required if Samples per Pixel (0028,0002) has a value greater than 1.

  See DICOM Standard Part 3 - Section C.8.12.1.1.5 for specialization of this Attribute.

  
  
• Described in the contexts:
  • Image Pixel Description Macro > Planar Configuration
  as follows:
  Attribute Name: Planar Configuration
  Type: 1C
  Attribute Description:

  Indicates whether the pixel data are encoded color-by-plane or color-by-pixel. Required if Samples per Pixel (0028,0002) has a value greater than 1. See DICOM Standard Part 3 - Section C.7.6.3.1.3 for further explanation.

  
  
• Described in the contexts:
  • US Image Module > Planar Configuration
  as follows:
  Attribute Name: Planar Configuration
  Type: 1C
  Attribute Description:

  Indicates whether the pixel data are encoded color-by-plane or color-by-pixel.

  Required if Samples per Pixel (0028,0002) has a value greater than 1.

  See DICOM Standard Part 3 - Section C.8.5.6.1.16 for specialization.

  
  
• Described in the contexts:
  • Enhanced MR Image Module > Planar Configuration
  as follows:
  Attribute Name: Planar Configuration
  Type: 1C
  Attribute Description:

  Indicates whether the pixel data are encoded color-by-plane or color-by-pixel. Required if Samples per Pixel (0028,0002) has a value greater than 1. See DICOM Standard Part 3 - Section C.7.6.3.1.3 and DICOM Standard Part 3 - Section C.8.13.1.1.2 for further explanation.

  
  

Nested Class Summary

Nested Classes

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

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

UnsignedShortWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends UnsignedShortWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static int	TAG	The DICOM Tag associated with this class.

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
PlanarConfiguration()	Creates a new Planar Configuration object which wraps a new and empty Attributes object.
PlanarConfiguration(org.dcm4che3.data.Attributes attributes)	Creates a new Planar Configuration object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
PlanarConfiguration	copy()	Returns a new Planar Configuration which wraps a copy of the Attributes wrapped in this Planar Configuration.
java.lang.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.DataElementWrapper

exists, getValue

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

getInt, setInt

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

getValueRepresentation

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

PlanarConfiguration

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

Creates a new Planar Configuration object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

PlanarConfiguration

public PlanarConfiguration()

Creates a new Planar Configuration object which wraps a new and empty Attributes object.

Method Detail

copy

public PlanarConfiguration copy()

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

Returns:

a new Planar Configuration which wraps a copy of the Attributes wrapped in this Planar Configuration.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper