报头

Header

class astropy.io.fits.Header(cards=[], copy=False)

基类：object

适合标题类。这个类同时公开dict类接口和list-like接口以适合头文件。

头可以按关键字索引，并且像dict一样，将返回相关的值。当标题包含具有重复关键字的卡片时，只返回第一张具有给定关键字的卡片的值。也可以使用2元组作为形式（keyword，n）的索引——如果存在重复的关键字，则返回带有该关键字的第n个值。

例如：：

>>> header['NAXIS']
0
>>> header[('FOO', 1)]  # Return the value of the second FOO keyword
'foo'

标题也可以按卡号编制索引：

>>> header[0]  # Return the value of the first card in the header
'T'

注释关键字（如HISTORY和COMMENT）是特殊情况：当用“HISTORY”或“COMMENT”索引头对象时，将返回所有历史/注释值的列表：

>>> header['HISTORY']
This is the first history entry in this header.
This is the second history entry in this header.
...

有关使用标头的更多详细信息，请参阅Astropy文档。

构建一个 Header 从iterable和/或文本文件。

参数

卡 ：列表 Card 对象，可选列表

用于初始化标头的卡。也允许其他 Header （或） dict -比如）物体。

在 1.2 版更改: 允许 cards 成为一个 dict -像物体一样。

copy可选的布尔

如果 True 复制 cards 如果他们是另一个 Header 实例。默认为 False .

1.3 新版功能.

add_blank(value='', before=None, after=None)

添加一张空白卡片。

参数

value可选的STR

要添加的文本。

beforestr或int，可选

与中相同 Header.update

afterstr或int，可选

与中相同 Header.update

add_comment(value, before=None, after=None)

添加 COMMENT 卡。

参数

valueSTR

要添加的文本。

beforestr或int，可选

与中相同 Header.update

afterstr或int，可选

与中相同 Header.update

add_history(value, before=None, after=None)

添加 HISTORY 卡。

参数

valueSTR

要添加的历史文本。

beforestr或int，可选

与中相同 Header.update

afterstr或int，可选

与中相同 Header.update

append(card=None, useblanks=True, bottom=False, end=False)

在头的末尾追加一个新的关键字+值卡，类似于 list.append .

默认情况下，如果标题中的最后一张卡片有注释关键字，这将在注释之前附加新关键字（除非新关键字也是注释）。

也不同于 list.append 因为它可以不带参数地调用：在本例中，一张空白卡片被附加到头的末尾。在这种情况下，所有关键字参数都被忽略。

参数

cardstr，元组

关键字或（关键字，值， [评论] )表示单个头卡的元组；注释是可选的，在这种情况下可以使用2元组

useblanks可选的布尔

如果页眉末尾有空白卡片，请更换第一张空白卡片，使页眉中的卡片总数不会增加。否则保留空白卡的数量。

bottom可选的布尔

如果为真，则在最后一张非注释卡之后追加，而不是在最后一张非空白卡片之后追加。

end可选的布尔

如果为True，则忽略useblanks和bottom选项，并在头的末尾追加。

property cards

构成此标头的底层物理卡；可以查看，但不应直接修改。

clear()

从页眉中取出所有卡片。

property comments

查看与每个关键字关联的注释（如果有）。

例如，要查看对NAXIS关键字的注释：

>>> header.comments['NAXIS']
number of data axes

也可以通过此界面更新注释：

>>> header.comments['NAXIS'] = 'Number of data axes'

copy(strip=False)

复制 Header .

在 1.3 版更改: copy.copy 和 copy.deepcopy 在一 Header 将调用此方法。

参数

strip可选的布尔

如果 True ，删除特定于某个标准HDU类型的任何标头，以便此标头可以在其他HDU中使用。

返回

页眉

一个新的 Header 实例。

count(keyword)

返回标头中给定关键字的计数，类似于 list.count 如果Header对象被视为关键字列表。

参数

keywordSTR

要在标头中计数实例的关键字

extend(cards, strip=True, unique=False, update=False, update_first=False, useblanks=True, bottom=False, end=False)

将多个关键字+值卡附加到标头的末尾，类似于 list.extend .

参数

cards可迭代的

一个iterable（关键字，值， [评论] )元组；参见 Header.append .

strip可选的布尔

删除任何只对特定类型的hdu有意义的关键字，以便只从扩展头或卡片列表中添加更一般的关键字（默认值： True ）

unique可选的布尔

如果 True 简单地确保没有重复的关键字被丢弃。例外是注释关键字（COMMENT、HISTORY等）：只有当它们的值匹配时，它们才被视为重复项。

update可选的布尔

如果 True ，使用输入标头中重复关键字中的值和注释更新当前标头。这将取代 unique 争论。评论关键字的处理方式与 unique=True .

update_first可选的布尔

如果头中的第一个关键字是“SIMPLE”，而输入标头中的第一个关键字是“XTENSION”，则“SIMPLE”关键字将替换为“XTENSION”关键字。同样，如果头中的第一个关键字是“XTENSION”，而输入标头中的第一个关键字是“SIMPLE”，则“XTENSION”关键字将替换为“SIMPLE”关键字。否则，对于结果头是有效的主头还是扩展头，这种行为是愚蠢的。这主要是为了支持与旧版本的向后兼容性 Header.fromTxtFile 方法，并且仅在以下情况下适用 update=True .

使用空白，底部，结尾可选的布尔

这些参数传递给 Header.append() 在页眉上添加新的卡片。

classmethod fromfile(fileobj, sep='', endcard=True, padding=True)

类似 Header.fromstring() ，但从给定的文件（如对象或文件名）中读取头字符串。

参数

fileobjstr，像文件一样

从中读取FITS头的文件名或类似于打开文件的对象。对于打开的文件句柄，文件指针必须位于头的开头。

sep可选的STR

分隔线将卡片彼此分开的字符串，如换行符。默认情况下，没有卡片分隔符（就像在raw FITS文件中一样）。

endcard可选的布尔

如果为True（默认值），则页眉必须以结束卡结尾才能被视为有效。如果没有找到端卡 OSError 提高了。

padding可选的布尔

如果为True（默认值），则需要将页眉填充为2880的倍数，即FITS header块大小。否则，将忽略任何填充或缺少填充。

返回

页眉

一个新的 Header 实例。

classmethod fromkeys(iterable, value=None)

类似 dict.fromkeys() --创建新的 Header 从一个iterable关键字和一个可选的默认值。

这种方法对于创建真实的FITS头文件可能不是特别有用，但是它对于测试是有用的。

参数

iterable

任何返回代表FITS关键字的字符串的iterable。

value可选择的

要分配给每个关键字的默认值；必须是FITS关键字的有效类型。

返回

页眉

一个新的 Header 实例。

classmethod fromstring(data, sep='')

从包含整个标头数据的字节字符串创建HDU标头。

参数

dataSTR或字节

包含整个标头的字符串或字节。在字节的情况下，它们将使用拉丁语-1进行解码（FITS头中只允许使用纯ASCII字符，但是拉丁语-1允许我们保留格式错误的FITS文件中可能出现的任何无效字节）。

sep可选的STR

分隔线将卡片彼此分开的字符串，如换行符。默认情况下，没有卡片分隔符（就像在raw FITS文件中一样）。一般来说，这只适用于页眉打印为文本（例如每张卡片后面有换行符）并且您希望创建一个新的 Header 通过复制/粘贴。

返回

页眉

一个新的 Header 实例。

实例

>>> from astropy.io.fits import Header
>>> hdr = Header({'SIMPLE': True})
>>> Header.fromstring(hdr.tostring()) == hdr
True

如果要创建 Header 从打印文本来看，不必像在FITS文件中那样有精确的二进制结构，卡的长度为80字节。相反，每一张“卡片”可以换行结束，只要“看上去”适合标题，就不必填充到完整的卡片长度：

>>> hdr = Header.fromstring("""\
... SIMPLE  =                    T / conforms to FITS standard
... BITPIX  =                    8 / array data type
... NAXIS   =                    0 / number of array dimensions
... EXTEND  =                    T
... """, sep='\n')
>>> hdr['SIMPLE']
True
>>> hdr['BITPIX']
8
>>> len(hdr)
4

classmethod fromtextfile(fileobj, endcard=False)

从简单的文本文件或类似文件的对象中读取头。

等同于：

>>> Header.fromfile(fileobj, sep='\n', endcard=False,
...                 padding=False)

参见

fromfile

get(key, default=None)

类似 dict.get() --返回与标头中关键字关联的值，如果找不到关键字，则返回默认值。

参数

keySTR

标题中可能包含也可能不包含的关键字。

default可选择的

在标头中找不到关键字时返回的默认值。

返回

价值

与给定关键字关联的值，如果关键字不在标头中，则为默认值。

index(keyword, start=None, stop=None)

如果头中给定关键字的第一个实例类似于 list.index 如果Header对象被视为关键字列表。

参数

keywordSTR

要在标头中所有关键字的列表中查找的关键字

start可选的

指数的下限

stop可选的

索引的上限

insert(key, card, useblanks=True, after=False)

在给定位置将新的关键字+值卡插入头中，类似于 list.insert .

参数

keyint、str或tuple

标题关键字列表中的索引，新关键字应在其前面插入，或新关键字应在其前面插入的关键字的名称。也可以接受一个（keyword，index）元组来插入重复的关键字。

cardstr，元组

关键字或（关键字，值， [评论] )元组；参见 Header.append

useblanks可选的布尔

如果页眉末尾有空白卡片，请更换第一张空白卡片，使页眉中的卡片总数不会增加。否则保留空白卡的数量。

after可选的布尔

如果设置为 True ，插入 之后 指定的索引或关键字，而不是在它之前。默认为 False .

items()

喜欢 dict.items() .

keys()

喜欢 dict.keys() --直接在 Header 实例具有相同的行为。

pop(*args)

作品像 list.pop() 如果没有提供参数或索引参数，则 dict.pop() .

popitem()

类似 dict.popitem() .

remove(keyword, ignore_missing=False, remove_all=False)

从头中移除给定关键字的第一个实例，类似于 list.remove 如果Header对象被视为关键字列表。

参数

keywordSTR

要删除标头中第一个实例的关键字。

ignore_missing可选的布尔

如果为True，则忽略缺少的关键字。否则，如果头中不存在关键字，则引发KeyError。

remove_all可选的布尔

为True时，将删除关键字的所有实例。否则只删除给定关键字的第一个实例。

rename_keyword(oldkeyword, newkeyword, force=False)

在标题中重命名卡片的关键字。

参数

oldkeywordSTR或INT

旧关键字或卡片索引

newkeywordSTR

新关键词

force可选的布尔

什么时候？ True ，如果新关键字已存在于标头中，则强制创建重复关键字。否则 ValueError 提高了。

set(keyword, value=None, comment=None, before=None, after=None)

设置指定关键字的值和/或注释和/或位置。

如果标头中不存在关键字，则会在指定位置创建新关键字，如果未指定位置，则会将新关键字追加到标头的末尾。

这种方法类似于 Header.update() 在Astropy v0.1之前。

注解

应该指出的是 header.set(keyword, value) 和 header.set(keyword, value, comment) 相当于 header[keyword] = value 和 header[keyword] = (value, comment) 分别。

也可以相对于现有关键字插入新关键字，例如：

>>> header.insert('NAXIS1', ('NAXIS', 2, 'Number of axes'))

在现有关键字前插入，或：

>>> header.insert('NAXIS', ('NAXIS1', 4096), after=True)

在现有关键字后插入。

使用的唯一优势 Header.set() 它很容易取代 Header.update() 在概念上和函数签名方面。

参数

keywordSTR

标题关键字

value可选的STR

要为给定关键字设置的值；如果没有，则保留现有值，但“”可用于设置空值

comment可选的STR

要为给定关键字设置的注释；如果没有，则保留现有注释，但是 '' 可用于设置空白注释

beforestr，int，可选

关键字的名称，或 Card 在此之前，此卡应位于页眉中。争论 before 优先于 after 如果两者都有规定。

afterstr，int，可选

关键字的名称，或 Card 之后，该卡应位于页眉中。

setdefault(key, default=None)

类似 dict.setdefault() .

tofile(fileobj, sep='', endcard=True, padding=True, overwrite=False)

将标头写入文件或类似文件的对象。

默认情况下，这会像写入FITS文件一样写入头文件，包括端卡并填充到下一个2880字节的倍数。然而，这方面的问题可能是可以控制的。

参数

fileobjstr，file，可选

文件的路径名，或打开的文件句柄或类似文件的对象

sep可选的STR

用来分隔卡片的字符或字符串。默认情况下没有分隔符，但可以使用 '\\n' ，例如，用新行分隔每张卡

endcard可选的布尔

如果 True （默认）将结束卡添加到头字符串的末尾

padding可选的布尔

如果 True （默认）用空格将字符串填充到下一个2880个字符的倍数

overwrite可选的布尔

如果 True ，覆盖输出文件（如果存在）。引发 OSError 如果 False 并且输出文件存在。默认为 False .

在 1.3 版更改: overwrite 替换已弃用的 clobber 争论。

tostring(sep='', endcard=True, padding=True)

返回标头的字符串表示形式。

默认情况下，它在卡片之间不使用分隔符，添加结束卡片，并用空格填充字符串，直到下一个2880字节的倍数。也就是说，它返回的头与在FITS文件中显示的完全一样。

参数

sep可选的STR

用来分隔卡片的字符或字符串。默认情况下没有分隔符，但可以使用 '\\n' ，例如，用新行分隔每张卡

endcard可选的布尔

如果为True（默认），则将结束卡添加到头字符串的末尾

padding可选的布尔

如果为True（默认值），则用空格将字符串填充到下一个2880个字符的倍数

返回

sSTR

表示FITS头的字符串。

totextfile(fileobj, endcard=False, overwrite=False)

将标题作为文本写入文件或类似文件的对象。

等同于：

>>> Header.tofile(fileobj, sep='\n', endcard=False,
...               padding=False, overwrite=overwrite)

在 1.3 版更改: overwrite 替换已弃用的 clobber 争论。

参见

tofile

update(*args, **kwargs)

用新关键字值更新标题，更新现有关键字的值，否则追加新关键字；类似于 dict.update .

update 接受dict-like对象或iterable。在前一种情况下，键必须是头关键字，并且值可以是标量值或（value，comment）元组。对于iterable，项必须是（keyword，value）元组或（keyword，value，comment）元组。

还接受任意参数，在这种情况下，将再次调用update（），并将kwargs dict作为其唯一的参数。也就是说，

>>> header.update(NAXIS1=100, NAXIS2=100)

等于：

header.update({'NAXIS1': 100, 'NAXIS2': 100})

警告

因为这种方法的工作原理与 dict.update 它与 Header.update() Astropy v0.1中的方法。旧API的使用 贬低 很长时间了，现在被移除了。旧API的大多数使用可以替换为：

• 替换：：

  header.update(keyword, value)
  

  用：

  header[keyword] = value
  

• 替换：：

  header.update(keyword, value, comment=comment)
  

  用：

  header[keyword] = (value, comment)
  

• 替换：：

  header.update(keyword, value, before=before_keyword)
  

  用：

  header.insert(before_keyword, (keyword, value))
  

• 替换：：

  header.update(keyword, value, after=after_keyword)
  

  用：

  header.insert(after_keyword, (keyword, value),
                after=True)
  

也见 Header.set() 这是一种新方法，它提供了与旧方法类似的接口 Header.update() 可能会让过渡变得更容易一些。

values()

喜欢 dict.values() .