参数

class astropy.cosmology.Parameter(*, derived=False, unit=None, equivalencies=[], fvalidate='default', fmt='', doc=None)[源代码]

基类:object

宇宙参数(描述符)。

应仅与 Cosmology 子类。

参数
derived布尔值(可选,仅关键字)

Whether the Parameter is 'derived', default False. Derived parameters behave similarly to normal parameters, but are not sorted by the |Cosmology| signature (probably not there) and are not included in all methods. For reference, see Ode0 in FlatFLRWMixin, which removes \(\Omega_{de,0}\) as an independent parameter (\(\Omega_{de,0} \equiv 1 - \Omega_{tot}\)).

unit类单元或无(可选,仅关键字)

这个 Unit 作为参数。如果为None(默认),则假定无单位。

equivalenciesEquivalency 或其序列等价物或其序列

此参数的单位当量。

fvalidate可召回 [[object, object, Any] 、任意]或字符串(可选,仅关键字)

函数来验证来自宇宙类实例的参数值。如果为“Default”,如果参数具有单位,则使用默认验证器分配单位(具有等效项)。有关其他有效的字符串选项,请参见 Parameter._registry_validators 。也可以通过具有以下参数的装饰符来设置‘fvalify’ validator()

fmtStr(可选,仅关键字)

format 规范,用于表示包含宇宙学的字符串。请参阅https://docs.python.org/3/library/string.html#formatspec

自 5.1 版本弃用.

doc字符串或无(可选,仅关键字)

参数说明。

实例

有关工作示例,请参见 FLRW

属性摘要

derived 

是否派生该参数;不派生True参数。

equivalencies 

初始化参数时使用的等效值。

format_spec 

自 5.1 版本弃用.

fvalidate 

函数来验证此参数的潜在值。

name 

参数名称。

unit 

参数单位。

方法总结

clone(**kw)

克隆这个 Parameter ,更改任何构造函数参数。

register_validator(key[, fvalidate])

修饰符来注册一种新的验证器函数。

validate(cosmology, value)

对此参数运行验证器。

validator \(fvalify)

用自定义制作新参数 fvalidate

属性文档

derived

是否派生该参数;不派生True参数。

equivalencies

初始化参数时使用的等效值。

format_spec

自 5.1 版本弃用: Format_Spec属性已弃用,可能会在将来的版本中删除。

fvalidate

函数来验证此参数的潜在值。

name

参数名称。

unit

参数单位。

方法文件

clone(**kw)[源代码]

克隆这个 Parameter ,更改任何构造函数参数。

参数
**kw

传递给构造函数。当前值,例如。 fvalidate 被用作缺省值,因此一个空 **kw 是一个一模一样的复制品。

实例

>>> p = Parameter()
>>> p
Parameter(derived=False, unit=None, equivalencies=[],
          fvalidate='default', doc=None)
>>> p.clone(unit="km")
Parameter(derived=False, unit=Unit("km"), equivalencies=[],
          fvalidate='default', doc=None)
classmethod register_validator(key, fvalidate=None)[源代码]

修饰符来注册一种新的验证器函数。

参数
keySTR
fvalidate可召回 [[object, object, Any] ,任意]或无,可选

值验证功能。

返回
validator 或可调用 [validator]

如果validator为None,则返回一个接受并注册验证器的函数。这使得 register_validator 用来当装饰师。

validate(cosmology, value)[源代码]

对此参数运行验证器。

参数
cosmologyCosmology 实例宇宙学实例
value任何

要验证的对象。

返回
任何

调用的输出 fvalidate(cosmology, self, value) (是的,该参数顺序)。

validator(fvalidate)[源代码]

用自定义制作新参数 fvalidate

注: Parameter.fvalidator 必须是最顶层的描述符修饰符。

参数
fvalidate可召回 [[type, type, Any] ,任何]
返回
Parameter

此参数的副本,但带自定义 fvalidate