healpix_convert.ConvertSettings#

class healpix_convert.ConvertSettings(*, exclude_groups=<factory>, metadata=<factory>, multiscale_settings=<factory>, group_settings)[source]#

General settings for converting input Zarr dataset(s) onto HEALPix.

exclude_groups#: Groups to exclude from the conversion (won’t be included in output).

metadata#: Settings for the metadata (conventions) written in the output dataset.

multiscale_settings#: Settings for multiscale Zarr groups.

group_settings#: Conversion settings per group in the input Zarr dataset(s).

filter_and_replace(func)[source]#

Filter and replace conversion settings by applying a specified function over the settings of each group.

Parameters:: func (callable) – A function which accepts a string (group path) and a dictionary (group settings) as arguments and that returns a dictionary (new group settings).
Returns:: ConvertSettings – New conversion settings (validated).

native_refinement_levels(group)[source]#

Return the HEALPix refinement levels at which the children groups of a multiscale group are converted (level -> input group path).

Parameters:: group (pathlib.PurePath) – Path of the multiscale group in the input dataset(s).

classmethod from_dict(value)[source]#: Create a new settings object from a dictionary.

to_dict()[source]#: Return settings as a Python dictionary.

classmethod from_json(value)[source]#: Create a new settings object from a JSON-formatted string.

to_json()[source]#: Return settings as a JSON-formatted string.