.. _recordstream:

Record Stream
=============

Records (grabs) data from an image stream.

Input
-----

The algorithm requires exactly one ImageStream as input.

Output
------

For each recording, a set of 2D images is produced.

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

After clicking **Record**, the algorithm will start accumulating (copying) incoming 2D images in memory. After clicking **Stop**, the set of 2D images becomes available in the data widget.

The algorithm allows setting the following parameters:

* ``Time limit``: defines the maximum recording time. Default is none.
* ``Samples limit``: defines the maximum number of recorded images. Default is none.
* ``Memory limit``: defines the maximum fraction of RAM to be exhausted before recording stops automatically. Default is 90%.