lsst.sphgeom._yaml Namespace Reference

Functions
	region_representer (dumper, data)
	region_constructor (loader, node)
	pixel_representer (dumper, data)
	pixel_constructor (loader, node)

Variables
	yaml = None
	CLoader = None
tuple	YamlLoaders = (yaml.Loader, yaml.FullLoader, yaml.SafeLoader, yaml.UnsafeLoader)
	region_constructor
	Loader
	pixel_constructor

Detailed Description

Add support for YAML serialization of regions.

Function Documentation

pixel_constructor()

lsst.sphgeom._yaml.pixel_constructor	(		loader,
			node
	)

Construct a pixelization object from YAML.

Definition at line 103 of file _yaml.py.

def pixel_constructor(loader, node):
    """Construct a pixelization object from YAML."""
    mapping = loader.construct_mapping(node)
 
    className = node.tag
    pixelMap = {
        "lsst.sphgeom.Q3cPixelization": Q3cPixelization,
        "lsst.sphgeom.Mq3cPixelization": Mq3cPixelization,
        "lsst.sphgeom.HtmPixelization": HtmPixelization,
        "lsst.sphgeom.HealpixPixelization": HealpixPixelization,
    }
 
    if className not in pixelMap:
        raise RuntimeError(
            f"Encountered unexpected class {className} associated with sphgeom pixelization YAML constructor"
        )
 
    return pixelMap[className](mapping["level"])
 
 
# All the pixelization schemes use the same approach with getLevel

pixel_representer()

lsst.sphgeom._yaml.pixel_representer	(		dumper,
			data
	)

Represent a pixelization in YAML.

Stored as the pixelization level in a mapping with a single key
``level``.

Definition at line 94 of file _yaml.py.

def pixel_representer(dumper, data):
    """Represent a pixelization in YAML.
 
    Stored as the pixelization level in a mapping with a single key
    ``level``.
    """
    return dumper.represent_mapping(f"lsst.sphgeom.{type(data).__name__}", {"level": data.getLevel()})
 
 

region_constructor()

lsst.sphgeom._yaml.region_constructor	(		loader,
			node
	)

Construct a sphgeom region from YAML.

Definition at line 73 of file _yaml.py.

def region_constructor(loader, node):
    """Construct a sphgeom region from YAML."""
    mapping = loader.construct_mapping(node)
    encoded = bytes.fromhex(mapping["encoded"])
    # The generic Region base class can instantiate a region of the
    # correct type.
    return Region.decode(encoded)
 
 
# Register all the region classes with the same constructor and representer

region_representer()

lsst.sphgeom._yaml.region_representer	(		dumper,
			data
	)

Represent a sphgeom region object in a form suitable for YAML.

Stores the region as a mapping with a single ``encoded`` key
storing the hex encoded byte string.

Definition at line 63 of file _yaml.py.

def region_representer(dumper, data):
    """Represent a sphgeom region object in a form suitable for YAML.
 
    Stores the region as a mapping with a single ``encoded`` key
    storing the hex encoded byte string.
    """
    encoded = data.encode()
    return dumper.represent_mapping(f"lsst.sphgeom.{type(data).__name__}", {"encoded": encoded.hex()})
 
 

Variable Documentation

CLoader

lsst.sphgeom._yaml.CLoader = None

Definition at line 53 of file _yaml.py.

Loader

lsst.sphgeom._yaml.Loader

Definition at line 88 of file _yaml.py.

pixel_constructor

lsst.sphgeom._yaml.pixel_constructor

Definition at line 128 of file _yaml.py.

region_constructor

lsst.sphgeom._yaml.region_constructor

Definition at line 88 of file _yaml.py.

yaml

lsst.sphgeom._yaml.yaml = None

Definition at line 32 of file _yaml.py.

YamlLoaders

tuple lsst.sphgeom._yaml.YamlLoaders = (yaml.Loader, yaml.FullLoader, yaml.SafeLoader, yaml.UnsafeLoader)

Definition at line 55 of file _yaml.py.