DicomObjects.NET Core Documentation
DicomObjects Namespace / DicomDataSet Class / SetPlanarConfiguration Method

The enumerated value to be set for planar configuration attribute (0028, 0006)




In This Topic
    SetPlanarConfiguration Method
    In This Topic
    Sets the planar configuration in DicomDataSet
    Syntax
    'Declaration
     
    
    Public Sub SetPlanarConfiguration( _
       ByVal Value As Integer _
    ) 
    'Usage
     
    
    Dim instance As DicomDataSet
    Dim Value As Integer
     
    instance.SetPlanarConfiguration(Value)
    public void SetPlanarConfiguration( 
       int Value
    )
    public:
    void SetPlanarConfiguration( 
       int Value
    ) 

    Parameters

    Value

    The enumerated value to be set for planar configuration attribute (0028, 0006)

    Remarks

    Planar Configuration indicates whether the color pixel data are sent color-by-color or color-by-pixel. This element shall be present if Samples per Pixel (0028, 0002) has a value greater than 1. It shall not be present otherwise.

    This method removes Planar Configuration (0028, 0006) from dataset if it has only 1 plane, otherwise it sets Planar Configuration to the value provided.

    Enumerated Values for Planar Configuration are:

    • 0 = The sample values for the first pixel are followed by the sample values for the second pixel, etc. For RGB images, this means the order of the pixel values sent shall be R1, G1, B1, R2, G2, B2, ..., etc.
    • 1 = Each color place shall be sent contiguously. For RGB images, this means the order of the pixel values sent is R1, R2, R3, ..., G1, G2, G3, ..., B1, B2, B3, etc.

    Planar Configuration is not meaningful when a compression transfer syntax is used that involves reorganization of sample components in the compressed bit stream. In such cases, since the data element is required to be sent, then an appropriate value to use may be specified, though in all likelihood the value will be ignored by the receiving implementation.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also