.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/04_demos/viz_streamlines_roi.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_auto_examples_04_demos_viz_streamlines_roi.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_04_demos_viz_streamlines_roi.py:


============================
Streamlines: Simple ROI Mask
============================

Build a small bundle of streamlines and a tiny ROI mask. Streamlines passing
through the ROI are blue; the rest are gray.

.. GENERATED FROM PYTHON SOURCE LINES 9-14

.. code-block:: Python


    import numpy as np

    from fury import actor, window


.. GENERATED FROM PYTHON SOURCE LINES 15-16

Create a handful of straight streamlines with multiple points.

.. GENERATED FROM PYTHON SOURCE LINES 16-40

.. code-block:: Python


    x_coords = np.linspace(-5.0, 5.0, 11, dtype=np.float32)
    lines = np.stack(
        [
            np.column_stack(
                [x_coords, np.full_like(x_coords, -1.0), np.zeros_like(x_coords)]
            ),
            np.column_stack(
                [x_coords, np.full_like(x_coords, 0.0), np.zeros_like(x_coords)]
            ),
            np.column_stack(
                [x_coords, np.full_like(x_coords, 1.0), np.zeros_like(x_coords)]
            ),
            np.column_stack(
                [x_coords, np.full_like(x_coords, 3.0), np.zeros_like(x_coords)]
            ),
            np.column_stack(
                [x_coords, np.full_like(x_coords, -3.0), np.zeros_like(x_coords)]
            ),
        ],
        axis=0,
    ).astype(np.float32)



.. GENERATED FROM PYTHON SOURCE LINES 41-42

Define a small ROI mask (all ones) and place its origin explicitly.

.. GENERATED FROM PYTHON SOURCE LINES 42-48

.. code-block:: Python


    mask_shape = (9, 9, 9)
    mask = np.zeros(mask_shape, dtype=np.uint8)
    mask[3:7, 3:7, 3:7] = 1  # A small cube in the center
    roi_origin = (-5.0, -5.0, -5.0)  # voxel (0,0,0) is at (-5, -5, -5) in world coords


.. GENERATED FROM PYTHON SOURCE LINES 49-50

Build actors

.. GENERATED FROM PYTHON SOURCE LINES 50-76

.. code-block:: Python


    all_lines = actor.streamlines(
        lines,
        colors=(0.7, 0.7, 0.7),
        thickness=2.0,
        opacity=0.2,
    )

    roi_filtered = actor.streamlines(
        lines,
        colors=(0.0, 0.0, 1.0),
        thickness=4.0,
        outline_thickness=1.5,
        outline_color=(0.1, 0.1, 0.1),
        roi_mask=mask,
        roi_origin=roi_origin,
        opacity=1.0,
    )

    roi_surface = actor.contour_from_roi(
        mask,
        color=(0.0, 0.8, 0.3),
        opacity=0.4,
    )
    roi_surface.translate(roi_origin)


.. GENERATED FROM PYTHON SOURCE LINES 77-78

Create a scene and show

.. GENERATED FROM PYTHON SOURCE LINES 78-88

.. code-block:: Python

    scene = window.Scene()
    scene.add(all_lines)
    scene.add(roi_filtered)
    scene.add(roi_surface)

    show_manager = window.ShowManager(
        scene=scene, title="FURY Simple Streamline ROI", size=(800, 600)
    )
    window.update_camera(show_manager.screens[0].camera, None, scene)
    show_manager.start()


.. _sphx_glr_download_auto_examples_04_demos_viz_streamlines_roi.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: viz_streamlines_roi.ipynb <viz_streamlines_roi.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: viz_streamlines_roi.py <viz_streamlines_roi.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: viz_streamlines_roi.zip <viz_streamlines_roi.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_