Missing link to the CF area type table

[jesusff]

Title

Missing link to the CF area type table

Moderator

TBD

Requirement Summary

Include link to CF area type table and make explicit the need to use standardized area type strings in Section 7.3.3

Benefits

• Easier understanding of the area types
• Direct access from the conventions to the table of permitted values.

Associated pull request

No pull request yet, but could be generated from branch https://github.com/jesusff/cf-conventions/tree/area-types-text

Detailed Proposal

Section 7.3.3 introduces two conventions to indicate that an statistic has been applied only to a portion of a cell. The first convention mentions the:

strings permitted for a variable with a standard_name of area_type

which are only detailed in the second convention (next paragraph):

typevar is a string-valued auxiliary coordinate variable or string-valued scalar coordinate variable (see Section 6.1, "Labels") with a standard_name of area_type.

Here, it does not specify that only a standardized set of string values are permitted. To learn that, one needs to check the area_type standard name:

A variable with the standard_name of area_type contains either strings which indicate the nature of the surface e.g. land, sea, sea_ice, or flags which can be translated to strings using flag_values and flag_meanings attributes. These strings are standardised. Values must be taken from the area_type table.

This table is not linked anywhere in the CF conventions text, unlike others, such as the standardized region names, which are linked in Section 6.1.1. Its existence is mentioned in Section 3.3 Standard Name, though:

Some standard names (e.g. region and area_type) are used to indicate quantities which are permitted to take only certain standard values. This is indicated in the definition of the quantity in the standard name table, accompanied by a list or a link to a list of the permitted values.

The proposal is to make explicit the fact that, by any of the cell_method conventions to apply an statistic to a portion of a cell, area type strings must be selected from the standardized set defined in the CF Area Type Table and add the missing link to it.

A potential rewording of Section 7.3.3 would be (see jesusff@3b7d263):

By default, the statistical method indicated by cell_methods is assumed to have been evaluated over the entire horizontal area of the cell. Sometimes, however, it is useful to limit consideration to only a portion of a cell (e.g. a mean over the sea-ice area). Cell portions are referred to by means of standardised area_type strings (Section 3.3), maintained in the CF Area Type Table, using one of two conventions.

The first convention is a method that can be used for the common case of a single area-type. In this case, the cell_methods attribute may include a string of the form "name: method where type". Here name could, for example, be area and type may be any of the standardised area_type strings. As an example, if the method were mean and the area_type were sea_ice, then the data would represent a mean over only the sea ice portion of the grid cell. If the data writer expects type to be interpreted as one of the standard area_type strings, then none of the variables in the netCDF file should be given a name identical to that of the string (because the second convention, described in the next paragraph, takes precedence).

The second convention is the more general. In this case, the cell_methods entry is of the form "name: method where typevar".
Here typevar is a string-valued auxiliary coordinate variable or string-valued scalar coordinate variable (see <>) with a standard_name of area_type. The variable typevar contains the name(s) of the selected portion(s) of the grid cell to which the method is applied. These name(s) must be a subset of the standardised area_type strings. This convention can accommodate cases in which a method is applied to more than one area type and the result is stored in a single data variable (with a dimension which ranges across the various area types). It provides a convenient way to store output from land surface models, for example, since they deal with many area types within each surface gridbox (e.g., vegetation, bare_ground, snow, etc.).

[taylor13]

Thanks @jesusff for these suggestions. I support adding links to the current list of "area_type" strings.