support_nddata¶

astropy.nddata.support_nddata(_func=None, accepts=<class 'astropy.nddata.nddata.NDData'>, repack=False, returns=None, keeps=None, **attribute_argument_mapping)[ソース]¶

トリムパッケージは、NDDataインスタンスを受け取り、その属性を関数パラメータ伝達の関数とすることができる。

パラメータ

_func呼び出し可能、無、オプション: 装飾や装飾の機能 None もし工場として使えば。最初の位置パラメータは data 麻痺配列を取ります名前を上書きすることができますので、ご参照ください attribute_argument_mapping 論争する。デフォルト値は None それがそうです。
accepts類、オプション: クラスまたはサブクラス、クラスまたはサブクラス NDData これは関数を呼び出す前にパケットを解くべきである.デフォルト値は NDData
repackブル値、オプション: たぶん True 関数呼び出しをパッケージした後に再び戻って入力クラスに変換すべきかどうか.デフォルト値は False それがそうです。

注釈

きっと True もしそのいずれかが returns あるいは…。 keeps 指定されています。
returns反復可能、無、オプション: クラスに返却値を設定すべき文字列を含む反復器.例えば、関数がデータおよびマスクを返す場合、 ['data', 'mask'] それがそうです。もし None 関数は1つのパラメータのみを返すと仮定する： 'data' それがそうです。デフォルト値は None それがそうです。

注釈

きっと None もし repack=False それがそうです。
keeps反復可能である。ありません、選ぶことができます: 元の入力からどの値を返しクラスにコピーすべきかを示す文字列を含む反復変数。もし…。 None 属性は何もコピーされていないと仮定する.デフォルト値は None それがそうです。

注釈

きっと None もし repack=False それがそうです。
attribute_argument_mapping :: キーワードパラメータは、任意に、どの関数パラメータが入力上のどの属性として解釈されるべきかを示す。デフォルトでは，この関数が使用されると仮定する. data パラメータは第1のパラメータとして使用されるが，第1のパラメータが呼び出されると input 一人で通過すべきだ support_nddata(..., data='input') このイベントに参加します。

返品

decorator_factory or decorated_function呼び戻すことができる: もし _func=None これは装飾符に戻ります。そうでなければ、修飾されたものに戻ります。 _func それがそうです。

注意事項

もし属性が NDData しかし，対応する関数パラメータがなければ警告が表示される.

属性が設定されている場合 NDData 明示的パラメータが与えられると、明示的に与えられたパラメータを使用して警告が表示される。

サポートの属性には、以下のことがあります。

mask
unit
wcs
meta
uncertainty
flags

実例.

この関数は、データのためのNumpy配列と、いくつかのWCS情報とを受け取る。 wcs キーワードパラメータ：：

def downsample(data, wcs=None):
    # downsample data and optionally WCS here
    pass

しかし、あなたはNDDataの例を持っているかもしれません wcs 属性セット、そしてご利用いただけますようお願いいたします downsample(my_nddata) WCS情報を自動的に(存在すれば)自動的に伝達させる. wcs キーワードパラメータ。

この装飾記号はこれを実現するために使用することができます

@support_nddata
def downsample(data, wcs=None):
    # downsample data and optionally WCS here
    pass

現在は従来のようにこの関数を呼び出し，データとWCSをそれぞれ指定することができ，NDDataインスタンスを渡すことも可能である. data 論争する。

ナビゲーション

support_nddata¶