packers.py lsst::skymap::packers::SkyMapDimensionPacker lsst::skymap::packers #Thisfileispartofskymap. # #DevelopedfortheLSSTDataManagementSystem. #ThisproductincludessoftwaredevelopedbytheLSSTProject #(http://www.lsst.org). #SeetheCOPYRIGHTfileatthetop-leveldirectoryofthisdistribution #fordetailsofcodeownership. # #Thisprogramisfreesoftware:youcanredistributeitand/ormodify #itunderthetermsoftheGNUGeneralPublicLicenseaspublishedby #theFreeSoftwareFoundation,eitherversion3oftheLicense,or #(atyouroption)anylaterversion. # #Thisprogramisdistributedinthehopethatitwillbeuseful, #butWITHOUTANYWARRANTY;withouteventheimpliedwarrantyof #MERCHANTABILITYorFITNESSFORAPARTICULARPURPOSE.Seethe #GNUGeneralPublicLicenseformoredetails. # #YoushouldhavereceivedacopyoftheGNUGeneralPublicLicense #alongwiththisprogram.Ifnot,see<http://www.gnu.org/licenses/>. __all__=("SkyMapDimensionPacker",) fromlsst.daf.butlerimportDimensionPacker,DimensionGraph,DataCoordinate classSkyMapDimensionPacker(DimensionPacker): """A`DimensionPacker`fortract,patchandoptionallyband, givenaSkyMap. Parameters ---------- fixed:`lsst.daf.butler.DataCoordinate` ExpandeddataIDthatmustincludeatleasttheskymapdimension. dimensions:`lsst.daf.butler.DimensionGraph` ThedimensionsofdataIDspackedbythisinstance.Mustinclude skymap,tract,andpatch,andmayincludeband. """ SUPPORTED_FILTERS=[None]+list("ugrizyUBGVRIZYJHK")#splitstringintosinglechars """bandnamessupportedbythispacker. Newfiltersshouldbeaddedtotheendofthelisttomaximize compatibilitywithexistingIDs. """ @classmethod defgetIntFromFilter(cls,name): """Returnanintegerthatrepresentsthebandwiththegiven name. """ try: returncls.SUPPORTED_FILTERSSUPPORTED_FILTERS.index(name) exceptValueError: raiseNotImplementedError(f"band'{name}'notsupportedbythisIDpacker.") @classmethod defgetFilterNameFromInt(cls,num): """Returnanbandnamefromitsintegerrepresentation. """ returncls.SUPPORTED_FILTERSSUPPORTED_FILTERS[num] @classmethod defgetMaxIntForFilters(cls): returnlen(cls.SUPPORTED_FILTERSSUPPORTED_FILTERS) @classmethod defconfigure(cls,dimensions): #DocstringinheritedfromDataIdPacker.configure assertdimensions.given==["skymap"] assertdimensions.required.issuperset(["tract","patch"]) metadata={"skymap":["tract_max","patch_nx_max","patch_ny_max"]} kwds={} returnmetadata,kwds def__init__(self,fixed:DataCoordinate,dimensions:DimensionGraph): super().__init__(fixed,dimensions) record=fixed.records["skymap"] self._skyMapName_skyMapName=record.name self._patchMax_patchMax=record.patch_nx_max*record.patch_ny_max self._tractPatchMax_tractPatchMax=self._patchMax_patchMax*record.tract_max if"band"indimensions: self._filterMax_filterMax=self.getMaxIntForFiltersgetMaxIntForFilters() else: self._filterMax_filterMax=None @property defmaxBits(self)->int: #DocstringinheritedfromDataIdPacker.maxBits packedMax=self._tractPatchMax_tractPatchMax ifself._filterMax_filterMaxisnotNone: packedMax*=self._filterMax_filterMax returnpackedMax.bit_length() def_pack(self,dataId:DataCoordinate)->int: #DocstringinheritedfromDataIdPacker.pack packed=dataId["patch"]+self._patchMax_patchMax*dataId["tract"] ifself._filterMax_filterMaxisnotNone: packed+=self.getIntFromFiltergetIntFromFilter(dataId["band"])*self._tractPatchMax_tractPatchMax returnpacked defunpack(self,packedId:int)->DataCoordinate: #DocstringinheritedfromDataIdPacker.unpack d={"skymap":self._skyMapName_skyMapName} ifself._filterMax_filterMaxisnotNone: d["band"]=self.getFilterNameFromIntgetFilterNameFromInt(packedId//self._tractPatchMax_tractPatchMax) packedId%=self._tractPatchMax_tractPatchMax d["tract"]=packedId//self._patchMax_patchMax d["patch"]=packedId%self._patchMax_patchMax returnDataCoordinate.standardize(d,graph=self.dimensions)