ZEISS Microscopy Knowledge Base
Help
ZEISS Microscopy Knowledge Base

Creating concentric sub volume - matryoshka dolls

This guide explains how to create concentric objects based on the source segments shape, from the outside to the inside. The concentric shapes can be used as ROIs for further analysis (Compartmentalization, gradient distribution, heat map, etc.).

Opening the working dataset

  1. Select Open... from the file menu.
    File menu showing Open... option highlighted with CTRL+O shortcut
  2. Select the dataset from the file browser.
    The dataset is a multi dimensional, discrete, representation of your real sample volume. It can be structured as a Z series of planes (Optical sectioning) of multiple channels (dyes) in a temporal sequence of time points (located in several spatial positions).​
    Usually, the dataset shows a single experimental situation (a complete experiment can be composed by several datasets). The datasets are available as graphic files saved in plenty of file formats (standard formats as well as proprietary formats)​.
    Note: The dataset is visualized according to the current rendering setting parameters. Refer to the arivis Pro Help for more details.

Software GUI with 3D volumetric rendering of green and red segmented objects on a grid, left-side tool panels and color scale

Loading the Python script

  1. Open Python Script Editor. From the Extra menu, select Script Editor.
    Extras menu dropdown listing Preferences..., Plug-in Manager, Task Monitor, Run Script..., Script Editor
  2. Load the Matryoshka_doll_revxx Python Script.
    Script Editor - Script1 title bar showing menus File, Edit, View, Script
  3. Browse the folder on which the file has been saved.
    File menu with 'Open...  Ctrl+O' highlighted, 'New  Ctrl+N' above, 'Open Sample' and 'Close  Ctrl+F4' below

Python script code usage rights:The user has the permission to use, modify and distribute this code, as long as this copyright notice remains part of the code itself: Copyright(c) 2021 arivis AG, Germany. All Rights Reserved.

commented script header showing NAME: Matrioshka Doll and Copyright(c) 2021 arivis AG, Germany.

Setting the script features

In order to define the "Matryoshka" based model sub-regions features, some parameters of the script should be adjusted to match your analysis needs. These parameters are located in the code area labeled as USER SETTING.

Only the parameters located in the USER SETTING area can be modified. Don’t change any other number, definition or text in the code outside this dedicated area.

USER_SETTINGS code: TAG_DESCRIPTOR 'Manual', TAG_SCRIPT_DESCRIPTOR 'Matrioshka_', MATRYOSHKA_DOLL_NUM=8, APPLY_CONVEX_HULL=True

  • TAG_DESCRIPTOR : Set the source object(s) TAG. The outer shape of this/these object(s) is used to create the concentric, inner, sub-volumes.
  • TAG_SCRIPT_DESCRIPTOR : It defines the new TAG with which the concentric objects will be identified. The source object ID is added to the TAG.
  • MATRYOSHKA_DOLL_NUM : Sets the total number of concentric sub-volumes. The parameter includes the outer source shape.
  • APPLY_CONVEX_HULL : If True, the convex hull algorithm is applied.
  • MATRYOSHKA_WITH_HOLES : If True, the inner sub-volume is subtracted from the outer contiguous shape.

The MATRYOSHKA_WITH_HOLES parameter changes with how the inner sub-volume of each Doll is computed. It can be hollow or filled.

MATRYOSHKA_WITH_HOLES = True

Teal 3D sphere with arrows labeled Matryoshka Inner shell, hole, Outer shell and sub-volume

MATRYOSHKA_WITH_HOLES = False

Red 3D sphere highlighted and labeled Matryoshka sub-volume

Running the Python script

Run the Matryoshka_doll_revxx Python Script by pressing the Run Script button or by pressing the F5 key.

Toolbar with Run Script button and Hide Output Pane, tabs labeled Skeketon_RevB.py and Free-Oriented Sub-...
Script menu showing Run Script   F5 and Run File   CTRL+F5 options

Activate the Output Panel, if not already displayed. The status of the script execution (errors including) will be visualized here.

Toolbar with Run Script button and Show Output Pane option
Script output panel displaying lines: starting script..., Script is running ........, time: 1.34400010109, script finished.
Two spheres labeled Source segment and Matryoshka with holes above a filter showing checked Matrioshka__3 and segment table
Impressum
Carl-Zeiss-Strasse 22
73447 Oberkochen
Germany
Legal