UnitBase¶
- class astropy.units.UnitBase[源代码]¶
基类:
object
单位的抽象基类。
单元上的大多数算术运算都是在这个基类中定义的。
不应该由用户直接实例化。
属性摘要
返回此单元的别名(长)名称。
返回装置底座。
返回当前
Unit
具有CGS单元的实例。返回与此单元关联的规范(短)名称。
返回与此单元关联的所有名称。
在尺寸上与该单元兼容的物理类型。
归还单位的力量。
返回单位刻度。
返回当前
Unit
以国际单位制表示的实例。方法总结
compose
\([equivalencies, units, max_depth, ...] )返回表示给定单元的最简单的组合单元。
decompose
\([bases] )返回仅由不可约单位组成的单位对象。
find_equivalent_units
\([equivalencies, ...] )返回与所有类型相同的单位列表
self
.in_units
\(其他[, value, equivalencies] )Alias
to
为了与pynbody向后兼容。is_equivalent
\(其他[, equivalencies] )返回
True
如果这个单位等于other
.is_unity
\()返回
True
如果单位是无标度和无量纲的。to
\(其他[, value, equivalencies] )以指定的单位返回转换后的值。
to_string
\([format] )以给定格式将单位输出为字符串。
to_system
\(系统)将此单元转换为属于给定系统的单元。
属性文档
- aliases¶
返回此单元的别名(长)名称。
- bases¶
返回装置底座。
- name¶
返回与此单元关联的规范(短)名称。
- names¶
返回与此单元关联的所有名称。
- physical_type¶
在尺寸上与该单元兼容的物理类型。
- 返回
PhysicalType
单元的物理类型的表示。
实例
>>> from astropy import units as u >>> u.m.physical_type PhysicalType('length') >>> (u.m ** 2 / u.s).physical_type PhysicalType({'diffusivity', 'kinematic viscosity'})
可以将物理类型与其他物理类型(包中推荐的)或字符串进行比较。
>>> area = (u.m ** 2).physical_type >>> area == u.m.physical_type ** 2 True >>> area == "area" True
PhysicalType
对象可用于量纲分析。>>> number_density = u.m.physical_type ** -3 >>> velocity = (u.m / u.s).physical_type >>> number_density * velocity PhysicalType('particle flux')
- powers¶
归还单位的力量。
- scale¶
返回单位刻度。
方法文件
- compose(equivalencies=[], units=None, max_depth=2, include_prefix_units=None)[源代码]¶
返回表示给定单元的最简单的组合单元。由于单元可能有多个同样简单的组合,因此总是返回单元列表。
- 参数
- equivalencies元组列表
要同时列出的等价对列表。看见 astropy:unit_equivalencies 。该列表是对可能的全局缺省值的补充,例如,
set_enabled_equivalencies
。使用None
若要关闭所有等效项,请执行以下操作。- 单位 :一组
Unit
,可选一组 如果没有提供,任何已知的单位都可以用来合成。否则,
units
是包含要组成的单元的dict、module或sequence。- max_depth可选的
组成复合单元时要使用的最大递归深度。
- include_prefix_units可选的布尔
- 返回
- 单位 名单
CompositeUnit
名单 候选作文的列表。这些都将同样简单,但可能无法自动确定哪个候选人更好。
- 单位 名单
- decompose(bases={})[源代码]¶
返回仅由不可约单位组成的单位对象。
- 参数
- basesUnitBase序列,可选
分解成的基。如果没有提供,分解成任何不可还原的单位。当提供时,分解结果将只包含给定的单元。这将引发一个
UnitsError
如果不可能的话。
- 返回
- unit :
CompositeUnit
CompositeUnit
只包含不可约单位的对象。
- unit :
- find_equivalent_units(equivalencies=[], units=None, include_prefix_units=False)[源代码]¶
返回与所有类型相同的单位列表
self
.- 参数
- equivalencies元组列表
要同时列出的等价对列表。看见 astropy:unit_equivalencies 。任何给定的列表(包括空列表)都将取代可能生效的全局缺省值(由设置
set_enabled_equivalencies
)- 单位 :一组
Unit
,可选一组 如果未提供,则将搜索所有定义的单位以查找等效项。否则,可以是一个dict、module或sequence,其中包含要搜索等价性的单元。
- include_prefix_units可选的布尔
- 返回
- is_equivalent(other, equivalencies=[])[源代码]¶
返回
True
如果这个单位等于other
.- 参数
- 其他 :
Unit
、字符串或元组单位、字符串或元组 要转换为的单位。如果指定了一个单元元组,则如果该单元与元组中的任何一个匹配,则此方法将返回true。
- equivalencies元组列表
如果单位不能直接转换,可尝试的等价对列表。看见 astropy:unit_equivalencies 。该列表是对可能的全局缺省值的补充,例如,
set_enabled_equivalencies
。使用None
若要关闭所有等效项,请执行以下操作。
- 其他 :
- 返回
- 布尔
- to(other, value=1.0, equivalencies=[])[源代码]¶
以指定的单位返回转换后的值。
- 参数
- other类单元
要转换为的单位。
- value类似整型、浮点型或标量数组,可选
当前单位中要转换为指定单位的值。如果未提供,则默认为1.0
- equivalencies元组列表
如果单位不能直接转换,可尝试的等价对列表。看见 astropy:unit_equivalencies 。该列表是对可能的全局缺省值的补充,例如,
set_enabled_equivalencies
。使用None
若要关闭所有等效项,请执行以下操作。
- 返回
- values标量或数组
转换后的值。输入值序列作为numpy数组返回。
- 加薪
- UnitsError
如果单位不一致
- to_string(format=<class 'astropy.units.format.generic.Generic'>)[源代码]¶
以给定格式将单位输出为字符串。
- 参数
- 格式 :
astropy.units.format.Base
实例或strastropy.units.format.Base实例或str 格式或格式设置程序对象的名称。如果未提供,则默认为通用格式。
- 格式 :
- to_system(system)[源代码]¶
将此单元转换为属于给定系统的单元。因为可能有多个结果,所以总是返回一个列表。
- 参数
- system模块
定义单元系统的模块。常用的有
astropy.units.si
和astropy.units.cgs
.要使用您自己的模块,它必须包含单元对象和一个名为
bases
包含系统的基本单位。
- 返回
- 单位 名单
CompositeUnit
名单 该列表将被排序,以便只包含该系统的基本单元的单元将首先出现。
- 单位 名单