lsst.pipe.tasks.fit_multiband.CatalogExposure Class Reference

Inheritance diagram for lsst.pipe.tasks.fit_multiband.CatalogExposure:

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 fit_multiband.py.

Member Function Documentation

__post_init__()

lsst.pipe.tasks.fit_multiband.CatalogExposure.__post_init__

(

self

)

Definition at line 59 of file fit_multiband.py.

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

band()

str lsst.pipe.tasks.fit_multiband.CatalogExposure.band

(

self

)

Definition at line 45 of file fit_multiband.py.

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

calib()

afwImage.PhotoCalib | None lsst.pipe.tasks.fit_multiband.CatalogExposure.calib

(

self

)

Definition at line 49 of file fit_multiband.py.

    def calib(self) -> afwImage.PhotoCalib | None:
        return None if self.exposure is None else self.exposure.getPhotoCalib()
 

Member Data Documentation

catalog

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

static

Definition at line 54 of file fit_multiband.py.

dataId

dafButler lsst.pipe.tasks.fit_multiband.CatalogExposure.dataId

static

Initial value:

=  Field(
        title="A DataCoordinate or dict containing a 'band' item")

Definition at line 52 of file fit_multiband.py.

exposure

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

static

Definition at line 55 of file fit_multiband.py.

id_tract_patch

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

static

Definition at line 56 of file fit_multiband.py.

metadata

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

static

Definition at line 57 of file fit_multiband.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/ge6cb8fbbf7+d119aed356/python/lsst/pipe/tasks/fit_multiband.py