LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
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.