sigma_clipped_stats¶
- astropy.stats.sigma_clipping.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 :类似数组的或
MaskedArray
类似数组的或 可以转换为数组的数据数组或对象。
- mask :
numpy.ndarray
(bool),可选努比·恩达雷(bool),可选 与形状相同的布尔掩码
data
,其中aTrue
值指示的相应元素data
戴着面具。在计算统计信息时,屏蔽像素被排除在外。- mask_value可选浮动
数据值(例如,
0.0
),在计算统计数据时被忽略。mask_value
除了任何输入外,还将被屏蔽mask
。- sigma可选浮动
用于剪裁下限和上限的标准差的数目。这些限制被以下各项覆盖
sigma_lower
和sigma_upper
,如果输入。默认值为3。- sigma_lower浮动或无,可选
- sigma_upper浮动或无,可选
- maxiters整型或无型,可选
要执行的最大西格玛修剪迭代次数或
None
进行剪裁,直到达到收敛(即,迭代直到最后一次迭代不剪裁任何内容)。如果在此之前实现收敛maxiters
迭代,则剪裁迭代将停止。默认值为5。- cenfunc{'median'、'mean'}或可调用,可选
用于计算剪裁中心值的统计或可调用函数/对象。如果使用可调用的函数/对象并且
axis
关键字,则它必须能够忽略NAN(例如,numpy.nanmean
)并且它必须有一个axis
关键字返回删除了轴维的数组。缺省值为'median'
。- stdfunc{‘std’,‘MAD_std’}或可调用,可选
用于计算关于中心值的标准偏差的统计或可调用函数/对象。如果使用可调用的函数/对象并且
axis
关键字,则它必须能够忽略NAN(例如,numpy.nanstd
)并且它必须有一个axis
关键字返回删除了轴维的数组。缺省值为'std'
。- std_ddof可选的
用于标准偏差计算的增量自由度。计算中使用的除数是
N - std_ddof
,在哪里N
表示元素的数量。默认值为0。- axisNone或int或int的元组,可选
要沿着其西格玛剪裁数据的一个或多个轴。如果
None
,则将使用展平的数据。axis
被传递给cenfunc
和stdfunc
。缺省值为None
。- grow :浮动或
False
可选浮动或 遮罩超出剪裁限制的相邻像素的半径(仅适用于
axis
,如果指定)。例如,对于2D图像,值为1将在每个偏差像素周围以交叉模式遮罩最近的像素,而1.5也将拒绝最近的对角线邻域,依此类推。
- data :类似数组的或
- 返回
- 平均值,中位数,标准偏差浮动
西格玛剪裁数据的平均值、中位数和标准差。
参见
笔记
最佳性能通常通过设置
cenfunc
和stdfunc
指定为字符串的其中一个内置函数。如果其中一个选项设置为字符串,而另一个选项具有自定义可调用对象,则在某些情况下,如果使用 bottleneck 已安装软件包。