cfdm.example_fields

cfdm.example_fields(*n, _func=<function example_field>)[source]

Return example field constructs.

Added in version (cfdm): 1.8.9.0

See also

cfdm.example_field, cfdm.example_domain

Parameters:
n: zero or more int, optional

Select the example field constructs to return, any combination of:

n

Field construct description

0

Cell method and dimension coordinate metadata constructs.

1

Cell method, dimension coordinate, auxiliary coordinate, cell measure, coordinate reference, domain ancillary and field ancillary metadata constructs.

2

A monthly time series at each latitude-longitude location.

3

Discrete sampling geometry (DSG) “timeSeries” features.

4

Discrete sampling geometry (DSG) “timeSeriesProfile” features.

5

A 12 hourly time series at each latitude-longitude location.

6

Polygon geometry coordinate cells with interior ring variables.

7

Rotated pole dimension coordinate constructs and 2-d latitude and longitude auxiliary coordinate constructs.

8

A UGRID mesh topology of face cells.

9

A UGRID mesh topology of edge cells.

10

A UGRID mesh topology of point cells.

11

Discrete sampling geometry (DSG) “trajectory” features.

If no individual field constructs are selected then all available field constructs will be returned.

Field constructs may be selected multiple time, and will be output in the order that they are given.

See the cfdm.example_field for details.

_func: function

The function that returns each individual field construct.

Returns:
list

The example field constructs.

Examples

>>> cfdm.example_fields()
[<Field: specific_humidity(latitude(5), longitude(8)) 1>,
 <Field: air_temperature(atmosphere_hybrid_height_coordinate(1), grid_latitude(10), grid_longitude(9)) K>,
 <Field: air_potential_temperature(time(36), latitude(5), longitude(8)) K>,
 <Field: precipitation_flux(cf_role=timeseries_id(4), ncdim%timeseries(9)) kg m-2 day-1>,
 <Field: air_temperature(cf_role=timeseries_id(3), ncdim%timeseries(26), ncdim%profile_1(4)) K>,
 <Field: air_potential_temperature(time(118), latitude(5), longitude(8)) K>,
 <Field: precipitation_amount(cf_role=timeseries_id(2), time(4))>,
 <Field: eastward_wind(time(3), air_pressure(1), grid_latitude(4), grid_longitude(5)) m s-1>,
 <Field: air_temperature(time(2), ncdim%nMesh2_face(3)) K>,
 <Field: northward_wind(time(2), ncdim%nMesh2_edge(9)) ms-1>,
 <Field: air_pressure(time(2), ncdim%nMesh2_node(7)) hPa>,
 <CF Field: mole_fraction_of_ozone_in_air(cf_role=trajectory_id(1), ncdim%trajectory(4)) ppb>]

>>> cfdm.example_fields(7, 1)
[<Field: eastward_wind(time(3), air_pressure(1), grid_latitude(4), grid_longitude(5)) m s-1>,
 <Field: air_temperature(atmosphere_hybrid_height_coordinate(1), grid_latitude(10), grid_longitude(9)) K>]

>>> cfdm.example_fields(3)
[<Field: precipitation_flux(cf_role=timeseries_id(4), ncdim%timeseries(9)) kg m-2 day-1>]

>>> cfdm.example_fields(3, 3, 4)
[<Field: precipitation_flux(cf_role=timeseries_id(4), ncdim%timeseries(9)) kg m-2 day-1>,
 <Field: precipitation_flux(cf_role=timeseries_id(4), ncdim%timeseries(9)) kg m-2 day-1>,
 <Field: air_temperature(cf_role=timeseries_id(3), ncdim%timeseries(26), ncdim%profile_1(4)) K>]

See the cfdm.example_field for more details.