.. _mean:

mean
****


**Syntax:** :code:`mean(input image, output image, print to log)`

Calculates mean of all pixels in the input image. The output is a 1x1x1 image.

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

Input image.

output image [output]
~~~~~~~~~~~~~~~~~~~~~

**Data type:** float32 image

Output image.

print to log [input]
~~~~~~~~~~~~~~~~~~~~

**Data type:** boolean

**Default value:** False

Set to true to print the results to the log.