LSST Applications g0aad566f14+98bdd3b178,g0dd44d6229+e0c2448475,g2079a07aa2+86d27d4dc4,g2305ad1205+28192cebb5,g2bbee38e9b+047b288a59,g337abbeb29+047b288a59,g33d1c0ed96+047b288a59,g3a166c0a6a+047b288a59,g3d1719c13e+98bdd3b178,g487adcacf7+08349b74a1,g4be5004598+98bdd3b178,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+742623b69a,g63cd9335cc+585e252eca,g858d7b2824+98bdd3b178,g88963caddf+0cb8e002cc,g88c60e1ba4+10d1129650,g99cad8db69+26979ce5a5,g9ddcbc5298+9a081db1e4,ga1e77700b3+a912195c07,gae0086650b+585e252eca,gb0e22166c9+60f28cb32d,gb1fda7adca+90d62c6f66,gb3a676b8dc+b4feba26a1,gb4b16eec92+950562e714,gba4ed39666+c2a2e4ac27,gbb8dafda3b+2fe9a6a885,gc120e1dc64+0553034b2f,gc28159a63d+047b288a59,gc3e9b769f7+f8a3f20ab6,gcf0d15dbbd+e0c2448475,gdaeeff99f8+f9a426f77a,gdb0af172c8+f61b8374e1,ge79ae78c31+047b288a59,w.2024.20
LSST Data Management Base Package
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.fit_multiband.CatalogExposure Class Reference
Inheritance diagram for lsst.pipe.tasks.fit_multiband.CatalogExposure:
lsst.pipe.tasks.fit_coadd_multiband.CatalogExposureInputs lsst.pipe.tasks.fit_coadd_psf.CatalogExposurePsf

Public Member Functions

str band (self)
afwImage.PhotoCalib|None calib (self)
 __post_init__ (self)

Static Public Attributes

dafButler dataId
afwTable catalog = Field(None, title="The measurement catalog, if any")
afwImage exposure = Field(None, title="The exposure, if any")
int id_tract_patch = Field(0, title="A unique ID for this tract-patch pair")
dict metadata = Field(default_factory=dict, title="Arbitrary metadata")

Detailed Description

A class to store a catalog, exposure, and metadata for a given dataId.

The intent is to store an exposure and an associated measurement catalog.
Users may omit one but not both (e.g. if the intent is just to attach
a dataId and metadata to a catalog or exposure).

Definition at line 37 of file

Member Function Documentation

◆ __post_init__()

lsst.pipe.tasks.fit_multiband.CatalogExposure.__post_init__ ( self)

Definition at line 59 of file

59 def __post_init__(self):
60 if self.catalog is None and self.exposure is None:
61 raise ValueError("Must specify at least one of catalog/exposure")
62 if 'band' not in self.dataId:
63 raise ValueError(f"dataId={self.dataId} must have a band")

◆ band()

str ( self)

Definition at line 45 of file

45 def band(self) -> str:
46 return self.dataId['band']
OptionalString band

◆ calib()

afwImage.PhotoCalib | None lsst.pipe.tasks.fit_multiband.CatalogExposure.calib ( self)

Definition at line 49 of file

49 def calib(self) -> afwImage.PhotoCalib | None:
50 return None if self.exposure is None else self.exposure.getPhotoCalib()
Key< int > calib

Member Data Documentation

◆ catalog

afwTable lsst.pipe.tasks.fit_multiband.CatalogExposure.catalog = Field(None, title="The measurement catalog, if any")

Definition at line 54 of file

◆ dataId

dafButler lsst.pipe.tasks.fit_multiband.CatalogExposure.dataId
Initial value:
= Field(
title="A DataCoordinate or dict containing a 'band' item")

Definition at line 52 of file

◆ exposure

afwImage lsst.pipe.tasks.fit_multiband.CatalogExposure.exposure = Field(None, title="The exposure, if any")

Definition at line 55 of file

◆ id_tract_patch

int lsst.pipe.tasks.fit_multiband.CatalogExposure.id_tract_patch = Field(0, title="A unique ID for this tract-patch pair")

Definition at line 56 of file

◆ metadata

dict lsst.pipe.tasks.fit_multiband.CatalogExposure.metadata = Field(default_factory=dict, title="Arbitrary metadata")

Definition at line 57 of file

The documentation for this class was generated from the following file: