FunctionQuantity¶
- class astropy.units.function.FunctionQuantity(value, unit=None, dtype=None, copy=True, order=None, subok=False, ndmin=0)[源代码]¶
基类:
Quantity
用单位表示一个数的(标度)函数。
函数量是指其单位为包含物理单位的函数的量,例如dB(mW)。函数量的大多数算术运算都是在这个基类中定义的。
虽然这里也定义了实例化,但不应该直接实例化这个类。相反,子类应该具有
_unit_class
指向相应的功能单元类。- 参数
- value数量的、类似数量的或其顺序的
函数量的数值。如果一个数字或一个
Quantity
有了功能单元,它将被转换为unit
物理单位可以从unit
. 如果AQuantity
如果只有一个物理单元,它将转换为功能单元,如果需要,将其转换为从unit
.- unit STR,
UnitBase
或FunctionUnitBase
可选结构, 对于一个
FunctionUnitBase
实例中,将从中获取物理单元;对于其他输入,将从value
. 默认情况下,unit
由子类设置。- D型 :
dtype
可选可选类型 将保存该值的结果Numpy数组或标量的数据类型。如果未提供,则根据输入确定,但不能表示浮点(整数和布尔)的任何输入都将转换为浮点。
- copy可选的布尔
如果
True
(default), then the value is copied. Otherwise, a copy will only be made if_ _如果值是嵌套序列,或者需要副本来满足显式给定的 ``dtype
. (在False
选项主要用于内部使用,以便在已知已生成副本的情况下加快初始化。小心使用。)- order'C'、'F'、'A',可选
指定数组的顺序。如
array
. 如果不需要转换输入并且copy=False
.- subok可选的布尔
如果
False
(默认),返回的数组将被强制为所使用的类。否则,子类将被传递。- ndmin可选的
指定结果数组应具有的最小维数。它们将根据需要根据形状预先设置,以满足此要求。如果输入是
Quantity
和copy=False
.
- 加薪
- TypeError
如果提供的值不是Python数字类型。
- TypeError
如果提供的装置不是
FunctionUnitBase
或Unit
对象,或可解析的字符串单元。
属性摘要
返回一个以CGS为单位的物理单元的副本。
对应于函数1的物理量。
返回物理单位为国际单位制的副本。
方法总结
clip
([min, max, out])返回值限制为的数组
[min, max]
.cumsum
([axis, dtype, out])返回给定轴上元素的累积和。
decompose
([bases])生成新的
FunctionQuantity
随着物理单位的分解。max
([axis, out, keepdims, initial, where])沿给定轴返回最大值。
min
([axis, out, keepdims, initial, where])沿给定轴返回最小值。
sum
([axis, dtype, out, keepdims, initial, where])返回给定轴上数组元素的和。
属性文档
- cgs¶
返回一个以CGS为单位的物理单元的副本。
- physical¶
对应于函数1的物理量。
- si¶
返回物理单位为国际单位制的副本。
方法文件
- clip(min=None, max=None, out=None, **kwargs)[源代码]¶
返回值限制为的数组
[min, max]
. 必须给出max或min中的一个。参照
numpy.clip
完整文件。参见
numpy.clip
等效函数
- cumsum(axis=None, dtype=None, out=None)[源代码]¶
返回给定轴上元素的累积和。
参照
numpy.cumsum
完整文件。参见
numpy.cumsum
等效函数
- decompose(bases=[])[源代码]¶
生成新的
FunctionQuantity
随着物理单位的分解。有关详细信息,请参阅
decompose
.
- max(axis=None, out=None, keepdims=False, initial=<no value>, where=True)[源代码]¶
沿给定轴返回最大值。
参照
numpy.amax
完整文件。参见
numpy.amax
等效函数
- min(axis=None, out=None, keepdims=False, initial=<no value>, where=True)[源代码]¶
沿给定轴返回最小值。
参照
numpy.amin
完整文件。参见
numpy.amin
等效函数