FunctionUnitBase

class astropy.units.function.FunctionUnitBase(physical_unit=None, function_unit=None)

ベースクラス: object

関数ユニットの抽象基底クラス.

機能ユニットは、物理ユニットを含む機能であり、例えばデシベル(MW)である。関数ユニット上の算術演算の多くはこの基底クラスで定義されている.

インスタンス化を定義する際には，このようなものを直接用いるべきではない.逆に，抽象属性をカバーするサブクラスを用いるべきである _default_function_unit and _ Quantity_class‘，および抽象化方法 `from_physical そして、 to_physical それがそうです。

パラメータ

physical_unit ： Unit あるいは…。 string単位または文字列

機能ユニット内に封入されたユニット.与えられていなければ無次元である.

function_unit ： Unit あるいは…。 string単位または文字列

デフォルトの場合，サブクラスが設定した機能単位と同じである.

属性要約

cgs \	現在の機能ユニットをCGS中の物理ユニットとともにコピーする.
equivalencies \	機能ユニットと物理ユニットとの間の等価物リスト。
function_unit \
physical_type \	物理ユニットの物理タイプ(例えば、‘Length’)に戻る。
physical_unit \
si \	現在の機能ユニットは、SI内の物理ユニットと共にコピーされる。

方法要約

decompose \([bases] )	分解された物理ユニットの現在のセルをコピーする。
from_physical \(X)	オブジェクト価値から機能単位価値への変換.
is_equivalent \(その他[, equivalencies] )	返品 True もしこの単位が等しいなら other それがそうです。
is_unity \()
to \(その他[, value, equivalencies] )	指定された単位で表される変換値を返す.
to_physical \(X)	関数値から物理単位価値への変換.
to_string \([format] )	与えられたフォーマットの単位を文字列として出力する.

属性文書

cgs

現在の機能ユニットをCGS中の物理ユニットとともにコピーする.

equivalencies

機能ユニットと物理ユニットとの間の等価物リスト。

使用 from_physical そして to_physical 方法です。

function_unit

physical_type

物理ユニットの物理タイプ(例えば、‘Length’)に戻る。

physical_unit

si

現在の機能ユニットは、SI内の物理ユニットと共にコピーされる。

方法文書

decompose(bases={})

分解された物理ユニットの現在のセルをコピーする。

詳細については参照のこと decompose それがそうです。

abstract from_physical(x)

オブジェクト価値から機能単位価値への変換.

この方法はサブクラスで書き換えるべきである.これは等価項を使用して自動変換を提供するために使用される。

is_equivalent(other, equivalencies=[])

返品 True もしこの単位が等しいなら other それがそうです。

パラメータ

他にも ： Unit 文字列、またはタプル単位、文字列、またはタプル

変換する単位です。単位タプルが指定され、単位がタプル内の任意の単位と一致する場合、この方法はTRUEに戻る。

equivalenciesメタグループリスト

単位が直接変換できない場合に試みる等価対リスト.参照してください 等価物. それがそうです。このリストは、機能ユニットと物理ユニットとの間の内蔵等価性および可能なグローバルデフォルト値の補足であり、例えば、。 set_enabled_equivalencies それがそうです。使用 None グローバル等価項を閉じる場合は、以下の操作を実行してください。

返品

ブルル.

is_unity()

to(other, value=1.0, equivalencies=[])

指定された単位で表される変換値を返す.

パラメータ

otherUnit、FunctionUnitBaseまたはString

変換する単位です。

value整数型、浮動小数点型、またはスカラー型配列、オプション

現在のユニットでは指定されたユニットの値に変換する.提供されていない場合、デフォルトは1.0となる。

equivalenciesメタグループリスト

単位が直接変換できない場合に試みる等価対リスト.参照してください 等価物. それがそうです。このリストは、異なる物理ユニット間の等価性を処理するためにのみ使用され、機能ユニットと物理ユニットとの間の内蔵等価性は自動的に考慮されるであろう。

返品

valuesスカラーまたは配列

値を転換する。入力値系列はNumpy配列の形で返される.

賃上げをする

UnitsError

もし単位が一致しなければ。

abstract to_physical(x)

関数値から物理単位価値への変換.

この方法はサブクラスで書き換えるべきである.これは等価項を使用して自動変換を提供するために使用される。

to_string(format='generic')

与えられたフォーマットの単位を文字列として出力する.

“dB(MW)”のような物理ユニットは、丸括弧内で機能ユニットに付加され、両ユニットとも所与のフォーマット設定を使用する。

パラメータ

フォーマット ： astropy.units.format.Base インスタンスまたは文字列Asterpy.units.format.基本インスタンスまたは文字列

プログラムオブジェクトの名前をフォーマットまたはフォーマットする.提供されていない場合は，デフォルトで汎用フォーマットとする.