lsst.pipe.tasks.processCcdWithFakes.docstring Class Reference

Inheritance diagram for lsst.pipe.tasks.processCcdWithFakes.docstring:

Detailed Description

doApplyExternalGlobalPhotoCalib = pexConfig.Field(
    dtype=bool,
    default=False,
    doc="Whether to apply an external photometric calibration via an "
        "`lsst.afw.image.PhotoCalib` object. Uses the "
        "`externalPhotoCalibName` config option to determine which "
        "calibration to use. Uses a global calibration."
)

doApplyExternalTractPhotoCalib = pexConfig.Field(
    dtype=bool,
    default=False,
    doc="Whether to apply an external photometric calibration via an "
        "`lsst.afw.image.PhotoCalib` object. Uses the "
        "`externalPhotoCalibName` config option to determine which "
        "calibration to use. Uses a per tract calibration."
)

externalPhotoCalibName = pexConfig.ChoiceField(
    doc="What type of external photo calib to use.",
    dtype=str,
    default="jointcal",
    allowed={"jointcal": "Use jointcal_photoCalib",
             "fgcm": "Use fgcm_photoCalib",
             "fgcm_tract": "Use fgcm_tract_photoCalib"}
)

doApplyExternalGlobalSkyWcs = pexConfig.Field(
    dtype=bool,
    default=False,
    doc="Whether to apply an external astrometric calibration via an "
        "`lsst.afw.geom.SkyWcs` object. Uses the "
        "`externalSkyWcsName` config option to determine which "
        "calibration to use. Uses a global calibration."
)

doApplyExternalTractSkyWcs = pexConfig.Field(
    dtype=bool,
    default=False,
    doc="Whether to apply an external astrometric calibration via an "
        "`lsst.afw.geom.SkyWcs` object. Uses the "
        "`externalSkyWcsName` config option to determine which "
        "calibration to use. Uses a per tract calibration."
)

externalSkyWcsName = pexConfig.ChoiceField(
    doc="What type of updated WCS calib to use.",
    dtype=str,
    default="gbdesAstrometricFit",
    allowed={"gbdesAstrometricFit": "Use gbdesAstrometricFit_wcs"}
)

coaddName = pexConfig.Field(
    doc="The name of the type of coadd used",
    dtype=str,
    default="deep",
)

srcFieldsToCopy = pexConfig.ListField(
    dtype=str,
    default=("calib_photometry_reserved", "calib_photometry_used", "calib_astrometry_used",
             "calib_psf_candidate", "calib_psf_used", "calib_psf_reserved"),
    doc=("Fields to copy from the `src` catalog to the output catalog "
         "for matching sources Any missing fields will trigger a "
         "RuntimeError exception.")
)

matchRadiusPix = pexConfig.Field(
    dtype=float,
    default=3,
    doc=("Match radius for matching icSourceCat objects to sourceCat objects (pixels)"),
)

doMatchVisit = pexConfig.Field(
    dtype=bool,
    default=False,
    doc="Match visit to trim the fakeCat"
)

calibrate = pexConfig.ConfigurableField(target=CalibrateTask,
                                        doc="The calibration task to use.")

insertFakes = pexConfig.ConfigurableField(target=InsertFakesTask,
                                          doc="Configuration for the fake sources")

idGenerator = DetectorVisitIdGeneratorConfig.make_field()

def setDefaults(self):
    super().setDefaults()
    self.calibrate.measurement.plugins["base_PixelFlags"].masksFpAnywhere.append("FAKE")
    self.calibrate.measurement.plugins["base_PixelFlags"].masksFpCenter.append("FAKE")
    self.calibrate.doAstrometry = False
    self.calibrate.doWriteMatches = False
    self.calibrate.doPhotoCal = False
    self.calibrate.doComputeSummaryStats = False
    self.calibrate.detection.reEstimateBackground = False


class ProcessCcdWithFakesTask(PipelineTask):

_DefaultName = "processCcdWithFakes"
ConfigClass = ProcessCcdWithFakesConfig

def __init__(self, schema=None, **kwargs):

Definition at line 298 of file processCcdWithFakes.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/g2a9a014e59+6f9be1b9cd/python/lsst/pipe/tasks/processCcdWithFakes.py