ancil_fill_n_merge.py

For a full description see ants.cli.ancil_fill_n_merge.

usage: ancil_fill_n_merge [-h] --output OUTPUT [--ants-config ANTS_CONFIG]
                          [--netcdf-only] [--begin BEGIN] [--end END]
                          [--target-lsm TARGET_LSM]
                          [--land-threshold LAND_THRESHOLD]
                          [--polygon POLYGON] [--invert-mask]
                          [--search-method SEARCH_METHOD]
                          sources [sources ...]

Positional Arguments

sources

Source data path(s).

Additional arguments

--output, -o

Output filepath, which must be different from the source input file(s).

--ants-config

Configuration path. See ants.config

--netcdf-only

Only write out a netCDF file.

Default: False

--begin, -b

Year to start the processing in the format ‘YYYY’ e.g. ‘1990’.

--end, -e

Year to end the processing in the format ‘YYYY’ e.g. ‘2010’. For a single year of data, this should be the same as the argument given to the --begin argument.

--target-lsm

Path to the land sea mask. If not supplied, the missing neighbour search considers all points valid to choose from.

--land-threshold

Land fraction threshold for converting land fraction to a landsea mask. Fractions greater than this specified are masked. Required if the field provided is a land fraction rather than land binary mask field.

--polygon

Validity polygon filepath. If not supplied, the entirety of the primary takes priority except in the presence of NAN values. This is expected to be a shapefile and is read by cartopy.io.shapereader.Reader. If the primary source is wholly within the polygon then a runtime error will be raised.

--invert-mask

Invert the provided target_mask or not. Using this argument will set it to False. When set to True, treat target mask True (1) values as unmasked. When set to False, treat target mask True (1) values as masked. It is common to use this argument to denote source ocean fields as the landsea mask has True values to denote land.

Default: True

--search-method

Select the search method used when filling.

Default: 'spiral'