VOTableFile#

class astropy.io.votable.tree.VOTableFile(ID=None, id=None, config=None, pos=None, version='1.4')[源代码]#

基类：Element, _IDProperty, _DescriptionProperty

VOTABLE 元素：表示整个文件。

关键字参数对应于具有相同名称的设置成员，如下所述。

版本只在构建时设置，因为构建结构其余部分的一致性测试依赖于它。

属性摘要

`coordinate_systems`	文件的坐标系说明列表。
`groups`	按组在文件中出现的顺序列出的组。
`infos`	整个文件的信息性参数（键值对）的列表。
`params`	应用于整个文件的参数（常量值列）的列表。
`resources`	资源的列表，按它们在文件中出现的顺序排列。
`time_systems`	文件的时间系统描述列表。
`version`	文件使用的VOTable规范的版本。

方法总结

`from_table`(table[, table_id])	创建一个 `VOTableFile` 给定的实例 `astropy.table.Table` 实例。
`get_coosys_by_id`(ref[, before])	查找a COOSYS 元素。
`get_field_by_id`(ref[, before])	查找a FIELD 元素 ID.
`get_field_by_id_or_name`(ref[, before])	查找a FIELD 元素 ID 或者名字。
`get_fields_by_utype`(ref[, before])	查找a FIELD 元素，并返回发出所有匹配项的迭代器。
`get_first_table` \()	通常，您知道文件中只有一个表，而这正是您所需要的。
`get_group_by_id`(ref[, before])	查找a GROUP 元素。
`get_groups_by_utype`(ref[, before])	查找a GROUP 元素，并返回发出所有匹配项的迭代器。
`get_info_by_id`(ref[, before])	根据给定的ID查找INFO元素。
`get_infos_by_name`(ref[, before])	返回具有给定名称的所有INFO子项。
`get_table_by_id`(ref[, before])	查找a TABLE 元素。
`get_table_by_index` \(IDX)	通过表在文件中的序号位置获取表。
`get_tables_by_utype`(ref[, before])	查找a TABLE 元素，并返回发出所有匹配项的迭代器。
`get_timesys_by_id`(ref[, before])	查找a TIMESYS 元素。
`get_values_by_id`(ref[, before])	查找a VALUES 元素。
`iter_coosys` \()	递归迭代所有 COOSYS 中的元素 VOTABLE 文件。
`iter_fields_and_params` \()	递归迭代所有 FIELD 和 PARAM 中的元素 VOTABLE 文件。
`iter_groups` \()	递归迭代所有 GROUP 中的元素 VOTABLE 文件。
`iter_info` \()	递归迭代所有 INFO 中的元素 VOTABLE 文件。
`iter_tables` \()	以“平面”方式迭代VOTable文件中的所有表，忽略资源的嵌套等。
`iter_timesys` \()	递归迭代所有 TIMESYS 中的元素 VOTABLE 文件。
`iter_values` \()	递归迭代所有 VALUES 中的元素 VOTABLE 文件。
`parse`(iterator, config)	供内部使用。
`set_all_tables_format` \(格式)	设置文件中所有表的输出存储格式。
`to_xml`(fd[, compressed, tabledata_format, ...])	写入XML文件。

属性文档

coordinate_systems#: 文件的坐标系说明列表。必须仅包含 CooSys 物体。

groups#: 按组在文件中出现的顺序列出的组。仅支持作为VOTABLE 1.2或更高版本中VOTABLE元素的子级。

infos#: 整个文件的信息性参数（键值对）的列表。必须仅包含 Info 物体。

params#: 应用于整个文件的参数（常量值列）的列表。必须仅包含 Param 物体。

resources#: 资源的列表，按它们在文件中出现的顺序排列。必须仅包含 Resource 物体。

time_systems#: 文件的时间系统描述列表。必须仅包含 TimeSys 物体。

version#: 文件使用的VOTable规范的版本。

方法文件

classmethod from_table(table, table_id=None)[源代码]#

创建一个 VOTableFile 给定的实例 astropy.table.Table 实例。

参数:

table_id : str ，可选Python：字符串，可选: 在返回的TableElement实例上设置给定的ID属性。

get_coosys_by_id(ref, before=None)#: 查找a COOSYS 元素。

get_field_by_id(ref, before=None)#: 查找a FIELD 元素 ID. 由字段的“ref”属性使用。

get_field_by_id_or_name(ref, before=None)#: 查找a FIELD 元素 ID 或者名字。

get_fields_by_utype(ref, before=None)#: 查找a FIELD 元素，并返回发出所有匹配项的迭代器。

get_first_table()[源代码]#: 通常，您知道文件中只有一个表，而这正是您所需要的。此方法返回第一个表。

get_group_by_id(ref, before=None)#: 查找a GROUP 元素。由组的“ref”属性使用

get_groups_by_utype(ref, before=None)#: 查找a GROUP 元素，并返回发出所有匹配项的迭代器。

get_info_by_id(ref, before=None)#: 根据给定的ID查找INFO元素。

get_infos_by_name(ref, before=None)#: 返回具有给定名称的所有INFO子项。

get_table_by_id(ref, before=None)#: 查找a TABLE 元素。由表“ref”属性使用。

get_table_by_index(idx)[源代码]#: 通过表在文件中的序号位置获取表。

get_tables_by_utype(ref, before=None)#: 查找a TABLE 元素，并返回发出所有匹配项的迭代器。

get_timesys_by_id(ref, before=None)#: 查找a TIMESYS 元素。

get_values_by_id(ref, before=None)#: 查找a VALUES 元素。由值“ref”属性使用。

iter_coosys()[源代码]#: 递归迭代所有 COOSYS 中的元素 VOTABLE 文件。

iter_fields_and_params()[源代码]#: 递归迭代所有 FIELD 和 PARAM 中的元素 VOTABLE 文件。

iter_groups()[源代码]#: 递归迭代所有 GROUP 中的元素 VOTABLE 文件。

iter_info()[源代码]#: 递归迭代所有 INFO 中的元素 VOTABLE 文件。

iter_tables()[源代码]#: 以“平面”方式迭代VOTable文件中的所有表，忽略资源的嵌套等。

iter_timesys()[源代码]#: 递归迭代所有 TIMESYS 中的元素 VOTABLE 文件。

iter_values()[源代码]#: 递归迭代所有 VALUES 中的元素 VOTABLE 文件。

parse(iterator, config)[源代码]#

内部使用。解析元素子元素的XML内容。

参数:

iterator : xml iterableXMLpython：可迭代的: 返回的XML元素的迭代器 get_xml_iterator .
config : dictPython ：词典: 影响某些元素的读取方式的配置字典。

返回:

self ： Element元素: 返回self作为方便。

set_all_tables_format(format)[源代码]#: 设置文件中所有表的输出存储格式。

to_xml(fd, compressed=False, tabledata_format=None, _debug_python_based_parser=False, _astropy_version=None)[源代码]#

写入XML文件。

参数:

fd : str 或 file-like objectPYTHON：字符串或PYTHON：类文件对象: 写入文件的位置。如果是类似文件的对象，则必须是可写的。
compressed : bool ，可选可选的布尔: 什么时候？ True ，写入gzip压缩文件。（默认值： False ）
tabledata_format : str ，可选Python：字符串，可选: 重写表(S)数据的格式。一定是其中之一 tabledata (文本表示法)、 binary 或 binary2 。默认情况下，使用每个 TableElement 对象创建或读入时的。看见数据序列化格式。