lsst.pipe.tasks  18.0.0-5-g03367ae0
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.insertFakes.InsertFakesConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.insertFakes.InsertFakesConfig:

Public Member Functions

def setDefaults (self)
 

Static Public Attributes

 raColName
 
 decColName
 
 doCleanCat
 
 diskHLR
 
 bulgeHLR
 
 magVar
 
 nDisk
 
 nBulge
 
 aDisk
 
 aBulge
 
 bDisk
 
 bBulge
 
 paDisk
 
 paBulge
 
 fakeType
 
 calibFluxRadius
 
 image
 
 fakeCat
 
 imageWithFakes
 
 coaddName
 

Detailed Description

Config for inserting fake sources

Notes
-----
The default column names are those from the University of Washington sims database.

Definition at line 43 of file insertFakes.py.

Member Function Documentation

◆ setDefaults()

def lsst.pipe.tasks.insertFakes.InsertFakesConfig.setDefaults (   self)

Definition at line 182 of file insertFakes.py.

Member Data Documentation

◆ aBulge

lsst.pipe.tasks.insertFakes.InsertFakesConfig.aBulge
static
Initial value:
= pexConfig.Field(
doc="The column name for the semi major axis length of the bulge component.",
dtype=str,
default="a_b",
)

Definition at line 107 of file insertFakes.py.

◆ aDisk

lsst.pipe.tasks.insertFakes.InsertFakesConfig.aDisk
static
Initial value:
= pexConfig.Field(
doc="The column name for the semi major axis length of the disk component used in the fake source"
"catalog.",
dtype=str,
default="a_d",
)

Definition at line 100 of file insertFakes.py.

◆ bBulge

lsst.pipe.tasks.insertFakes.InsertFakesConfig.bBulge
static
Initial value:
= pexConfig.Field(
doc="The column name for the semi minor axis length of the bulge component used in the fake source "
"catalog.",
dtype=str,
default="b_b",
)

Definition at line 119 of file insertFakes.py.

◆ bDisk

lsst.pipe.tasks.insertFakes.InsertFakesConfig.bDisk
static
Initial value:
= pexConfig.Field(
doc="The column name for the semi minor axis length of the disk component.",
dtype=str,
default="b_d",
)

Definition at line 113 of file insertFakes.py.

◆ bulgeHLR

lsst.pipe.tasks.insertFakes.InsertFakesConfig.bulgeHLR
static
Initial value:
= pexConfig.Field(
doc="Column name for the bulge half light radius used in the fake source catalog.",
dtype=str,
default="BulgeHalfLightRadius",
)

Definition at line 75 of file insertFakes.py.

◆ calibFluxRadius

lsst.pipe.tasks.insertFakes.InsertFakesConfig.calibFluxRadius
static
Initial value:
= pexConfig.Field(
doc="Radius for the calib flux (in pixels).",
dtype=float,
default=12.0,
)

Definition at line 146 of file insertFakes.py.

◆ coaddName

lsst.pipe.tasks.insertFakes.InsertFakesConfig.coaddName
static
Initial value:
= pexConfig.Field(
doc="The name of the type of coadd used",
dtype=str,
default="deep",
)

Definition at line 176 of file insertFakes.py.

◆ decColName

lsst.pipe.tasks.insertFakes.InsertFakesConfig.decColName
static
Initial value:
= pexConfig.Field(
doc="Dec. column name used in the fake source catalog.",
dtype=str,
default="decJ2000",
)

Definition at line 57 of file insertFakes.py.

◆ diskHLR

lsst.pipe.tasks.insertFakes.InsertFakesConfig.diskHLR
static
Initial value:
= pexConfig.Field(
doc="Column name for the disk half light radius used in the fake source catalog.",
dtype=str,
default="DiskHalfLightRadius",
)

Definition at line 69 of file insertFakes.py.

◆ doCleanCat

lsst.pipe.tasks.insertFakes.InsertFakesConfig.doCleanCat
static
Initial value:
= pexConfig.Field(
doc="If true removes bad sources from the catalog.",
dtype=bool,
default=True,
)

Definition at line 63 of file insertFakes.py.

◆ fakeCat

lsst.pipe.tasks.insertFakes.InsertFakesConfig.fakeCat
static
Initial value:
= pipeBase.InputDatasetField(
doc="Catalog of fake sources to draw inputs from.",
nameTemplate="{CoaddName}Coadd_fakeSourceCat",
scalar=True,
storageClass="Parquet",
dimensions=("Tract", "SkyMap")
)

Definition at line 160 of file insertFakes.py.

◆ fakeType

lsst.pipe.tasks.insertFakes.InsertFakesConfig.fakeType
static
Initial value:
= pexConfig.Field(
doc="What type of fake catalog to use, snapshot (includes variability in the magnitudes calculated "
"from the MJD of the image), static (no variability) or filename for a user defined fits"
"catalog.",
dtype=str,
default="static",
)

Definition at line 138 of file insertFakes.py.

◆ image

lsst.pipe.tasks.insertFakes.InsertFakesConfig.image
static
Initial value:
= pipeBase.InputDatasetField(
doc="Image into which fakes are to be added.",
nameTemplate="{CoaddName}Coadd",
scalar=True,
storageClass="ExposureF",
dimensions=("Tract", "Patch", "AbstractFilter", "SkyMap")
)

Definition at line 152 of file insertFakes.py.

◆ imageWithFakes

lsst.pipe.tasks.insertFakes.InsertFakesConfig.imageWithFakes
static
Initial value:
= pipeBase.OutputDatasetField(
doc="Image with fake sources added.",
nameTemplate="fakes_{CoaddName}Coadd",
scalar=True,
storageClass="ExposureF",
dimensions=("Tract", "Patch", "AbstractFilter", "SkyMap")
)

Definition at line 168 of file insertFakes.py.

◆ magVar

lsst.pipe.tasks.insertFakes.InsertFakesConfig.magVar
static
Initial value:
= pexConfig.Field(
doc="The column name for the magnitude calculated taking variability into account. In the format "
"``filter name``magVar, e.g. imagVar for the magnitude in the i band.",
dtype=str,
default="%smagVar",
)

Definition at line 81 of file insertFakes.py.

◆ nBulge

lsst.pipe.tasks.insertFakes.InsertFakesConfig.nBulge
static
Initial value:
= pexConfig.Field(
doc="The column name for the sersic index of the bulge component used in the fake source catalog.",
dtype=str,
default="bulge_n",
)

Definition at line 94 of file insertFakes.py.

◆ nDisk

lsst.pipe.tasks.insertFakes.InsertFakesConfig.nDisk
static
Initial value:
= pexConfig.Field(
doc="The column name for the sersic index of the disk component used in the fake source catalog.",
dtype=str,
default="disk_n",
)

Definition at line 88 of file insertFakes.py.

◆ paBulge

lsst.pipe.tasks.insertFakes.InsertFakesConfig.paBulge
static
Initial value:
= pexConfig.Field(
doc="The column name for the PA of the bulge component used in the fake source catalog.",
dtype=str,
default="pa_bulge",
)

Definition at line 132 of file insertFakes.py.

◆ paDisk

lsst.pipe.tasks.insertFakes.InsertFakesConfig.paDisk
static
Initial value:
= pexConfig.Field(
doc="The column name for the PA of the disk component used in the fake source catalog.",
dtype=str,
default="pa_disk",
)

Definition at line 126 of file insertFakes.py.

◆ raColName

lsst.pipe.tasks.insertFakes.InsertFakesConfig.raColName
static
Initial value:
= pexConfig.Field(
doc="RA column name used in the fake source catalog.",
dtype=str,
default="raJ2000",
)

Definition at line 51 of file insertFakes.py.


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