HDU列表#

Inheritance diagram of HDUList

HDUList#

class astropy.io.fits.HDUList(hdus=[], file=None)[源代码]#

基类:list, _Verify

HDU列表类。这是顶层的FITS对象。打开FITS文件时 HDUList 返回对象。

构建一个 HDUList 对象。

参数:
hdus : HDUsequence 其中,可选HDU或PYTHON:其顺序,可选

HDU对象包括 HDUList . 应该是HDU类的实例,比如 ImageHDUBinTableHDU .

file : file-like objectbytes ,可选Python:类文件对象,字节,可选

与关联的打开的物理文件 HDUList 或包含FITS文件内容的bytes对象。

append(hdu)[源代码]#

将新的HDU附加到 HDUList .

参数:
hdu : HDUHDU

HDU添加到 HDUList .

close(output_verify='exception', verbose=False, closed=True)[源代码]#

关闭关联的FITS文件和memmap对象(如果有)。

参数:
output_verify : strPython :字符串

输出验证选项。一定是其中之一 "fix""silentfix""ignore""warn" ,或 "exception" 。也可以是以下各项的任意组合 "fix""silentfix" 使用 "+ignore"+warn ,或 +exception" (e.g. `` “修复+警告”)。看见 验证选项 更多信息。

verbose : bool布尔

什么时候? True ,打印出详细的消息。

closed : bool布尔

什么时候? True ,关闭基础文件对象。

copy()#

返回HDUList的浅拷贝。

返回:
copyHDUListHDUList

这是一个浅显的复制品 HDUList 对象。

fileinfo(index)[源代码]#

返回一个字典,详细说明在任何关联文件中索引的HDU的位置信息。这些值只有在读取或写入关联文件之后才有效,而不会对 HDUList .

参数:
index : intPython :整型

要返回其信息的HDU的索引。

返回:
fileinfo : dictNonePYTHON:DICT或PYTHON:无

字典详细说明了相关文件中索引HDU的位置信息。退换商品 None 当HDU不与文件关联时。

字典内容:

价值

文件

与HDU关联的文件对象

文件名

关联文件对象的名称

文件格式

打开文件的模式(readonly、update、append、denywrite、ostream)

调整大小

什么时候把它标记出来 True 指示自上次读/写以来已调整数据大小,因此返回的值可能无效。

hdrLoc公司

文件头的起始字节位置

达洛克

文件中数据块的起始字节位置

数据跨度

数据大小(包括填充)

filename()[源代码]#

返回与HDUList对象关联的文件名(如果存在)。否则返回None。

返回:
filename : strPython :字符串

一个字符串,包含与HDUList对象关联的文件名(如果存在关联)。否则返回NONE。

flush(output_verify='fix', verbose=False)[源代码]#

强制写入 HDUList 返回到文件(仅适用于附加和更新模式)。

参数:
output_verify : strPython :字符串

输出验证选项。一定是其中之一 "fix""silentfix""ignore""warn" ,或 "exception" 。也可以是以下各项的任意组合 "fix""silentfix" 使用 "+ignore"+warn ,或 +exception" (e.g. `` “修复+警告”)。看见 验证选项 更多信息。

verbose : bool布尔

什么时候? True ,打印详细消息

classmethod fromfile(fileobj, mode=None, memmap=None, save_backup=False, cache=True, lazy_load_hdus=True, ignore_missing_simple=False, **kwargs)[源代码]#

创建一个 HDUList 从一个类似于实例的文件。

实际实施 fitsopen() ,一般不应直接使用。使用 open() 而是(有关此方法可接受的参数的详细信息,请参阅其文档)。

classmethod fromstring(data, **kwargs)[源代码]#

创建一个 HDUList 实例来自包含整个FITS文件的字符串或其他内存中数据缓冲区。类似 HDUList.fromfile() ,但不接受mode或memmap参数,因为它们只与读取磁盘上的文件有关。

这对于与其他库(如CFITSIO)的接口非常有用,也可能对流式应用程序有用。

参数:
data : str ,:术语:类似缓冲器等。Python:str,:Term:Buffer-like,等等。

包含整个FITS文件的字符串或其他内存缓冲区。类似缓冲区的对象包括 bytesbytearraymemoryview ,以及 ndarray 。应该注意,如果内存是只读(例如Python字符串),则返回的 HDUList 的数据部分也将是只读的。

**kwargs : dictPython :词典

可选关键字参数。看到了吗 astropy.io.fits.open() 有关详细信息。

返回:
hdul : HDUListHDUList

HDUList 对象表示内存中的FITS文件。

index_of(key)[源代码]#

从中获取HDU的索引 HDUList .

参数:
key : intstrtuple 的 (strint )或 HDUPYTHON:INT,PYTHON:STR,PYTHON:元组(PYTHON:STR,PYTHON:INT)或HDU

识别HDU的键。如果 key 是元组,它的形式 (name, ver) 在哪里? ver 是一个 EXTVER 必须与正在搜索的HDU匹配的值。

如果键不明确(例如有多个“SCI”扩展名),则返回第一个匹配项。要获得更精确的匹配,请使用 (name, ver) 一对。

如果连 (name, ver) pair是不明确的(它不应该是,但这不是不可能的)数字索引必须用于索引重复的HDU。

什么时候? key 是一个HDU对象,此函数返回 HDUList .

返回:
index : intPython :整型

中HDU的索引 HDUList .

加薪:
ValueError

如果 key 是一个HDU对象,但在中找不到它 HDUList .

KeyError

如果 key 在中找不到扩展名、扩展名或扩展名和版本的元组 HDUList .

info(output=None)[源代码]#

在此总结HDU的信息 HDUList .

请注意,此函数将其结果打印到控制台---它不返回值。

参数:
output : file-like objectbool ,可选Python:类文件对象或bool,可选

要将输出写入的类似文件的对象。如果 False ,不输出到文件,而是返回表示HDU信息的元组列表。写信给 sys.stdout 默认情况下。

insert(index, hdu)[源代码]#

将HDU插入 HDUList 在给定的 index .

参数:
index : intPython :整型

在其之前插入新HDU的索引。

hdu : HDUHDU

要插入的HDU对象

pop(index=-1)[源代码]#

从列表中删除项目并将其返回。

参数:
index : intstrtuple 的 (strint ),可选PYTHON:INT,PYTHON:STR,PYTHON:tuple of(PYTHON:STR,PYTHON:INT),可选

整数值 index 指示从哪个位置开始 pop() 移除并返回HDU。字符串值或元组 (string, int) 用作识别要卸下和返回的HDU的键。如果 key 是元组,它的形式 (key, ver) 在哪里? ver 是一个 EXTVER 必须与正在搜索的HDU匹配的值。

如果键不明确(例如有多个“SCI”扩展名),则返回第一个匹配项。要获得更精确的匹配,请使用 (name, ver) 一对。

如果连 (name, ver) 不明确的索引对必须是重复的数字索引。

返回:
hdu : HDUHDU

HDU对象位于 index 或具有指定的名称和版本 index .

readall()[源代码]#

将所有hdu的数据读入内存。

update_extend()[源代码]#

如果主标头需要关键字,请确保 EXTEND 它有它而且它是正确的。

writeto(fileobj, output_verify='exception', overwrite=False, checksum=False)[源代码]#

写下 HDUList 到一个新文件。

参数:
fileobj : strfile-like objectpathlib.PathPYTHON:字符串,PYTHON:类似文件的对象或路径

要写入的文件。如果文件对象,则必须以可写模式打开。

output_verify : strPython :字符串

输出验证选项。一定是其中之一 "fix""silentfix""ignore""warn" ,或 "exception" 。也可以是以下各项的任意组合 "fix""silentfix" 使用 "+ignore"+warn ,或 +exception" (e.g. `` “修复+警告”)。看见 验证选项 更多信息。

overwrite : bool ,可选可选的布尔

如果 True ,覆盖输出文件(如果存在)。引发 OSError 如果 False 并且输出文件存在。默认为 False .

checksum : bool布尔

什么时候? True 两者相加 DATASUMCHECKSUM 卡到所有HDU的标题写入文件。

笔记

本地支持GZIP、ZIP和BZIP2压缩算法。压缩模式由文件扩展名(分别为‘.gz’、‘.zip’或‘.bz2’)确定。也可以传递压缩文件对象,例如 gzip.GzipFile