6.31. 坐标读数的常用函数 MDAnalysis.coordinates.core

重要的基类收集在 MDAnalysis.coordinates.base 。

MDAnalysis.coordinates.core.reader(filename, format=None, **kwargs)

提供轨迹读取器实例，用于 文件名 。

此函数根据的扩展名猜测文件格式 文件名 它将抛出一个 TypeError 如果无法识别分机，则返回。

在大多数情况下，不需要特殊的关键字参数。

所有其他关键字都传递给基础Reader类；有关详细信息，请参阅它们的文档。

参数:

• filename (str or tuple) -- 输入坐标文件的文件名(或文件名元组

• kwargs -- 所选Reader类的关键字参数。

返回:

一个轨迹读取器实例

返回类型:

Reader

参见

支持的坐标格式表

MDAnalysis.coordinates.core.writer(filename, n_atoms=None, **kwargs)

初始化轨迹写入器实例 文件名 。

参数:

• filename (str) -- 轨迹的输出文件名；扩展名决定格式。

• n_atoms (int (optional)) -- 输出轨迹中的原子数；对于单帧写入器可以省略。

• multiframe (bool (optional)) -- True ：写一条多帧的轨迹； False 仅写入单帧快照； None 首先尝试获取多帧编写器，然后回退到单帧 [None]

• kwargs (optional) -- 编写器的关键字参数；所有轨迹编写器都接受 start ：开始时间 [0] ， step ：以帧为单位的步长 [1] ， dt ：两帧之间的时间长度，单位为ps [1.0] 一些读者接受额外的论点，这些论点需要在读者的文档中查找。

返回:

轨迹写入器实例

返回类型:

Writer

参见

支持的坐标格式表

在 0.7.6 版本发生变更: 已添加 multiframe 关键字。另请参阅 get_writer_for() 。

助手函数：

MDAnalysis.coordinates.core.get_reader_for(filename, format=None)

返回适当的轨迹读取器类 filename 。

参数:

• filename -- 输入轨迹或坐标文件的文件名。也可以处理一些特殊情况，见下面的说明。

• format (str or Reader (optional)) -- 定义所需的格式。可以是请求给定读取器的字符串。如果传递了一个类，将假定这是一个Reader并将返回。

返回:

一个Reader对象

返回类型:

Reader

抛出:

ValueError -- 如果找不到合适的读卡器

备注

有一些特殊情况是可以处理的：

• 如果 filename 是一个数字数组， MemoryReader 返回。

• 如果 filename 是MMTF对象， MMTFReader 返回。

• 如果 filename 是一种ParmEd结构， ParmEdReader 返回。

• 如果 filename 是文件名的可迭代， ChainReader 返回。

当显式设置为 format ，除非提供了文件名列表，在这种情况下 ChainReader 被返回，并且 format 传递给 ChainReader 。

在 1.0.0 版本发生变更: 添加了FORMAT_HINT函数x

MDAnalysis.coordinates.core.get_writer_for(filename, format=None, multiframe=None)

返回适当的轨迹或帧编写器类 filename 。

格式由 format 参数或扩展 filename 。如果 format 时，它优先于扩展 filename 。

参数:

• filename (str or None) -- 如果没有 格式化 则检查轨迹的文件名以确定其扩展名，并相应地选择编写器。如果 None 被提供，则 NullWriter (并且所有输出都将以静默方式丢弃)。

• format (str (optional)) -- 明确设置一种格式。

• multiframe (bool (optional)) -- True ：向轨迹写入多个帧； False ：只写一个坐标框架； None ：先尝试轨迹(多帧写入器)，然后尝试单帧写入器。默认值为 None 。

返回:

编写器对象

返回类型:

Writer

抛出:

• ValueError: -- 无法从该格式推导出 filename 属性提供了意外的值。 multiframe 论点。

• TypeError: -- 找不到所需格式或所需的编写器 filename 论点被省略了。

在 0.7.6 版本发生变更: 已添加 multiframe 关键字；默认设置 None 反映了之前的行为。

在 0.14.0 版本发生变更: 删除了的默认值 format 争论。现在，随 format 参数优先于 filename 。一个 ValueError 如果无法从中推导出格式，则引发 filename 。

在 0.16.0 版本发生变更: 这个 filename 论证已成为强制性的。