FunctionUnitBase#

class astropy.units.function.core.FunctionUnitBase(physical_unit=None, function_unit=None)[源代码]#

基类：object

函数单元的抽象基类。

功能单元是包含物理单元的函数，例如dB（mW）。函数单元上的大多数算术运算都是在这个基类中定义的。

定义实例化时，不应直接使用此类。相反，应该使用子类重写抽象属性 _default_function_unit and _ quantity_类，以及抽象方法 from_physical 和 to_physical .

参数:

physical_unit ： Unit 或 string单位或字符串: 封装在功能单元内的单元。如果未给出，则无量纲。
function_unit ： Unit 或 string单位或字符串: 默认情况下，与子类设置的功能单元相同。

属性摘要

`cgs`	用CGS中的物理单元复制当前功能单元。
`equivalencies`	功能单元和物理单元之间的等效列表。
`function_unit`
`physical_type`	返回物理单元的物理类型（例如“长度”）。
`physical_unit`
`si`	用国际单位制的物理单位复制当前功能单位。

方法总结

`decompose`([bases])	复制分解了物理单元的当前单元。
`from_physical` \(X)	从物理值到功能单元值的转换。
`is_equivalent`(other[, equivalencies])	返回 `True` 如果这个单位等于 `other` .
`is_unity` \()
`to`(other[, value, equivalencies])	以指定的单位返回转换后的值。
`to_physical` \(X)	从函数值到物理单位值的转换。
`to_string`([format])	以给定格式将单位输出为字符串。

属性文档

cgs#: 用CGS中的物理单元复制当前功能单元。

equivalencies#

功能单元和物理单元之间的等效列表。

使用 from_physical 和 to_physical 方法。

function_unit#

physical_type#: 返回物理单元的物理类型（例如“长度”）。

physical_unit#

si#: 用国际单位制的物理单位复制当前功能单位。

方法文件

decompose(bases={})[源代码]#

复制分解了物理单元的当前单元。

有关详细信息，请参阅 decompose .

abstract from_physical(x)[源代码]#

从物理值到功能单元值的转换。

此方法应被子类重写。它用于提供使用等价性的自动转换。

is_equivalent(other, equivalencies=[])[源代码]#

返回 True 如果这个单位等于 other .

参数:

other : Unit, str ，或 tuple单位、python：str或python：tuple: 要转换为的单位。如果指定了一个单元元组，则如果该单元与元组中的任何一个匹配，则此方法将返回true。
equivalencies : list 的 tuplePYTHON：PYTHON列表：元组: 如果单位不能直接转换，可尝试的等价对列表。看见等价物。该列表是对功能单元和物理单元之间的内置等价性以及可能的全局缺省值的补充，例如， set_enabled_equivalencies 。使用 None 要关闭任何全局等价性，请执行以下操作。

返回:

bool

is_unity()[源代码]#

to(other, value=1.0, equivalencies=[])[源代码]#

以指定的单位返回转换后的值。

参数:

other : Unit, FunctionUnitBase, or str单位、FunctionUnitBase或PYTHON：字符串: 要转换为的单位。
value : int ， float ，或 scalar array_like ，可选PYTHON：INT、PYTHON：FLOAT或标量NAMPY：ARRAY_LIKE，可选: 当前单位中要转换为指定单位的值。如果未提供，则默认为1.0。
equivalencies : list 的 tuplePYTHON：PYTHON列表：元组: 如果单位不能直接转换，可尝试的等价对列表。看见等价物。此列表仅用于处理不同物理单元之间的等价性；功能单元和物理单元之间的内置等价性将自动考虑在内。

返回:

values : scalar 或 array标量或数组: 转换后的值。输入值序列作为numpy数组返回。

加薪:

UnitsError: 如果单位不一致。

abstract to_physical(x)[源代码]#

从函数值到物理单位值的转换。

此方法应被子类重写。它用于提供使用等价性的自动转换。

to_string(format='generic', **kwargs)[源代码]#

以给定格式将单位输出为字符串。

在括号内，物理单位被附加到功能单元上，如“dB（mW）”，两个单位都用给定的格式设置

参数:

format : astropy.units.format.Base instance or strAsterpy.units.Form.Base实例或python：str: 格式或格式设置程序对象的名称。如果未提供，则默认为通用格式。