文書処理と便利機能¶
open()
¶
- astropy.io.fits.open(name, mode='readonly', memmap=None, save_backup=False, cache=True, lazy_load_hdus=None, ignore_missing_simple=False, **kwargs)¶
FITSファイルを開いて返すためのプラント関数
HDUList
物体です。- パラメータ
- name :文字列、類似ファイル、または
pathlib.Path
文字列、ファイル状、または 開く書類です。
- mode文字列、オプション
モード、‘readonly’,‘update’,‘append’,‘denywrite’または‘ostream’を開きます。デフォルト値は‘readonly’です。
もし
name
すでに開いているファイルオブジェクトですmode
ファイルを開くパターンにマッチしなければならず,(Rb),更新(rb+),追加(ab+),ostream(W),書き込み拒否(Rb))のみを読む.- memmapブル値、オプション
メモリマッピングを使用しますか?この値は構成項から得られる
astropy.io.fits.Conf.use_memmap
それがそうです。デフォルト値はTrue
それがそうです。- save_backupブル値、オプション
ファイルが更新モードまたは追加モードで開いている場合、これは、任意の変更をリフレッシュする前に元のファイルのバックアップが保存されることを保証する。このバックアップは、元のファイルと同名であり、“.bak”が付加されている。“file.bak”がすでに存在する場合は、“file.bak.1”を使用し、以下同様である。デフォルト値は
False
それがそうです。- cacheブル値、オプション
ファイル名がURLであれば
download_file
このファイルを開くために使用されます。これは,Astropyのダウンロードキャッシュにファイルをローカルに保存するかどうかを指定する.デフォルト値はTrue
それがそうです。- lazy_load_hdusブル値、オプション
オープン時にFITSファイルのすべてのHDUおよびヘッダが直ちに読み出されることを回避する。FITSは、ファイルをスキャンし、すべてのヘッダファイルを読み取ることなく、ファイル中のすべてのHDUの数およびオフセットを決定することができないので、大きなファイルに特に有用な最適化である。デフォルト値は
True
それがそうです。遅延ロードを無効にして、すべてのHDUをすぐに読み込むためには、ご利用ください
lazy_load_hdus=False
それがそうです。これは、例えば、遅延ロードを有効にする場合には、事故を低減することができる。len(hdul)
HDUの数を決定するためにFITSファイル全体を読み込む必要があることを意味するので、遅くなるかもしれません。lazy_load_hdus=False
ファイルを開いた後にすべてのHDUがロードされていることを確認します。バージョン 1.3 で追加.
- uintブル値、オプション
記号整数データが解釈されています
BZERO
中心的な価値ですBSCALE == 1
符号なし整数データとする.例えばint16
以下の機能を持つデータBZERO = 32768
そしてBSCALE = 1
と思われていますuint16
データです。デフォルト値はTrue
したがって,擬似符号なし整数約束を仮定する.- ignore_missing_endブル値、オプション
開いて欠けている
END
最後のタイトルのカードですデフォルト値はFalse
それがそうです。- ignore_missing_simpleブル値、オプション
Simpleキーワードが足りない場合は、異常を起こしてはいけません。デフォルト値は
False
それがそうです。バージョン 4.2 で追加.
- checksumBool、str、オプション
もし
True
この2つを検証しますDATASUM
そしてCHECKSUM
カード値(HDUヘッダに存在する場合)は、ファイル内のすべてのHDUのヘッダおよびデータと一致する。チェックサムの既存のファイルの更新は、このパラメータに値‘REMOVE’が付与されない限り、既存のチェックサムを保持し、更新する(この場合、チェックサムおよびDATASUM値はチェックされない)、ファイルの変更が保存されているときに削除される。デフォルト値はFalse
それがそうです。- disable_image_compressionブル値、オプション
- do_not_scale_image_dataブル値、オプション
もし
True
なお、読み出しにはBSCALE/BZEO値スケーリング画像データは使用しない。デフォルト値はFalse
それがそうです。- character_as_bytesブル値、オプション
文字列であるかどうかはバイトを返し,そうでなければUnicode文字列を返すが,これはメモリマッピングを考慮せず,アクセス時に列全体をメモリにロードする.デフォルト値は
False
それがそうです。- ignore_blankブル値、オプション
- scale_backブル値、オプション
もし
True
スケーリングされた画像データを含むファイルの変更を保存する場合は、データを元のタイプに復元し、元のBSCALE/BZEO値を再適用してください。データに対して浮動小数点演算を行った後に整数値に削減すると,精度が低下する可能性がある.デフォルト値はFalse
それがそうです。- output_verify応力.応力
Output verification option. Must be one of
"fix"
,"silentfix"
,"ignore"
,"warn"
, or"exception"
. May also be any combination of"fix"
or"silentfix"
with"+ignore"
,+warn
, or+exception" (e.g. ``"fix+warn"
). See 検証オプション for more info.
- name :文字列、類似ファイル、または
- 返品
writeto()
¶
- astropy.io.fits.writeto(filename, data, header=None, output_verify='exception', overwrite=False, checksum=False)[ソース]¶
提供されたデータ/タイトルを使用して新しいFITSファイルを作成します。
- パラメータ
- filename類似パスや類似ファイル
記入するファイルです。開いている場合、‘wb’または‘ab+’のような書き込み可能バイナリモードで開かれなければならない。
- data :配列または
recarray
あるいは…。Group
配列や 新しいファイルのデータを書き込む
- タイトル :
Header
相手、オプションHeaderオブジェクト、オプション 以下に関連するヘッダ
data
それがそうです。もしNone
提供されたデータのための適切なタイプのヘッダが作成される。このパラメータはオプションである.- output_verify応力.応力
Output verification option. Must be one of
"fix"
,"silentfix"
,"ignore"
,"warn"
, or"exception"
. May also be any combination of"fix"
or"silentfix"
with"+ignore"
,+warn
, or+exception" (e.g. ``"fix+warn"
). See 検証オプション for more info.- overwriteブル値、オプション
もし
True
もしあれば、出力ファイルを上書きします(存在すれば)。1つの問題を引き起こしましたOSError
もしFalse
また,出力ファイルが存在する.デフォルト値はFalse
それがそうです。バージョン 1.3 で変更:
overwrite
時代遅れのものに取って代わるclobber
論争する。- checksumブル値、オプション
もし
True
同時に2つ追加しましたDATASUM
そしてCHECKSUM
すべてのHDUのカードヘッダはファイルに書き込まれています。
info()
¶
- astropy.io.fits.info(filename, output=None, **kwargs)[ソース]¶
FITSファイルに要約情報を印刷します。
これは、各拡張子の名前、タイプ、タイトル長、データ形状、およびタイプを含む。
- パラメータ
- filename類似パスや類似ファイル
そこから情報を得るのに適したファイル。開いている場合、モードは、rb、rb+またはab+(すなわち、ファイルは読み取り可能でなければならない)のうちの1つでなければならない。
- outputファイル、bool、オプション
出力された類似ファイルのオブジェクトを書き込む.もし…。
False
ファイルに出力するのではなく、HDU情報を表すタプルリストを返す。記入する.sys.stdout
デフォルトの場合。- kwargs
伝達する他のキーワードパラメータは
astropy.io.fits.open
それがそうです。 注: この関数設定ignore_missing_end=True
デフォルトの場合。
printdiff()
¶
- astropy.io.fits.printdiff(inputa, inputb, *args, **kwargs)[ソース]¶
FITSファイル全体,FITSファイルを含むFITSファイルの2つの部分を比較する.
HDUList
相手と協力HDU
物体です。- パラメータ
- 入力 :str、
HDUList
対象、またはHDU
客体.文字列は FITSファイルのファイル名、
HDUList
あるいは、あるいはHDU
比較の対象inputb
それがそうです。- 入力b :str、
HDUList
対象、またはHDU
客体.文字列は FITSファイルのファイル名、
HDUList
あるいは、あるいはHDU
比較の対象inputa
それがそうです。- EXT、EXTAME、EXTAVER
Additional positional arguments are for extension specification if your inputs are string filenames (will not work if
inputa
andinputb
areHDU
objects orHDUList
objects). They are flexible and are best illustrated by examples. In addition to using these arguments positionally you can directly call the keyword parametersext
,extname
.内線番号:
printdiff('inA.fits', 'inB.fits', 0) # the primary HDU printdiff('inA.fits', 'inB.fits', 2) # the second extension printdiff('inA.fits', 'inB.fits', ext=2) # the second extension
名前、つまり、
EXTNAME
値(唯一なら)。EXTNAME
値は大小を区別しない。Printdiff(‘inA.fits’,‘inB.fits’,‘sci’)printdiff(‘inA.fits’,‘inB.fits’,extname=“sci‘)#等価物
組み合わせて
EXTNAME
そしてEXTVER
個々のパラメータまたはタプルとして:printdiff('inA.fits', 'inB.fits', 'sci', 2) # EXTNAME='SCI' # & EXTVER=2 printdiff('inA.fits', 'inB.fits', extname='sci', extver=2) # equivalent printdiff('inA.fits', 'inB.fits', ('sci', 2)) # equivalent
不明確または衝突の規範は異常を引き起こす:
printdiff('inA.fits', 'inB.fits', ext=('sci', 1), extname='err', extver=2)
- kwargs
伝達する他のキーワードパラメータは
FITSDiff
それがそうです。
- 入力 :str、
注意事項
主な用途は
printdiff
FITS差分レポートを迅速に印刷し,書き込みを可能にする機能である.sys.stdout
それがそうです。差分レポートをファイルとして保存しますので、ご利用くださいFITSDiff
直接行きましょう。
append()
¶
- astropy.io.fits.append(filename, data, header=None, checksum=False, verify=True, **kwargs)[ソース]¶
ファイル名が存在する場合は、ヘッダ/データをFITSファイルに付加し、存在しなければ作成する。
もしただ
data
最小ヘッダが作成されます。- パラメータ
- filename類似パスや類似ファイル
記入するファイルです。開いている場合、新しいファイルでない限り、更新(rb+)のために開かれなければならず、その後、追加(ab+)のために開かれなければならない。書類や
GzipFile
更新されたオブジェクトを開くと、戻った後にオフになります。- data : array,
Table
あるいは、あるいはGroup
配列しています 追加のための新しいデータ。
- タイトル :
Header
相手、オプションHeaderオブジェクト、オプション 以下に関連するヘッダ
data
それがそうです。もし…。None
提供されたデータオブジェクトのための適切なヘッダが作成されます。- checksumブル値、オプション
いつ?
True
2つを同時に追加するDATASUM
そしてCHECKSUM
ファイルを書き込む際にHDUのヘッダにカードを追加します。- verifyブル値、オプション
いつ?
True
すると,付加する前に既存のFITSファイルを読み込み,その正しさを検証する.いつですかFalse
これにより,ファイルの末尾にコンテンツを簡単に付加する.設けるverify
至るFalse
はいずっと速いです。- kwargs
他のパラメータは以下のように伝達されます
update()
¶
- astropy.io.fits.update(filename, data, *args, **kwargs)[ソース]¶
指定された拡張子は,入力データ/ヘッダを用いて更新される.
- パラメータ
- filename類似パスや類似ファイル
更新するファイルです。開いている場合、モードは更新(RB+)でなければならない。開いたファイルオブジェクトや
GzipFile
オブジェクトは戻り時に閉じます。- data 配列:配列
Table
あるいは、あるいはGroup
配列しています 更新のための新しいデータ。
- タイトル :
Header
相手、オプションHeaderオブジェクト、オプション 以下に関連するヘッダ
data
それがそうです。もし…。None
提供されたデータオブジェクトのための適切なヘッダが作成されます。- EXT、EXTAME、EXTAVER
残りのパラメータは柔軟である:第3のパラメータは、データに関連するヘッダであってもよい。もし3つ目のパラメータがそうでなければ
Header
,it(および他の位置パラメータ)は拡張仕様と仮定される.ヘッダおよび拡張仕様は、キーワードパラメータであってもよい。例えば:update(file, dat, hdr, 'sci') # update the 'sci' extension update(file, dat, 3) # update the 3rd extension update(file, dat, hdr, 3) # update the 3rd extension update(file, dat, 'sci', 2) # update the 2nd SCI extension update(file, dat, 3, header=hdr) # update the 3rd extension update(file, dat, header=hdr, ext=5) # update the 5th extension
- **kwargs
伝達する他のキーワードパラメータは
astropy.io.fits.open
それがそうです。
getdata()
¶
- astropy.io.fits.getdata(filename, *args, header=None, lower=None, upper=None, view=None, **kwargs)[ソース]¶
FITSファイルの拡張子(およびオプションのヘッダ)からデータを取得する.
- パラメータ
- filename類似パスや類似ファイル
そこからデータのファイルを取得しなければならない.開いている場合、モードは、以下のRb、Rb+またはab+のうちの1つでなければならない。
- ext
残りのパラメータは仕様を拡張するために用いられる.それらは柔軟であり、例示によって最高の説明を得た。
追加的なパラメータはメインヘッダを表していません:
getdata('in.fits')
注釈
専属する.
getdata
:拡張子が指定されておらず、マスタがデータを含まない場合、getdata
1つ目から検索データを拡張しようと試みる.内線番号:
getdata('in.fits', 0) # the primary header getdata('in.fits', 2) # the second extension getdata('in.fits', ext=2) # the second extension
名前、つまり、
EXTNAME
値(唯一なら):getdata('in.fits', 'sci') getdata('in.fits', extname='sci') # equivalent
注意事項.
EXTNAME
大小を区別しない値組み合わせて
EXTNAME
およびEXTVER``を個別のパラメータまたはタプルとして::getdata('in.fits', 'sci', 2) # EXTNAME='SCI' & EXTVER=2 getdata('in.fits', extname='sci', extver=2) # equivalent getdata('in.fits', ('sci', 2)) # equivalent
不明確または衝突の規範は異常を引き起こす:
getdata('in.fits', ext=('sci',1), extname='err', extver=2)
- headerブル値、オプション
もし
True
HDUを指定したデータおよびヘッダは、タプル形式で返される。- 下、上ブル値、オプション
もし
lower
あるいは…。upper
あります。True
すると,返されたデータオブジェクト中のフィールド名はそれぞれ小文字または大文字に変換される.- viewNdarray、オプション
タイミングを与えると、データは呼び出しによって渡されます:パッケージは所与のndarrayサブクラスで返されます。
data.view(view)
- kwargs
伝達する他のキーワードパラメータは
astropy.io.fits.open
それがそうです。
- 返品
- 賃上げをする
- IndexError
検索の拡張で何のデータも見つからなければ。
getheader()
¶
- astropy.io.fits.getheader(filename, *args, **kwargs)[ソース]¶
FITSファイルの拡張子からヘッダを取得する.
- パラメータ
- filename類似パスや類似ファイル
そこからヘッダのファイルを取得します。開いたファイルオブジェクトであれば,そのパターンは以下のRb,Rb+またはab+のいずれかでなければならない).
- EXT、EXTAME、EXTAVER
残りのパラメータは仕様を拡張するために用いられる.ご参照ください
getdata
解釈/例に関する文書。- kwargs
伝達する他のキーワードパラメータは
astropy.io.fits.open
それがそうです。
- 返品
- タイトル :
Header
客体.見出し対象
- タイトル :
getval()
¶
- astropy.io.fits.getval(filename, keyword, *args, **kwargs)[ソース]¶
FITSファイルのヘッダからキーワード値を取得する.
- パラメータ
- filename類似パスや類似ファイル
適合ファイルまたはファイルオブジェクトの名前(開いている場合、モードは以下のRb、Rb+またはab+のうちの1つでなければならない)。
- keyword応力.応力
キーワード名.
- EXT、EXTAME、EXTAVER
残りのパラメータは仕様を拡張するために用いられる.参照してください
getdata
説明/例については、参照されたい。- kwargs
伝達する他のキーワードパラメータは
astropy.io.fits.open
それがそうです。 注: この関数は自動的に指定されるdo_not_scale_image_data = True
ファイルがオープンされると、修正されていないヘッダから値を検索することができる。
- 返品
- キーワード値.文字列、全体型、浮動小数点型
setval()
¶
- astropy.io.fits.setval(filename, keyword, *args, value=None, comment=None, before=None, after=None, savecomment=False, **kwargs)[ソース]¶
FITSファイルのヘッダからキーワードの値を設定する.
キーワードがすでに存在する場合、その値/注釈は更新される。カードが存在しない場合、新しいカードが作成され、指定された位置の前または後に配置される。もしなければ
before
あるいは…。after
最後に追加されますこの便利関数の効率は、ファイル中の複数のキーワードを更新する場合、ファイルを開いて更新、ヘッダを修正し、閉じたファイルに比べてはるかに低い。
- パラメータ
- filename類似パスや類似ファイル
FITSファイルまたはファイルオブジェクト(開いている場合)の名前は、モードはUPDATE(RB+)でなければならない。開いたファイルオブジェクトや
GzipFile
オブジェクトは戻り時に閉じます。- keyword応力.応力
キーワード名.
- value文字列、整型、浮動小数点型、オプション
キーワード値(デフォルト値:
None
修正しないという意味です)- comment文字列、オプション
キーワード注釈、(デフォルト:
None
修正しないという意味です)- before文字列、int、オプション
新しいカードのカードのキーワードまたはインデックスの名前が置かれます。この論点は
before
より優先するafter
両方が指定されている場合(デフォルト値:None
)。- after文字列、int、オプション
新しいカードのキーワードやカードインデックスの名前を置きます。(デフォルト:
None
)。- savecommentブル値、オプション
いつ?
True
既存のキーワードの現在の注釈を保持する.この論点はsavecomment
より優先するcomment
両方とも指定すれば。もし…。comment
指定されていない場合は、現在の備考(デフォルト値:False
)。- EXT、EXTAME、EXTAVER
残りのパラメータは仕様を拡張するために用いられる.参照してください
getdata
説明/例については、参照されたい。- kwargs
伝達する他のキーワードパラメータは
astropy.io.fits.open
それがそうです。 注: この関数は自動的に指定されるdo_not_scale_image_data = True
ファイルがオープンされると、修正されていないヘッダから値を検索することができる。
delval()
¶
- astropy.io.fits.delval(filename, keyword, *args, **kwargs)[ソース]¶
KeywordのすべてのインスタンスをFITSファイルのヘッダから削除する.
- パラメータ
- filename類似パスや類似ファイル
FITSファイルまたはファイルオブジェクト(開いている場合)の名前は、モードはUPDATE(RB+)でなければならない。開いたファイルオブジェクトや
GzipFile
オブジェクトは戻り時に閉じます。- keyword文字列、整型
キーワード名または索引
- EXT、EXTAME、EXTAVER
残りのパラメータは仕様を拡張するために用いられる.参照してください
getdata
説明/例については、参照されたい。- kwargs
伝達する他のキーワードパラメータは
astropy.io.fits.open
それがそうです。 注: この関数は自動的に指定されるdo_not_scale_image_data = True
ファイルがオープンされると、修正されていないヘッダから値を検索することができる。