txrm2tiff

将 TXRM/XRM 文件转换为 OME-TIFF 文件。

txrm2tiff 是由 Thomas Fish 为 Diamond Light Source 的 B24 线的用户创建的。它已从 B24 的自动处理管道改编，并由 Kevin Savage、Peter Chang 和 Victoria Beilsten-Edmands 进行了进一步的增加和修改。

安装

在 PyPI 和 conda-forge 上以 txrm2tiff 可用。要安装

• PyPI: python -m pip install txrm2tiff
• conda-forge: conda install -c conda-forge txrm2tiff

说明

txrm2tiff {--input 输入文件路径（必需）} {--reference 参考文件路径（可选，默认=None）} {--output 路径（可选，默认=None）} {--annotate（可选）} {--datatype 输出数据类型（可选，选项=[uint16, float32, float64]，默认=None）} {--apply-shifts（可选）} {--ignore-ref（可选）} {--set-logging（可选），默认="info"}

如果没有提供输出路径，输出文件将放置在输入路径，扩展名为 ".ome.tiff"。".ome" 表示 OME XML 元数据标题。

除非指定数据类型，否则数据类型将与从 XRM 数据探索器直接获取的数据类型相同。这意味着未引用的图像将保持为 uint16，而引用的图像将以 float32 输出。

日志选项是

• debug OR 1
• info OR 2
• warning OR 3
• error OR 4
• critical OR 5

本README旨在尽可能准确反映最新版本并包含有用示例。然而，txrm2tiff -h 或 txrm2tiff --help 将提供关于安装版本的100%准确信息，与这份README不同，因此请也参考它。  

- 安装选项

txrm2tiff setup {--windows-shortcut (仅限Windows：可选，在桌面上创建快捷方式以进行拖放处理)}

txrm2tiff setup -h 或 txrm2tiff setup --help 将提供更多信息。  

- 检查器选项

txrm2tiff inspect {--input 输入文件路径 (必需)} {--extra (可选，默认=False)} {--list-streams (可选，默认=False)} {--inspect-streams 空格分隔的流 (可选)}

txrm2tiff inspect --input 或 txrm2tiff inspect -i 后跟 txrm/xrm 文件的路径将输出有关包含的图像的一些基本信息。

• 添加 --extra 或 -e 将添加更多输出信息。
• 添加 --list-streams 或 -l 将列出所有流*（除了任何之前的输出）。这将有很多，因此可能需要将其保存到文件中，使用 > file.txt。
• 添加 --inspect-streams 或 -s 后跟一个或多个用空格分隔的流名称将使用各种格式读取每个流。由于 txrm 和 xrm 文件没有保存有关所使用数据类型的说明**，输出将需要一些解释。

txrm2tiff inspect -h 或 txrm2tiff inspect --help 将提供更多信息。

附加说明

*XRM 和 TXRM 文件是 'OLE' 类型文件。这些文件将分离并存储在流中的信息。

** 例外的是图像，图像的数据类型将单独保存。

注意：以 txrm2tiff 开头的任何命令在本质上相当于使用 python -m txrm2tiff（通过任一方法解析的参数将相同）。如果存在任何安装问题，这可能很有用。

dragndrop.bat 已提供，允许 Windows 用户拖放单个文件或整个目录进行处理（注意：您不能使用这种方式设置输出路径）。这可能需要根据您的 Python 安装进行一些设置，请参阅文件。

示例

txrm2tiff -h 和 txrm2tiff setup --h 将提供更多信息

txrm2tiff -i input.txrm 保存 "input.ome.tiff"，如果可用，将应用参考。

txrm2tiff -i input.txrm -r ref_stack.txrm 保存 "input.ome.tiff"，并从对 txrm 堆运行 Despeckle & Average 获取参考图像。此 Despeckle & Average 算法与蔡司算法几乎相同，基于他们的逻辑。

txrm2tiff --input input.txrm --reference ref_single.xrm --ignore-ref 保存 "input.ome.tiff"，并从单个图像（例如，Despeckled_Ave.xrm 文件）应用自定义参考。如果提供自定义参考，则忽略参考参数。

txrm2tiff -i input.xrm -o custom-output.ome.tiff 保存 "custom-output.ome.tiff"，如果可用，将应用参考。

txrm2tiff -i input.xrm --annotate 保存 "input.ome.tiff"，以及一个单独的文件 "input_Annotated.tiff"，其中包含（如果找到）注释和比例尺。

txrm2tiff --input input.xrm --ignore-ref --set-logging debug 保存 "input.ome.tiff"，并忽略任何参考，显示调试及以上级别的日志消息。

txrm2tiff --input input.xrm --apply-shifts --datatype uint16 保存 "input.ome.tiff"，应用文件中可用的任何 shifts，并以 uint16 保存输出。

txrm2tiff -i input.xrm --output custom-output.ome.tif --set-logging error 保存 "custom-output.ome.tiff"，并显示错误及以上级别的日志消息。

批量转换

txrm2tiff --input path/to/inputDirectory/ 将将输入目录中的所有 XRM/TXRM 文件转换为 XRM/TXRM 文件，如果可用，将应用参考。

txrm2tiff --input path/to/inputDirectory/ --ignore-ref 将输入目录中的所有 XRM/TXRM 文件转换为 XRM/TXRM 文件，忽略所有参考。

txrm2tiff --input 路径/to/inputDirectory/ --output 路径/to/outputDirectory/ --ignore-ref 将 "inputDirectory" 中所有的 XRM/TXRM 文件转换，并保存到指定输出目录的自动命名中，忽略所有引用。

批量转换注意事项

• --output 必须 是一个目录，否则将被忽略，文件将放在与 XRM/TXRMs 相同的目录中。
• 包含 "inputDirectory" 中找到的任何 XRM/TXRM 文件的子目录将被复制到 "outputDirectory"（如果不存在，将创建目录）。
• --reference 输入将在批量转换中被忽略。

功能

• 将 XM 控制器的 XRM/TXRM v3.0 文件和 XRM 数据浏览器的 v5.0 文件转换为 TIFF。
• 如果在 XM 控制器/XRM 数据浏览器中应用了引用，它将自动应用引用（图像 * 100.0 / 引用，如 XM 控制器所做的那样）。也可以忽略内部引用。
• 可以指定自定义引用图像（可以是 TXRM 或 XRM 文件，也可以是 TIFF 图像或堆栈）——此选项将覆盖任何内部存储的引用和忽略引用选项。
• 如果可用参考曝光（例如，来自 XRM/TXRM 或 OME-TIFF），则参考图像将按 0° 的图像曝光比例调整大小。
• 可以从 XRM/TXRM v5.0 文件中导出并保存任何注释（包括刻度尺）。
• 可以指定输出图像的数据类型（如果数据类型限制图像的动态范围，将给出警告；同时，在转换为 float -> integer 之前，值将被四舍五入）。
• 将在标题中添加 OME XML 格式的元数据。
• 批量转换选项。
• 检查器（可以提取 XRM/TXRM 文件中的任何信息）。
• 在 Python 中，可以使用函数 open_txrm（from txrm2tiff import open_txrm）打开并交互 XRM/TXRM 文件，该函数返回正确版本的 Txrm 对象。推荐用法：with open_txrm(...) as txrm:。
• 在 Python 中，可以使用 convert_and_save（from txrm2tiff import convert_and_save）快速转换和保存文件。