NDArithmeticMixin

class astropy.nddata.NDArithmeticMixin

ベースクラス: object

NDDataオブジェクトに算術を追加するためのMixinクラス.

サブクラス化の際には、サブクラスがNDDataを主スーパークラスとするように、正しい順序でスーパークラスを列挙することを確保してください。参照してください NDDataArray 例を挙げましょう

注意事項

このような最も一般的な場合のみであるため，保存されている属性には制限がある.

- ``uncertainty`` : has to be something that has a `NDUncertainty`-like
  interface for uncertainty propagation
- ``mask`` : has to be something that can be used by a bitwise ``or``
  operation.
- ``wcs`` : has to implement a way of comparing with ``=`` to allow
  the operation.

しかし，特定の属性の処理を無効にすることを可能にする解決法があり，Results属性を設定するだけでよい. None あるいは既存の属性をコピーする(他の属性を無視する).例えば、非代表的な場合には NDUncertainty -同様のインタフェースを変更することができます propagate_uncertainties パラメータ入力 NDArithmeticMixin.add() それがそうです。 None 結果に不確実性はないということです False これは，第1オペランドの不確実性(第2オペランドに不確実性が存在しなければ)を結果とする不確実性を表す.この行為は，異なる算術演算の文書文字列でも解釈されている.

ユニットを分解しようとしないのは主に Quantity したがって，生成されるデータは次のような単位を持つ可能性がある. km/m 例えば100キロを5メートルで割るとだからこの密書はこのような行為をした。

実例.

このMixinと NDData ：

>>> from astropy.nddata import NDData, NDArithmeticMixin
>>> class NDDataWithMath(NDArithmeticMixin, NDData):
...     pass

インスタンス上の1つのオペランドと共に使用される：

>>> ndd = NDDataWithMath(100)
>>> ndd.add(20)
NDDataWithMath(120)

インスタンス上の2つのオペランドと共に使用される：

>>> ndd = NDDataWithMath(-4)
>>> ndd.divide(1, ndd)
NDDataWithMath(-0.25)

これをクラスメソッドとして用いるには2つのオペランドが必要である：

>>> NDDataWithMath.subtract(5, 4)
NDDataWithMath(1)

方法要約

add \(オペランド[, operand2] )	値を求めることで加算を行う self ++ operand それがそうです。
divide \(オペランド[, operand2] )	値を求めることで除算を行う self ／ operand それがそうです。
multiply \(オペランド[, operand2] )	値を求めることで乗算を行う self ** operand それがそうです。
subtract \(オペランド[, operand2] )	値を求めることで減算を行う self - operand それがそうです。

方法文書

classmethod add(operand, operand2=None, **kwargs)

値を求めることで加算を行う self ++ operand それがそうです。

パラメータ

オペランド，オペランド2 ： NDData -クラスのインスタンスクラスNDDATAインスタンス

もし operand2 はい。 None そうでなければこの操作を実行します self ++ operand それがそうです。もし operand2 与えられたら実行される operand ++ operand2 それがそうです。メソッドがクラスで呼び出された場合，インスタンス上で呼び出されるのではない. operand2 与えなければなりません。

propagate_uncertainties ： bool あるいは…。 None オプションです。BoolまたはNone、オプション

もし None 結果には何の不確実性もないだろう。もし…。 False その結果、不確実性を有する第1の操作オブジェクトのコピーバージョンが提供される。もし…。 True 結果はオペランドからの不確実性の正確な伝播の不確実性を持つが，この仮定は不確実性である. NDUncertainty -そうだデフォルト値は True それがそうです。

バージョン 1.2 で変更: このパラメータはキーワードパラメータとして提供されなければならない.位置パラメータとして使用することは推奨されていない. None 有効なパラメータ値として追加された.

handle_mask ：呼び出すことができます。 'first_found' あるいは…。 None オプションです。呼び出し可能なのは

もし None 結果的にマスクはないだろう。もし…。 'first_found' その結果、マスクを有する第1の操作オブジェクトの複製バージョン)を有することになる。呼び出し可能オブジェクトである場合、指定された呼び出し可能オブジェクトは結果を作成しなければならない mask 必要であれば、コピーを提供してください。デフォルト値は numpy.logical_or それがそうです。

バージョン 1.2 で追加.

handle_meta ：呼び出すことができます。 'first_found' あるいは…。 None オプションです。呼び出し可能なのは

もし None 結果的にMetaはないだろう。もし…。 'first_found' その結果、(空ではない)要素を有する第1の操作オブジェクトのコピーバージョンを有することになる。呼び出し可能オブジェクトである場合、指定された呼び出し可能オブジェクトは結果を作成しなければならない meta 必要であれば、コピーを提供してください。デフォルト値は None それがそうです。

バージョン 1.2 で追加.

compare_wcs ：呼び出すことができます。 'first_found' あるいは…。 None オプションです。呼び出し可能なのは

もし None その結果，WCSがなく，オペランドのWCS間で比較することはない.もし…。 'first_found' その結果、WCSを有する第1の操作オブジェクトのコピーバージョンを有することになる。これが呼び出し可能オブジェクトである場合，指定された呼び出し可能オブジェクトは wcs それがそうです。ここから生まれたのは wcs 似ていますもし False そうでなければそれは ValueError もし比較が成功しなかったら。デフォルト値は 'first_found' それがそうです。

バージョン 1.2 で追加.

uncertainty_correlation ：数字や ndarray オプションです。数字や

2つのオペランド間の相関は、https：//en.wikipedia.org/wiki/Propagation_of_不確実性#Example_Formallationsデフォルト値が0であるように、関連データを正確にエラー伝播するために使用される。

バージョン 1.2 で追加.

コバルガス：

使用された呼び出し可能なオブジェクトの任意の他のパラメータに渡されるべきである。

返品

結果は…。 ： NDData -似てるクラスNDDATA

生成されたデータセット

注意事項

If a callable is used for mask, wcs or meta the callable must accept the corresponding attributes as first two parameters. If the callable also needs additional parameters these can be defined as kwargs and must start with "wcs_" (for wcs callable) or "meta_" (for meta callable). This startstring is removed before the callable is called.

"first_found" 略してもいいです "ff" それがそうです。

classmethod divide(operand, operand2=None, **kwargs)

値を求めることで除算を行う self ／ operand それがそうです。

パラメータ

オペランド，オペランド2 ： NDData -クラスのインスタンスクラスNDDATAインスタンス

もし operand2 はい。 None そうでなければこの操作を実行します self ／ operand それがそうです。もし operand2 与えられたら実行される operand ／ operand2 それがそうです。メソッドがクラスで呼び出された場合，インスタンス上で呼び出されるのではない. operand2 与えなければなりません。

propagate_uncertainties ： bool あるいは…。 None オプションです。BoolまたはNone、オプション

もし None 結果には何の不確実性もないだろう。もし…。 False その結果、不確実性を有する第1の操作オブジェクトのコピーバージョンが提供される。もし…。 True 結果はオペランドからの不確実性の正確な伝播の不確実性を持つが，この仮定は不確実性である. NDUncertainty -そうだデフォルト値は True それがそうです。

バージョン 1.2 で変更: このパラメータはキーワードパラメータとして提供されなければならない.位置パラメータとして使用することは推奨されていない. None 有効なパラメータ値として追加された.

handle_mask ：呼び出すことができます。 'first_found' あるいは…。 None オプションです。呼び出し可能なのは

もし None 結果的にマスクはないだろう。もし…。 'first_found' その結果、マスクを有する第1の操作オブジェクトの複製バージョン)を有することになる。呼び出し可能オブジェクトである場合、指定された呼び出し可能オブジェクトは結果を作成しなければならない mask 必要であれば、コピーを提供してください。デフォルト値は numpy.logical_or それがそうです。

バージョン 1.2 で追加.

handle_meta ：呼び出すことができます。 'first_found' あるいは…。 None オプションです。呼び出し可能なのは

もし None 結果的にMetaはないだろう。もし…。 'first_found' その結果、(空ではない)要素を有する第1の操作オブジェクトのコピーバージョンを有することになる。呼び出し可能オブジェクトである場合、指定された呼び出し可能オブジェクトは結果を作成しなければならない meta 必要であれば、コピーを提供してください。デフォルト値は None それがそうです。

バージョン 1.2 で追加.

compare_wcs ：呼び出すことができます。 'first_found' あるいは…。 None オプションです。呼び出し可能なのは

もし None その結果，WCSがなく，オペランドのWCS間で比較することはない.もし…。 'first_found' その結果、WCSを有する第1の操作オブジェクトのコピーバージョンを有することになる。これが呼び出し可能オブジェクトである場合，指定された呼び出し可能オブジェクトは wcs それがそうです。ここから生まれたのは wcs 似ていますもし False そうでなければそれは ValueError もし比較が成功しなかったら。デフォルト値は 'first_found' それがそうです。

バージョン 1.2 で追加.

uncertainty_correlation ：数字や ndarray オプションです。数字や

2つのオペランド間の相関は、https：//en.wikipedia.org/wiki/Propagation_of_不確実性#Example_Formallationsデフォルト値が0であるように、関連データを正確にエラー伝播するために使用される。

バージョン 1.2 で追加.

コバルガス：

使用された呼び出し可能なオブジェクトの任意の他のパラメータに渡されるべきである。

返品

結果は…。 ： NDData -似てるクラスNDDATA

生成されたデータセット

注意事項

If a callable is used for mask, wcs or meta the callable must accept the corresponding attributes as first two parameters. If the callable also needs additional parameters these can be defined as kwargs and must start with "wcs_" (for wcs callable) or "meta_" (for meta callable). This startstring is removed before the callable is called.

"first_found" 略してもいいです "ff" それがそうです。

classmethod multiply(operand, operand2=None, **kwargs)

値を求めることで乗算を行う self ** operand それがそうです。

パラメータ

オペランド，オペランド2 ： NDData -クラスのインスタンスクラスNDDATAインスタンス

If operand2 is None or not given it will perform the operation self * operand. If operand2 is given it will perform operand * operand2. If the method was called on a class rather than on the instance operand2 must be given.

propagate_uncertainties ： bool あるいは…。 None オプションです。BoolまたはNone、オプション

もし None 結果には何の不確実性もないだろう。もし…。 False その結果、不確実性を有する第1の操作オブジェクトのコピーバージョンが提供される。もし…。 True 結果はオペランドからの不確実性の正確な伝播の不確実性を持つが，この仮定は不確実性である. NDUncertainty -そうだデフォルト値は True それがそうです。

バージョン 1.2 で変更: このパラメータはキーワードパラメータとして提供されなければならない.位置パラメータとして使用することは推奨されていない. None 有効なパラメータ値として追加された.

handle_mask ：呼び出すことができます。 'first_found' あるいは…。 None オプションです。呼び出し可能なのは

もし None 結果的にマスクはないだろう。もし…。 'first_found' その結果、マスクを有する第1の操作オブジェクトの複製バージョン)を有することになる。呼び出し可能オブジェクトである場合、指定された呼び出し可能オブジェクトは結果を作成しなければならない mask 必要であれば、コピーを提供してください。デフォルト値は numpy.logical_or それがそうです。

バージョン 1.2 で追加.

handle_meta ：呼び出すことができます。 'first_found' あるいは…。 None オプションです。呼び出し可能なのは

もし None 結果的にMetaはないだろう。もし…。 'first_found' その結果、(空ではない)要素を有する第1の操作オブジェクトのコピーバージョンを有することになる。呼び出し可能オブジェクトである場合、指定された呼び出し可能オブジェクトは結果を作成しなければならない meta 必要であれば、コピーを提供してください。デフォルト値は None それがそうです。

バージョン 1.2 で追加.

compare_wcs ：呼び出すことができます。 'first_found' あるいは…。 None オプションです。呼び出し可能なのは

もし None その結果，WCSがなく，オペランドのWCS間で比較することはない.もし…。 'first_found' その結果、WCSを有する第1の操作オブジェクトのコピーバージョンを有することになる。これが呼び出し可能オブジェクトである場合，指定された呼び出し可能オブジェクトは wcs それがそうです。ここから生まれたのは wcs 似ていますもし False そうでなければそれは ValueError もし比較が成功しなかったら。デフォルト値は 'first_found' それがそうです。

バージョン 1.2 で追加.

uncertainty_correlation ：数字や ndarray オプションです。数字や

2つのオペランド間の相関は、https：//en.wikipedia.org/wiki/Propagation_of_不確実性#Example_Formallationsデフォルト値が0であるように、関連データを正確にエラー伝播するために使用される。

バージョン 1.2 で追加.

コバルガス：

使用された呼び出し可能なオブジェクトの任意の他のパラメータに渡されるべきである。

返品

結果は…。 ： NDData -似てるクラスNDDATA

生成されたデータセット

注意事項

If a callable is used for mask, wcs or meta the callable must accept the corresponding attributes as first two parameters. If the callable also needs additional parameters these can be defined as kwargs and must start with "wcs_" (for wcs callable) or "meta_" (for meta callable). This startstring is removed before the callable is called.

"first_found" 略してもいいです "ff" それがそうです。

classmethod subtract(operand, operand2=None, **kwargs)

値を求めることで減算を行う self - operand それがそうです。

パラメータ

オペランド，オペランド2 ： NDData -クラスのインスタンスクラスNDDATAインスタンス

もし operand2 はい。 None そうでなければこの操作を実行します self - operand それがそうです。もし operand2 与えられたら実行される operand - operand2 それがそうです。メソッドがクラスで呼び出された場合，インスタンス上で呼び出されるのではない. operand2 与えなければなりません。

propagate_uncertainties ： bool あるいは…。 None オプションです。BoolまたはNone、オプション

もし None 結果には何の不確実性もないだろう。もし…。 False その結果、不確実性を有する第1の操作オブジェクトのコピーバージョンが提供される。もし…。 True 結果はオペランドからの不確実性の正確な伝播の不確実性を持つが，この仮定は不確実性である. NDUncertainty -そうだデフォルト値は True それがそうです。

バージョン 1.2 で変更: このパラメータはキーワードパラメータとして提供されなければならない.位置パラメータとして使用することは推奨されていない. None 有効なパラメータ値として追加された.

handle_mask ：呼び出すことができます。 'first_found' あるいは…。 None オプションです。呼び出し可能なのは

もし None 結果的にマスクはないだろう。もし…。 'first_found' その結果、マスクを有する第1の操作オブジェクトの複製バージョン)を有することになる。呼び出し可能オブジェクトである場合、指定された呼び出し可能オブジェクトは結果を作成しなければならない mask 必要であれば、コピーを提供してください。デフォルト値は numpy.logical_or それがそうです。

バージョン 1.2 で追加.

handle_meta ：呼び出すことができます。 'first_found' あるいは…。 None オプションです。呼び出し可能なのは

もし None 結果的にMetaはないだろう。もし…。 'first_found' その結果、(空ではない)要素を有する第1の操作オブジェクトのコピーバージョンを有することになる。呼び出し可能オブジェクトである場合、指定された呼び出し可能オブジェクトは結果を作成しなければならない meta 必要であれば、コピーを提供してください。デフォルト値は None それがそうです。

バージョン 1.2 で追加.

compare_wcs ：呼び出すことができます。 'first_found' あるいは…。 None オプションです。呼び出し可能なのは

もし None その結果，WCSがなく，オペランドのWCS間で比較することはない.もし…。 'first_found' その結果、WCSを有する第1の操作オブジェクトのコピーバージョンを有することになる。これが呼び出し可能オブジェクトである場合，指定された呼び出し可能オブジェクトは wcs それがそうです。ここから生まれたのは wcs 似ていますもし False そうでなければそれは ValueError もし比較が成功しなかったら。デフォルト値は 'first_found' それがそうです。

バージョン 1.2 で追加.

uncertainty_correlation ：数字や ndarray オプションです。数字や

2つのオペランド間の相関は、https：//en.wikipedia.org/wiki/Propagation_of_不確実性#Example_Formallationsデフォルト値が0であるように、関連データを正確にエラー伝播するために使用される。

バージョン 1.2 で追加.

コバルガス：

使用された呼び出し可能なオブジェクトの任意の他のパラメータに渡されるべきである。

返品

結果は…。 ： NDData -似てるクラスNDDATA

生成されたデータセット

注意事項

If a callable is used for mask, wcs or meta the callable must accept the corresponding attributes as first two parameters. If the callable also needs additional parameters these can be defined as kwargs and must start with "wcs_" (for wcs callable) or "meta_" (for meta callable). This startstring is removed before the callable is called.

"first_found" 略してもいいです "ff" それがそうです。