Warning with ineffectual and invalid collapses

未关闭
#110 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
python
领域
data

调研方向

从示例中展示的入口点 Field.collapse 开始,跟踪 size-one 轴对于 maximum、variance 和 sum_of_squares 的处理方式。确定并记录对有效、no-op 和无效 collapse 的反馈,然后为所示的三个案例添加覆盖。

由索引模型根据 Issue 内容生成。

描述

If a user tries to perform a collapse on an axes which is already singular, depending on the nature of the collapse method this may change the data and metadata as expected e.g. for 'sum_of_squares', but for most (at least, unweighted) collapse methods it, very reasonably, does not change anything, including not adding a call method indicating the collapse type, because the operation would not have an effect or be invalid (see examples below).

I think we should provide feedback to indicate to the user if a collapse has not had effect, since (say if they attempt such a collapse when not realising the axis/es size(s) is/are already one) they may be relying on metadata changes that would be made if the collapse had in fact been applied, such as the fact the units have changed appropriately, or an appropriate cell method has been added, etc. It certainly has the potential to cause confusion when collapses promise to make such changes.

The reason I am not implementing such feedback off the bat, as I doubt that is controversial, is that I am not sure of the best form of feedback, notably:

  • should we always use a logging message, or could it even warrant an exception for the 'invalid' case (number 3 below)?
  • what level of logging message would be most appropriate (one of 'info' or 'warning' I would think), and should this differ based on case (as below)?
Illustrative cases & examples

As far as I can see there are three cases for a size-one collapse, where case (1) is perfectly fine, but cases (2) and (3) warrant some form of user feedback and (3) may warrant a stronger form of warning, or even an Exception of some sort:

(All example code snippets operating on the following field f:

>>> import cf
>>> f=cf.read('~/Downloads/cfplot_data/ggap.nc')[1]
>>> f
<CF Field: eastward_wind(time(1), pressure(23), latitude(160), longitude(320)) m s**-1>
>>> print(f.data)
[[[[-13.383878707885742, ..., 1.6122403144836426]]]] m s**-1

)

  1. It has an effect as with a collapse of axes with non-singular size, e.g. 'sum_of_squares':

    >>> i = f.collapse('sum_of_squares', axes='T')
    >>> print(i.cell_methods)
    Constructs:
    {'cellmethod0': <CF CellMethod: domainaxis0: sum_of_squares>}
    >>> print(i.data)
    [[[[179.12820926739732, ..., 2.5993188316463147]]]] Gy
    
  2. It has no effect because it would make no difference to the field, e.g. 'maximum' (note no cell methods are added):

    >>> j = f.collapse('maximum', axes='T')
    >>> print(j.cell_methods)
    Constructs:
    {}
    >>> print(j.data)
    [[[[-13.383878707885742, ..., 1.6122403144836426]]]] m s**-1
    
  3. It has no effect because it is not possible, e.g. an unweighted unbiased variance collapse, given that the denominator of the corresponding calculation becomes (1 - 1) = 0:

    >>> k = f.collapse('variance', axes='T')
    >>> print(k.cell_methods)
    Constructs:
    {}
    >>> print(k.data)
    [[[[-13.383878707885742, ..., 1.6122403144836426]]]] m s**-1
    
主要语言
Python
星标
150
派生
23
平均合并
1 天 11 小时
30 天内合并 PR
2

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

NCAS-CMS/cf-python 的其他 Issue

查看 NCAS-CMS/cf-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。