夜光

Lumos 是一个程序，它从通过细胞绘画分析获得的单独的站点/现场图片生成全板图像。

它有 2 种操作模式，允许它为板的特定通道渲染图像，以及将所有通道组合在一起的彩色图像：

在本文档中，您将找到与以下内容相关的信息：

• 安装包
• 如何使用 Lumo
• 详细示例

要了解有关程序命令行界面的更多信息，请参阅Wiki 页面。

您还可以在其他文档中找到针对开发人员的说明。

安装 Lumos

先决条件：

• 您需要在 Windows 或 Linux 机器上安装 Python 3.8。
• 您还需要在机器上保存印版的原始站点图像。

然后，要安装 Lumos，请选择以下选项之一：

• 使用 PIP 安装 Lumos：

  pip install lumos-cli
  

• 从源文件安装 Lumos：
  • 通过下载 ZIP 文件或克隆存储库来下载源文件。
  • 使用 PIP 安装依赖项：pip install -r .\requirements.txt
  • 安装 Lumos：python setup.py install

用法

配置 Lumos

要配置 Lumos 以使用您的特定印版格式，您必须首先创建一个配置文件。为此，请输入以下命令：

lumos --generate-config-file ./my_config.yaml

然后，在生成的文件中，您应该更改以下条目以匹配图像的组织：

• path_from_run_folder_to_plates
• path_from_plate_folder_to_images
• input_file_naming_scheme
• well_grid
• site_grid
• image_dimensions

然后，还要确保使用正确的频道 ID 更新以下项目（即它们在文件名中的显示方式）：

• 的键/子条目channel_info
• default_channels_to_render
• brightfield_channels
• cp_channels_to_use

您可以在此处查看此示例。

完成此操作后，您就可以在图像上使用 Lumos。

简单的命令

您可以运行的第一个命令如下：

lumos --config-file ./my_config.yaml qc --scope plate --source-path <path_to_a_plate_folder> --output-path ./output/

其中<path_to_a_plate_folder>是板根文件夹的路径。在此示例中，这将是PLATE-XXX文件夹之一。

这将为板的每个通道（不包括明场通道）生成 1 个灰度图像，并允许您轻松检查您拥有的图像质量是否良好：

笔记：

我们还可以使用参数别名来使命令更短，如下所示：

lumos -cf ./my_config.yaml qc -s plate -sp <path_to_a_plate_folder> -op ./output/

要查看所有可用参数及其别名的列表，请使用lumos qc --help.

第一个命令依赖于 Lumos 的qc“质量控制”模式（因此qc命令中出现了关键字）。同样，Lumos 也有一个cp，或“细胞绘画”模式，它允许您生成 1 个板的所有通道的组合图像（彩色）。

要使用它，请在终端中键入以下内容：

lumos -cf my_config.yaml cp --scope plate --source-path <path_to_a_plate_folder> --output-path ./output/

这将生成一个类似于此的图像：

（放大：）

笔记：

要查看所有可用单元格绘制参数及其别名的列表，请使用lumos cp --help.

除了这些第一个示例之外，Lumos QC 还可以为板的特定通道或整个运行（即板的集合）生成图像。同样，Lumos CP 可以为板的每个孔生成单独的图像，仅针对单个孔，甚至针对这些孔的每个位点。

这以及 Lumos 的其他功能可以通过命令中使用的参数进行选择。要查看每种操作模式的可用参数和选项的完整列表，请分别键入lumos qc --help和lumos cp --help。

您还可以浏览我们的一些更详细的示例或参考我们的Wiki 页面以了解更多信息。

详细示例

示例配置文件

如果您有以下文件夹结构：

JUMPCP_images/
    ├ run_1/
        └ plates/
            ├ PLATE-101/
              └ Images/
                  ├ r01c01f01p01-ch1sk1fk1fl1.tiff
                  ├ r01c01f01p01-ch2sk1fk1fl1.tiff
                  ├ ...
                  └ r32c48f04p01-ch8sk1fk1fl1.tiff
            ├ PLATE-102/
              └ Images/
                  ├ r01c01f01p01-ch1sk1fk1fl1.tiff
                  ├ r01c01f01p01-ch2sk1fk1fl1.tiff
                  ├ ...
                  └ r32c48f04p01-ch8sk1fk1fl1.tiff
            └ ...
    ├ run_2/
        └ plates/
            ├ PLATE-201/...
            ├ PLATE-202/...
            └ ...
    └ run_3/
        └ plates/
            ├ PLATE-301/...
            ├ PLATE-302/...
            └ ...

井在 32 行 x 48 列的网格中，站点在 2 x 2 的网格中，图像为 1080 x 1080 像素。

您将在配置文件中编辑以下条目，如下所示：

path_from_run_folder_to_plates: 'plates/'
path_from_plate_folder_to_images: 'Images/'
input_file_naming_scheme: rows_and_columns
well_grid: 32x48
site_grid: 2x2
image_dimensions: 1080x1080
channel_info:
  ch1: [...]
  ch2: [...]
  ch3: [...]
  ch4: [...]
  ch5: [...]
  ch6: [...]
  ch7: [...]
  ch8: [...]
default_channels_to_render:
- ch1
- ch2
- ch3
- ch4
- ch5
brightfield_channels:
- ch6
- ch7
- ch8
cp_channels_to_use:
- ch1
- ch2
- ch3
- ch4
- ch5

示例 1：生成板的特定通道的图像

为此，我们可以使用带有附加--channel参数的“通道”范围，通过指定通道 ID 来选择应该呈现哪个通道。假设上面的示例配置，要渲染我们板的通道“ch3”，我们会得到：

lumos --config-file my_config.yaml qc --scope channel --channel ch3 --source-path <path_to_a_plate_folder> --output-path ./output/

或者，使用参数别名，我们可以使用更短的以下命令：

lumos -cf my_config.yaml qc -s channel -c ch3 -sp <path_to_a_plate_folder> -op ./output/

示例 2：为板的所有通道生成图像，包括明场

为此，我们可以将--brightfield参数添加到常规命令中。使用这个参数，我们可以选择通过写入其 ID 来包含特定的明场通道，或者通过写入“all”来包含所有通道。在本例中，我们将执行后者：

lumos --config-file my_config.yaml qc --scope plate --source-path <path_to_a_plate_folder> --output-path ./output/ --brightfield all

或者，使用参数别名，我们可以使用更短的以下命令：

lumos -cf my_config.yaml qc -s plate -sp <path_to_a_plate_folder> -op ./output/ -b all

示例 3：为多个板的所有通道生成图像（即“运行”）

为此，我们可以使用“运行”范围。--source-path然后，我们将路径放置到我们的“运行”（即我们的盘子集合），而不是将路径作为我们的。

lumos --config-file my_config.yaml qc --scope run --source-path <path_to_a_run_folder> --output-path ./output/

笔记：

确保您的配置文件包含正确的路径，以便在您的运行文件夹和您的板文件夹之间遵循path_from_run_folder_to_plates

或者，使用参数别名，我们可以使用更短的以下命令：

lumos -cf my_config.yaml qc -s run -sp <path_to_a_run_folder> -op ./output/

示例 4：生成板中特定孔的细胞绘制图像

这可以使用cpLumos 模式的“井”范围来完成。--single-well然后，我们可以使用后跟井名的参数（例如“r03c21”）将图像的生成限制为单个井：

lumos --config-file my_config.yaml cp --scope wells --single-well r03c21 --source-path <path_to_a_plate_folder> --output-path ./output/

或者，使用参数别名，我们可以使用更短的以下命令：

lumos -cf my_config.yaml cp -s wells -w r03c21 -sp <path_to_a_plate_folder> -op ./output/