lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConfig:

Static Public Attributes
	measurement
	doApCorr
	applyApCorr
	doDirectPhotometry
	doDifferencePhotometry
	refCatIdColumn
	refCatRaColumn
	refCatDecColumn
	idGenerator = DetectorVisitIdGeneratorConfig.make_field()
	exposure
	diaExposure
	refCat
	skyMap
	outputCatalog

Detailed Description

Configuration for the ForcedPhotDetectorTask.

Definition at line 88 of file forcedPhotDetector.py.

Member Data Documentation

applyApCorr

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConfig.applyApCorr

static

Initial value:

=  lsst.pex.config.ConfigurableField(
        target=ApplyApCorrTask,
        doc="Subtask to apply aperture corrections"
    )

Definition at line 100 of file forcedPhotDetector.py.

diaExposure

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConnections.diaExposure

staticinherited

Initial value:

=  cT.Input(
        doc="Input difference image to perform photometry on.",
        name="difference_image",
        storageClass="ExposureF",
        dimensions=["visit", "detector"],
    )

Definition at line 51 of file forcedPhotDetector.py.

doApCorr

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConfig.doApCorr

static

Initial value:

=  lsst.pex.config.Field(
        dtype=bool,
        default=True,
        doc="Run subtask to apply aperture corrections"
    )

Definition at line 95 of file forcedPhotDetector.py.

doDifferencePhotometry

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConfig.doDifferencePhotometry

static

Initial value:

=  lsst.pex.config.Field(
        doc="Perform photometry on the difference image.",
        dtype=bool,
        default=True,
    )

Definition at line 109 of file forcedPhotDetector.py.

doDirectPhotometry

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConfig.doDirectPhotometry

static

Initial value:

=  lsst.pex.config.Field(
        doc="Perform direct photometry on the input exposure.",
        dtype=bool,
        default=True,
    )

Definition at line 104 of file forcedPhotDetector.py.

exposure

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConnections.exposure

staticinherited

Initial value:

=  cT.Input(
        doc="Input exposure to perform photometry on.",
        name="visit_image",
        storageClass="ExposureF",
        dimensions=["visit", "detector"],
    )

Definition at line 45 of file forcedPhotDetector.py.

idGenerator

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConfig.idGenerator = DetectorVisitIdGeneratorConfig.make_field()

static

Definition at line 141 of file forcedPhotDetector.py.

measurement

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConfig.measurement

static

Initial value:

=  lsst.pex.config.ConfigurableField(
        target=SimpleForcedMeasurementTask,
        doc="subtask to do forced measurement"
    )

Definition at line 91 of file forcedPhotDetector.py.

outputCatalog

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConnections.outputCatalog

staticinherited

Initial value:

=  cT.Output(
        doc="Output forced photometry catalog.",
        name="object_forced_source_unstandardized",
        storageClass="DataFrame",
        dimensions=("visit", "detector", "skymap", "tract")
    )

Definition at line 71 of file forcedPhotDetector.py.

refCat

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConnections.refCat

staticinherited

Initial value:

=  cT.Input(
        doc="Catalog of shapes and positions at which to force photometry.",
        name="object_patch",
        storageClass="ArrowAstropy",
        dimensions=["tract", "patch"],
        multiple=True,
        deferLoad=True,
    )

Definition at line 57 of file forcedPhotDetector.py.

refCatDecColumn

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConfig.refCatDecColumn

static

Initial value:

=  lsst.pex.config.Field(
        dtype=str,
        default="coord_dec",
        doc=(
            "Name of the column that provides the declination (in floating-point degrees) from the "
            "refCat connection. "
            "Ignored if refCatStorageClass='SourceCatalog'."
        )
    )

Definition at line 132 of file forcedPhotDetector.py.

refCatIdColumn

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConfig.refCatIdColumn

static

Initial value:

=  lsst.pex.config.Field(
        dtype=str,
        default="objectId",
        doc=(
            "Name of the column that provides the object ID from the refCat connection. "
            "measurement.copyColumns['id'] must be set to this value as well."
            "Ignored if refCatStorageClass='SourceCatalog'."
        )
    )

Definition at line 114 of file forcedPhotDetector.py.

refCatRaColumn

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConfig.refCatRaColumn

static

Initial value:

=  lsst.pex.config.Field(
        dtype=str,
        default="coord_ra",
        doc=(
            "Name of the column that provides the right ascension (in floating-point degrees) from the "
            "refCat connection. "
            "Ignored if refCatStorageClass='SourceCatalog'."
        )
    )

Definition at line 123 of file forcedPhotDetector.py.

skyMap

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorConnections.skyMap

staticinherited

Initial value:

=  cT.Input(
        doc="SkyMap dataset that defines the coordinate system of the reference catalog.",
        name=BaseSkyMap.SKYMAP_DATASET_TYPE_NAME,
        storageClass="SkyMap",
        dimensions=["skymap"],
    )

Definition at line 65 of file forcedPhotDetector.py.

---

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

• python/lsst/pipe/tasks/forcedPhotDetector.py