LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
LSST Data Management Base Package
Loading...
Searching...
No Matches
Functions | Variables
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 109 of file _yaml.py.

109def pixel_constructor(loader, node):
110 """Construct a pixelization object from YAML."""
111 mapping = loader.construct_mapping(node)
112
113 className = node.tag
114 pixelMap = {
115 "lsst.sphgeom.Q3cPixelization": Q3cPixelization,
116 "lsst.sphgeom.Mq3cPixelization": Mq3cPixelization,
117 "lsst.sphgeom.HtmPixelization": HtmPixelization,
118 "lsst.sphgeom.HealpixPixelization": HealpixPixelization,
119 }
120
121 if className not in pixelMap:
122 raise RuntimeError(
123 f"Encountered unexpected class {className} associated with sphgeom pixelization YAML constructor"
124 )
125
126 return pixelMap[className](mapping["level"])
127
128
129# 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 100 of file _yaml.py.

100def pixel_representer(dumper, data):
101 """Represent a pixelization in YAML.
102
103 Stored as the pixelization level in a mapping with a single key
104 ``level``.
105 """
106 return dumper.represent_mapping(f"lsst.sphgeom.{type(data).__name__}", {"level": data.getLevel()})
107
108

◆ region_constructor()

lsst.sphgeom._yaml.region_constructor ( loader,
node )
Construct a sphgeom region from YAML.

Definition at line 79 of file _yaml.py.

79def region_constructor(loader, node):
80 """Construct a sphgeom region from YAML."""
81 mapping = loader.construct_mapping(node)
82 encoded = bytes.fromhex(mapping["encoded"])
83 # The generic Region base class can instantiate a region of the
84 # correct type.
85 return Region.decode(encoded)
86
87
88# 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 69 of file _yaml.py.

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

Variable Documentation

◆ CLoader

lsst.sphgeom._yaml.CLoader = None

Definition at line 59 of file _yaml.py.

◆ Loader

lsst.sphgeom._yaml.Loader

Definition at line 94 of file _yaml.py.

◆ pixel_constructor

lsst.sphgeom._yaml.pixel_constructor

Definition at line 134 of file _yaml.py.

◆ region_constructor

lsst.sphgeom._yaml.region_constructor

Definition at line 94 of file _yaml.py.

◆ yaml

lsst.sphgeom._yaml.yaml = None

Definition at line 38 of file _yaml.py.

◆ YamlLoaders

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

Definition at line 61 of file _yaml.py.