.. _writeraw:

writeraw
********

There are 2 forms of this command.

:code:`writeraw(input image, filename, append)`
===============================================

Write an image to .raw file. The dimensions of the image are automatically appended to the file name. If distributed processing is enabled, uses optimized implementation that does not need to copy or write any image data if the image is saved to a temporary image storage location and that location is on the same partition than the file being written.

This command can be used in the distributed processing mode. Use :ref:`distribute` command to change processing mode from local to distributed.

Arguments
---------

input image [input]
~~~~~~~~~~~~~~~~~~~

**Data type:** uint8 image, uint16 image, uint32 image, uint64 image, int8 image, int16 image, int32 image, int64 image, float32 image, complex32 image

Image to save.

filename [input]
~~~~~~~~~~~~~~~~

**Data type:** string

Name (and path) of the file to write. If the file exists, its current contents are erased (unless append parameter is set to true).

append [input]
~~~~~~~~~~~~~~

**Data type:** boolean

**Default value:** False

Set to true to append to existing .raw file. This parameter must be set to false in distributed mode.


:code:`writeraw(r, g, b, filename, append)`
===========================================

Writes an RGB image to a .raw file. The dimensions of the image are automatically appended to the file name.

This command cannot be used in the distributed processing mode. If you need it, please contact the authors.

Arguments
---------

r [input]
~~~~~~~~~

**Data type:** uint8 image

Red component image.

g [input]
~~~~~~~~~

**Data type:** uint8 image

Green component image.

b [input]
~~~~~~~~~

**Data type:** uint8 image

Blue component image.

filename [input]
~~~~~~~~~~~~~~~~

**Data type:** string

Name (and path) of the file to write. If the file exists, its current contents are erased (unless append parameter is set to true).

append [input]
~~~~~~~~~~~~~~

**Data type:** boolean

**Default value:** False

Set to true to append to existing .raw file.