sigma_clipped_stats#

astropy.stats.sigma_clipped_stats(data, mask=None, mask_value=None, sigma=3.0, sigma_lower=None, sigma_upper=None, maxiters=5, cenfunc='median', stdfunc='std', std_ddof=0, axis=None, grow=False)[源代码]#

根据提供的数据计算sigma裁剪统计。

参数:
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'

std_ddof : int ,可选PYTHON:int,可选

用于标准偏差计算的增量自由度。计算中使用的除数是 N - std_ddof ,在哪里 N 表示元素的数量。默认值为0。

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

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

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

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

返回:
mean, median, stddev : floatPython :浮点

西格玛剪裁数据的平均值、中位数和标准差。

笔记

最佳性能通常通过设置 cenfuncstdfunc 指定为字符串的其中一个内置函数。如果其中一个选项设置为字符串,而另一个选项具有自定义可调用对象,则在某些情况下,如果使用 bottleneck 已安装软件包。