.. _RawFormatOpenOptions:

================================================
RawFormatOpenOptions
================================================


Description
-----------

Options that can be specified when opening a document in RAW format.






Static Properties
^^^^^^^^^^^^^^^^^

+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bitsPerChannel<RawFormatOpenOptions.bitsPerChannel>` readonly         | The number of bits for each channel. Valid values: 8 or 16.                                                                                                                                                       |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`byteOrder<RawFormatOpenOptions.byteOrder>` readonly                   | The order in which bytes will be read. Valid only when 'bits per channel' = 16.                                                                                                                                   |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`channelNumber<RawFormatOpenOptions.channelNumber>` readonly           | The number of channels in the image. Valid only when 'bits per channel' = 16. Range: 1 to 56.                                                                                                                     |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`headerSize<RawFormatOpenOptions.headerSize>` readonly                 | The number of bytes of information that will appear in the file before actual image information begins; that is, the number of zeroes inserted at the beginning of the file as placeholders. Range: 0 to 1919999. |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`height<RawFormatOpenOptions.height>` readonly                         | The image height (in pixels)                                                                                                                                                                                      |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`interleaveChannels<RawFormatOpenOptions.interleaveChannels>` readonly | If true, color values are stored sequentially.                                                                                                                                                                    |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`retainHeader<RawFormatOpenOptions.retainHeader>` readonly             | If true, the header is retained when saving.                                                                                                                                                                      |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`width<RawFormatOpenOptions.width>` readonly                           | The image width (in pixels)                                                                                                                                                                                       |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+












.. container:: hide

   .. toctree::
      :hidden:
      :maxdepth: 1

      
      RawFormatOpenOptions/height.rst
      RawFormatOpenOptions/width.rst
      RawFormatOpenOptions/channelNumber.rst
      RawFormatOpenOptions/interleaveChannels.rst
      RawFormatOpenOptions/bitsPerChannel.rst
      RawFormatOpenOptions/byteOrder.rst
      RawFormatOpenOptions/headerSize.rst
      RawFormatOpenOptions/retainHeader.rst