SigmaClippedStats#

class astropy.stats.sigma_clipping.SigmaClippedStats(data: ArrayLike, *, mask: NDArray | None = None, mask_value: float | None = None, sigma: float = 3.0, sigma_lower: float | None = None, sigma_upper: float | None = None, maxiters: int = 5, cenfunc: Literal['median', 'mean'] | Callable = 'median', stdfunc: Literal['std', 'mad_std'] | Callable = 'std', axis: int | tuple[int, ...] | None = None, grow: float | Literal[False] | None = False)[源代码]#

基类:object

类计算所提供数据的西格玛修剪统计量。

参数:
data : array_likeMaskedArrayNumPy:ARRAY_LIKE或Masked数组

可以转换为数组的数据数组或对象。

mask : numpy.ndarray (bool ),可选努比·恩达雷(bool),可选

与形状相同的布尔掩码 data ,其中a True 值指示的相应元素 data 戴着面具。在计算统计信息时,屏蔽像素被排除在外。

mask_value : float ,可选Python:Float,可选

数据值(例如, 0.0 ),在计算统计数据时被忽略。 mask_value 除了任何输入外,还将被屏蔽 mask

sigma : float ,可选Python:Float,可选

用于剪裁下限和上限的标准差的数目。这些限制被以下各项覆盖 sigma_lowersigma_upper ,如果输入。默认值为3。

sigma_lower : floatNone ,可选PYTHON:FLOAT或PYTHON:无,可选

用作剪裁限制下限的标准差数。如果 None 那么它的价值 sigma 使用的是。缺省值为 None

sigma_upper : floatNone ,可选PYTHON:FLOAT或PYTHON:无,可选

用作剪裁限制上限的标准差数。如果 None 那么它的价值 sigma 使用的是。缺省值为 None

maxiters : intNone ,可选PYTHON:INT或PYTHON:NONE,可选

要执行的最大西格玛修剪迭代次数或 None 进行剪裁,直到达到收敛(即,迭代直到最后一次迭代不剪裁任何内容)。如果在此之前实现收敛 maxiters 迭代,则剪裁迭代将停止。默认值为5。

cenfunc : {'median', 'mean'} or callable() ,可选{‘中位数’,‘平均值’}或

用于计算剪裁中心值的统计或可调用函数/对象。如果使用可调用的函数/对象并且 axis 关键字,则它必须能够忽略NAN(例如, numpy.nanmean )并且它必须有一个 axis 关键字返回删除了轴维的数组。缺省值为 'median'

stdfunc : {'std', 'mad_std'} or callable() ,可选{‘std’,‘MAD_std’}或

用于计算关于中心值的标准偏差的统计或可调用函数/对象。如果使用可调用的函数/对象并且 axis 关键字,则它必须能够忽略NAN(例如, numpy.nanstd )并且它必须有一个 axis 关键字返回删除了轴维的数组。缺省值为 'std'

axis : Noneinttupleint ,可选PYTHON:NONE或PYTHON:INT或PYTHON:PYTHON的元组:INT,可选

要沿着其西格玛剪裁数据的一个或多个轴。如果 None ,则将使用展平的数据。 axis 被传递给 cenfuncstdfunc 。缺省值为 None

grow : floatFalse ,可选Python:Float或False,可选

遮罩超出剪裁限制的相邻像素的半径(仅适用于 axis ,如果指定)。例如,对于2D图像,值为1将在每个偏差像素周围以交叉模式遮罩最近的像素,而1.5也将拒绝最近的对角线邻域,依此类推。

笔记

最佳性能通常通过设置来获得 cenfuncstdfunc 指定为字符串的内置函数之一。如果将其中一个选项设置为字符串,而另一个选项具有自定义可调用项,则在某些情况下, bottleneck 包已安装。为了保持准确性,瓶颈仅用于float 64计算。

方法总结

biweight_location([c, M])

计算数据的双权重位置。

biweight_scale([c, M])

计算数据的双权重标度。

mad_std ()

计算基于数据标准差的中位数绝对偏差(MAD)。

max ()

计算数据的最大值。

mean ()

计算数据的平均值。

median ()

计算数据的中位数。

min ()

计算最小数据。

mode([median_factor, mean_factor])

使用以下形式的估计器计算数据的模式 (median_factor * median) - (mean_factor * mean) .

std([ddof])

计算数据的标准差。

sum ()

计算数据的总和。

var([ddof])

计算数据的方差。

方法文件

biweight_location(c: float = 6.0, M: float | None = None) float | NDArray[源代码]#

计算数据的双权重位置。

NaN值被忽略。

参数:
c : float ,可选Python:Float,可选

双权重估计器的调整常数。默认值为6.0。

M : floatNone ,可选PYTHON:FLOAT或PYTHON:无,可选

对双重量位置的初步猜测。默认值为 None .

返回:
biweight_location : floatndarrayPython :浮点或ndarray

数据的双权重位置。

biweight_scale(c: float = 6.0, M: float | None = None) float | NDArray[源代码]#

计算数据的双权重标度。

NaN值被忽略。

参数:
c : float ,可选Python:Float,可选

双权重估计器的调整常数。默认值为6.0。

M : floatNone ,可选PYTHON:FLOAT或PYTHON:无,可选

对双重量位置的初步猜测。默认值为 None .

返回:
biweight_scale : floatndarrayPython :浮点或ndarray

数据的双权重比例。

mad_std() float | NDArray[源代码]#

计算基于数据标准差的中位数绝对偏差(MAD)。

NaN值被忽略。

返回:
mad_std : floatndarrayPython :浮点或ndarray

基于MAD的数据标准差。

max() float | NDArray[源代码]#

计算数据的最大值。

NaN值被忽略。

返回:
max : floatndarrayPython :浮点或ndarray

数据的最大值。

mean() float | NDArray[源代码]#

计算数据的平均值。

NaN值被忽略。

返回:
mean : floatndarrayPython :浮点或ndarray

数据的平均值。

median() float | NDArray[源代码]#

计算数据的中位数。

NaN值被忽略。

返回:
median : floatndarrayPython :浮点或ndarray

数据的中位数。

min() float | NDArray[源代码]#

计算最小数据。

NaN值被忽略。

返回:
min : floatndarrayPython :浮点或ndarray

最少的数据。

mode(median_factor: float = 3.0, mean_factor: float = 2.0) float | NDArray[源代码]#

使用以下形式的估计器计算数据的模式 (median_factor * median) - (mean_factor * mean) .

NaN值被忽略。

参数:
median_factor : float ,可选Python:Float,可选

数据中位数的相乘因子。切换到3。

mean_factor : float ,可选Python:Float,可选

数据平均值的相乘因子。切换到2。

返回:
mode : floatndarrayPython :浮点或ndarray

数据的估计模式。

std(ddof: int = 0) float | NDArray[源代码]#

计算数据的标准差。

NaN值被忽略。

参数:
ddof : int ,可选PYTHON:int,可选

标准差计算的增量自由度。计算中使用的因子是 N - ddof ,在哪里 N 代表元素的数量。对于拥有整个人群数据的人群标准差,请使用 ddof=0 .对于具有人群样本的样本标准差,请使用 ddof=1 .默认值为0。

返回:
std : floatndarrayPython :浮点或ndarray

数据的标准偏差。

sum() float | NDArray[源代码]#

计算数据的总和。

NaN值被忽略。

返回:
sum : floatndarrayPython :浮点或ndarray

数据的总和。

var(ddof: int = 0) float | NDArray[源代码]#

计算数据的方差。

NaN值被忽略。

参数:
ddof : int ,可选PYTHON:int,可选

delta自由度。计算中使用的因子是 N - ddof ,在哪里 N 代表元素的数量。对于拥有整个人群数据的人群差异,请使用 ddof=0 .对于具有人口样本的样本方差,请使用 ddof=1 .默认值为0。

返回:
var : floatndarrayPython :浮点或ndarray

数据的方差。