LSST Applications g013ef56533+d2224463a4,g199a45376c+0ba108daf9,g19c4beb06c+9f335b2115,g1fd858c14a+2459ca3e43,g210f2d0738+2d3d333a78,g262e1987ae+abbb004f04,g2825c19fe3+eedc38578d,g29ae962dfc+0cb55f06ef,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+19c3a54948,g47891489e3+501a489530,g4cdb532a89+a047e97985,g511e8cfd20+ce1f47b6d6,g53246c7159+8c5ae1fdc5,g54cd7ddccb+890c8e1e5d,g5fd55ab2c7+951cc3f256,g64539dfbff+2d3d333a78,g67b6fd64d1+501a489530,g67fd3c3899+2d3d333a78,g74acd417e5+0ea5dee12c,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+501a489530,g8d7436a09f+5ea4c44d25,g8ea07a8fe4+81eaaadc04,g90f42f885a+34c0557caf,g9486f8a5af+165c016931,g97be763408+d5e351dcc8,gbf99507273+8c5ae1fdc5,gc2a301910b+2d3d333a78,gca7fc764a6+501a489530,gce8aa8abaa+8c5ae1fdc5,gd7ef33dd92+501a489530,gdab6d2f7ff+0ea5dee12c,ge410e46f29+501a489530,geaed405ab2+e3b4b2a692,gf9a733ac38+8c5ae1fdc5,w.2025.41
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.