ants.fileformats package

The ants package provides access to the fileformats commonly used in ancillary generation. These include those supported by iris and additional formats such as grid namelists and raster files.

ants.fileformats.load(*args, **kwargs)

Deprecated since version 2.1: Use ants.io.load.load() instead.

ants.fileformats.load_cube(*args, **kwargs)

Deprecated since version 2.1: Use ants.io.load.load_cube() instead.

ants.fileformats.load_cubes(*args, **kwargs)

Deprecated since version 2.1: Use ants.io.load.load_cubes() instead.

ants.fileformats.load_grid(filenames, *args, **kwargs)

Deprecated since version 2.1: Use ants.io.load.load_grid() instead.

ants.fileformats.load_landsea_mask(filename, land_threshold=None)

Deprecated since version 2.1: Use ants.io.load.load_landsea_mask() instead.

ants.fileformats.load_raw(*args, **kwargs)

Deprecated since version 2.1: Use ants.io.load.load_raw() instead.

Subpackages

• ants.fileformats.ancil package
  • Loading ancillary data
  • load_cubes()
  • load_cubes_32bit_ieee()
  • Submodules
  • ants.fileformats.ancil.preprocessing module
  • ants.fileformats.ancil.template module
  • ants.fileformats.ancil.time_headers module
• ants.fileformats.namelist package
  • apply_um_conventions()
  • load_cap_horizontal()
  • load_lfric_vertical()
  • load_um_vertical()
  • Submodules
  • ants.fileformats.namelist.umgrid module
• ants.fileformats.netcdf package
  • Submodules
  • ants.fileformats.netcdf.cf module
  • ants.fileformats.netcdf.ukca module
• ants.fileformats.pp package
  • Loading PP data
  • cube2pp()
  • field_filter()
  • field_filter_strict()
  • load_cubes()
  • load_cubes_little_endian()
  • load_ppfields()
  • pp2cubes()

Submodules

ants.fileformats.json module

class ants.fileformats.json.JSONLoader(keys=None, dtypes=None, case_sensitive=False)

Bases: object

JSON loader

__init__(keys=None, dtypes=None, case_sensitive=False)

JSON loader that handles validity checks, case handling.

Parameters:

• keys (str, optional) – The key name(s) to read from the JSON. When not provided, all keys are returned from the file.

• dtypes (str, optional) – These dtypes correspond to the return numpy dtype of the values extracted from the json. See numpy.dtype. If not provided, values extracted from the json are returned as-is.

• case_sensitive (bool, optional) – Determine whether the keys provided should be a case sensitive match with that in the file or not.

load(filename)

Load the provided JSON and return a dictionary.

Parameters:

filename (str) – Filepath for the JSON file.

Returns:

Dictionary representing the requested keys from the JSON.

Return type:

dict

ants.fileformats.json.load(filename, **kwargs)

JSON loader

Parameters:

**kwargs – See JSONLoader

Returns:

Dictionary representing the requested keys from the JSON.

Return type:

dict

ants.fileformats.raster module

Module for importing raster data to Iris cubes using the GDAL library.

See GDAL - Geospatial Data Abstraction Library for more information.

ants.fileformats.raster.load_cubes(filenames, callback=None)

Imports raster images using gdal and constructs a cube.

Parameters:

• filenames (str or list) – Input file name(s).

• callback (Callable, optional) – Function which can be passed on to iris.io.run_callback().

Returns:

cube – A 2D regularly gridded cube. The resulting cube has regular, contiguous bounds.

Return type:

iris.cube.Cube

Note

Unsigned integers are loaded as signed integers.