annotrack

Annotrack是一个用于注释对象轨迹错误的napari插件。该插件将帮助您选择轨迹段以及相应的图像和分割的小部分。Annotrack允许您注释三种类型的错误：（1）ID交换错误（轨迹在对象之间跳跃），（2）错误开始（轨迹在预存在的对象上开始）和错误终止（轨迹结束但对象仍然存在）。通过查看错误开始和错误终止的合并率，您可以评估轨迹中断错误。

请注意：图像和分割必须以zarr格式存储。轨迹应以parquet格式存储。

安装

安装annotrack主要有三种方法

使用pip安装

请注意，这处于计划/开发中

请在您的终端（MacOS或Ubuntu）或annaconda提示符（Windows）中输入以下内容

pip install annotrack

安装

请注意，这处于计划/开发中

请在您的终端（MacOS或Ubuntu）或annaconda提示符（Windows）中输入以下内容

install napari
napari

一旦napari打开（第一次打开可能需要一秒钟），请转到屏幕顶部的面板并选择“插件”下拉菜单。然后选择安装/卸载插件。将打开一个新窗口，显示可用的插件。向下滚动或搜索“annotrack”，然后单击“安装”。

从源代码安装

目前请使用此方法

请在您的终端（MacOS或Ubuntu）或annaconda提示符（Windows）中输入以下内容

git clone https://github.com/AbigailMcGovern/annotrack.git
cd annotrack
pip install .

打开Annotrack

一旦Annotrack正确安装，您就可以通过打开napari来打开Annotrack。您可以通过以下方式通过命令行（终端（MacOS或Ubuntu）或annaconda提示符（Windows））打开napari

napari

您可以通过选择屏幕顶部的面板上的“插件”下拉菜单，并将鼠标悬停在“annotrack”上找到Annotrack小部件。

从CSV采样

要采样您的轨迹，您需要提供图像、分割和轨迹的文件路径。您需要在如下结构的csv中提供这些信息

在这个csv中，您还可以指定从每个文件中取多少个样本。如果没有提供，Annotrack将使用您提供给sample_from_csv小部件的值。csv必须包含一个指定每个样本所属类别的列（例如，物种、实验条件、药物等）。如果这对您的样本不重要，只需添加一个虚拟类别（例如，sample_type : [A, A, A, A]）。

要访问小部件并采样轨迹段，请转到屏幕顶部，转到插件 > annotrack > sample_from_csv。当小部件显示时，选择csv文件，选择要保存结果的目录，并为汇总数据文件提供名称（即，您的注释将被写入的地方）。

小部件参数

• csv路径：存储用于生成样本的信息的路径。CSV应包含以下列：image_path，labels_path，tracks_path，<category_col>，您还可以添加一个可选的n_samples列，如果您想指定从每个单个文件中取多少个样本。否则，将使用您提供的默认“n_samples”。
• 输出目录：输出将保存在哪里？
• 输出名称：输出汇总文件/目录将如何命名？
• n samples：从每个文件中获取的样本数量。如果csv的n_samples列中有一个有效的整数，则将覆盖。
• tzyx列：文件中表示时间（帧）和坐标位置（像素）的列的名称是什么？顺序应该是：t，z，y，x。
• id列：表示每个跟踪对象的特定ID的列的名称是什么？
• 缩放：z、y和x坐标（按顺序）的像素大小（例如，在um中）
• 帧数：轨迹段的近似最大帧数。最大帧数 = 帧数（如果为偶数）或帧数 - 1（如果为奇数）
• 框大小：边界框的近似大小（以像素为单位）。
• 最小轨迹长度：您可以设置一个最小轨迹长度以包含在搜索中。这可以帮助消除不太有用的数据。这应该至少为1，仅包含跟踪对象。如果您特别感兴趣于较长的轨迹，则仅将其设置得更高。
• 图像通道：这表示从哪个通道获取图像数据的索引（0：通道1，1：通道2，2：通道3，3：通道4）

现在注释吗？

当我们需要注释多个条件以进行比较时，我们希望在一个会话中以随机顺序显示它们，同时注释者对样本的来源保持盲态。我们希望能够注释样本中的未注释数据，而无需一次性完成这项工作。因此，注释被保存到已保存的样本中。可以使用以下代码对来自各种跟踪实验中保存的选定数量的样本进行注释。如果您重新执行此代码，除非您请求其他操作，否则您只会看到尚未注释的数据。

导航和注释样本的键

• '2' - 转到下一个样本
• '1' - 转到上一个样本
• 'y' - 将注释标记为正确（将自动转到下一个样本）
• 'n' - 将注释标记为包含错误（将自动转到下一个样本）
• 'i' - 注释ID交换错误之后的帧
• 't' - 注释不正确终止之后的帧
• 'Shift-t' - 注释包含错误启动的帧
• 's' - 将错误（'i'、't' 或 'Shift-t'）注释为与分割错误（对象的合并或拆分）相关联

当错误与特定的帧（'i'、't'、'Shift-t' 或 's'）相关联时，原始图像中的帧号将被添加到样本的 (.smpl) 信息数据帧中的错误列表中。例如，您可能有一个包含样本跟踪段的ID交换列表（[108, 111, 112]）和相应的分割错误关联列表（《[108, 112]》）。

注释现有样本

如果您已经保存了一个样本并想对其进行注释，您可以使用 annotate_existing_sample 小部件加载数据。如果您想让多个注释者注释同一样本，这可能很有用。要访问此小部件，请打开 napari

贡献和用户支持

用户支持：如果您在使用 annotrack 时遇到问题，请添加问题（转到 GitHub 页面顶部的“问题”选项卡）。如果您的错误是一个bug，请尽可能提供详细信息以帮助调试问题。信息示例包括：图像和分割数据的详细信息（尺寸）、图像数量、您尝试获取的样本数量。如果您正在请求改进，请尽可能清楚地说明您的需求。

贡献：如果您想为 annotrack 做贡献，请分叉存储库，并如果您想进行更改，请尽可能详细地制作一个 pull request。请确保您要做的任何更改都不会破坏现有功能。