ProcessCcdWithFakesTask¶
- class lsst.pipe.tasks.processCcdWithFakes.ProcessCcdWithFakesTask(schema=None, **kwargs)¶
Bases:
PipelineTask
Insert fake objects into calexps.
Add fake stars and galaxies to the given calexp, specified in the dataRef. Galaxy parameters are read in from the specified file and then modelled using galsim. Re-runs characterize image and calibrate image to give a new background estimation and measurement of the calexp.
ProcessFakeSourcesTask
inherits six functions from insertFakesTask that make images of the fake sources and then add them to the calexp.addPixCoords
Use the WCS information to add the pixel coordinates of each source Adds an
x
andy
column to the catalog of fake sources.trimFakeCat
Trim the fake cat to about the size of the input image.
mkFakeGalsimGalaxies
Use Galsim to make fake double sersic galaxies for each set of galaxy parameters in the input file.
mkFakeStars
Use the PSF information from the calexp to make a fake star using the magnitude information from the input file.
cleanCat
Remove rows of the input fake catalog which have half light radius, of either the bulge or the disk, that are 0.
addFakeSources
Add the fake sources to the calexp.
Notes
The
calexp
with fake souces added to it is written out as the datatypecalexp_fakes
.Attributes Summary
Methods Summary
composeFakeCat
(fakeCats, skyMap)Concatenate the fakeCats from tracts that may cover the exposure.
copyCalibrationFields
(calibCat, sourceCat, ...)Match sources in calibCat and sourceCat and copy the specified fields
Empty (clear) the metadata for this Task and all sub-Tasks.
Get metadata for all tasks.
Get the task name as a hierarchical name including parent task names.
getName
()Get the name of the task.
Get a dictionary of all tasks as a shallow copy.
getVisitMatchedFakeCat
(fakeCat, exposure)Trim the fakeCat to select particular visit
makeField
(doc)Make a
lsst.pex.config.ConfigurableField
for this task.makeSubtask
(name, **keyArgs)Create a subtask as a new instance as the
name
attribute of this task.run
(fakeCats, exposure, skyMap[, wcs, ...])Add fake sources to a calexp and then run detection, deblending and measurement.
runQuantum
(butlerQC, inputRefs, outputRefs)Do butler IO and transform to provide in memory objects for tasks
run
method.timer
(name[, logLevel])Context manager to log performance data for an arbitrary block of code.
Attributes Documentation
Methods Documentation
- composeFakeCat(fakeCats, skyMap)¶
Concatenate the fakeCats from tracts that may cover the exposure.
- Parameters:
- fakeCats
list
oflsst.daf.butler.DeferredDatasetHandle
Set of fake cats to concatenate.
- skyMap
lsst.skymap.SkyMap
SkyMap defining the geometry of the tracts and patches.
- fakeCats
- Returns:
- combinedFakeCat
pandas.DataFrame
All fakes that cover the inner polygon of the tracts in this quantum.
- combinedFakeCat
- copyCalibrationFields(calibCat, sourceCat, fieldsToCopy)¶
Match sources in calibCat and sourceCat and copy the specified fields
- Parameters:
- calibCat
lsst.afw.table.SourceCatalog
Catalog from which to copy fields.
- sourceCat
lsst.afw.table.SourceCatalog
Catalog to which to copy fields.
- fieldsToCopy
lsst.pex.config.listField.List
Fields to copy from calibCat to SoourceCat.
- calibCat
- Returns:
- newCat
lsst.afw.table.SourceCatalog
Catalog which includes the copied fields.
- The fields copied are those specified by
fieldsToCopy
that actually exist - in the schema of
calibCat
. - This version was based on and adapted from the one in calibrateTask.
- newCat
- getFullMetadata() TaskMetadata ¶
Get metadata for all tasks.
- Returns:
- metadata
TaskMetadata
The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.
- metadata
Notes
The returned metadata includes timing information (if
@timer.timeMethod
is used) and any metadata set by the task. The name of each item consists of the full task name with.
replaced by:
, followed by.
and the name of the item, e.g.:topLevelTaskName:subtaskName:subsubtaskName.itemName
using
:
in the full task name disambiguates the rare situation that a task has a subtask and a metadata item with the same name.
- getFullName() str ¶
Get the task name as a hierarchical name including parent task names.
- Returns:
- fullName
str
The full name consists of the name of the parent task and each subtask separated by periods. For example:
The full name of top-level task “top” is simply “top”.
The full name of subtask “sub” of top-level task “top” is “top.sub”.
The full name of subtask “sub2” of subtask “sub” of top-level task “top” is “top.sub.sub2”.
- fullName
- getName() str ¶
Get the name of the task.
- Returns:
- taskName
str
Name of the task.
- taskName
See also
getFullName
Get the full name of the task.
- getTaskDict() dict[str, weakref.ReferenceType[lsst.pipe.base.task.Task]] ¶
Get a dictionary of all tasks as a shallow copy.
- Returns:
- taskDict
dict
Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.
- taskDict
- getVisitMatchedFakeCat(fakeCat, exposure)¶
Trim the fakeCat to select particular visit
- Parameters:
- fakeCat
pandas.core.frame.DataFrame
The catalog of fake sources to add to the exposure
- exposure
lsst.afw.image.exposure.exposure.ExposureF
The exposure to add the fake sources to
- fakeCat
- Returns:
- movingFakeCat
pandas.DataFrame
All fakes that belong to the visit
- movingFakeCat
- classmethod makeField(doc: str) ConfigurableField ¶
Make a
lsst.pex.config.ConfigurableField
for this task.- Parameters:
- doc
str
Help text for the field.
- doc
- Returns:
- configurableField
lsst.pex.config.ConfigurableField
A
ConfigurableField
for this task.
- configurableField
Examples
Provides a convenient way to specify this task is a subtask of another task.
Here is an example of use:
class OtherTaskConfig(lsst.pex.config.Config): aSubtask = ATaskClass.makeField("brief description of task")
- makeSubtask(name: str, **keyArgs: Any) None ¶
Create a subtask as a new instance as the
name
attribute of this task.- Parameters:
- name
str
Brief name of the subtask.
- **keyArgs
Extra keyword arguments used to construct the task. The following arguments are automatically provided and cannot be overridden:
config
.parentTask
.
- name
Notes
The subtask must be defined by
Task.config.name
, an instance ofConfigurableField
orRegistryField
.
- run(fakeCats, exposure, skyMap, wcs=None, photoCalib=None, icSourceCat=None, sfdSourceCat=None, externalSkyWcsGlobalCatalog=None, externalSkyWcsTractCatalog=None, externalPhotoCalibGlobalCatalog=None, externalPhotoCalibTractCatalog=None, idGenerator=None)¶
Add fake sources to a calexp and then run detection, deblending and measurement.
- Parameters:
- fakeCats
list
oflsst.daf.butler.DeferredDatasetHandle
Set of tract level fake catalogs that potentially cover this detectorVisit.
- exposure
lsst.afw.image.exposure.exposure.ExposureF
The exposure to add the fake sources to.
- skyMap
lsst.skymap.SkyMap
SkyMap defining the tracts and patches the fakes are stored over.
- wcs
lsst.afw.geom.SkyWcs
, optional WCS to use to add fake sources.
- photoCalib
lsst.afw.image.photoCalib.PhotoCalib
, optional Photometric calibration to be used to calibrate the fake sources.
- icSourceCat
lsst.afw.table.SourceCatalog
, optional Catalog to take the information about which sources were used for calibration from.
- sfdSourceCat
lsst.afw.table.SourceCatalog
, optional Catalog produced by singleFrameDriver, needed to copy some calibration flags from.
- externalSkyWcsGlobalCatalog
lsst.afw.table.ExposureCatalog
, optional Exposure catalog with external skyWcs to be applied per config.
- externalSkyWcsTractCatalog
lsst.afw.table.ExposureCatalog
, optional Exposure catalog with external skyWcs to be applied per config.
- externalPhotoCalibGlobalCatalog
lsst.afw.table.ExposureCatalog
, optional Exposure catalog with external photoCalib to be applied per config
- externalPhotoCalibTractCatalog
lsst.afw.table.ExposureCatalog
, optional Exposure catalog with external photoCalib to be applied per config.
- idGenerator
lsst.meas.base.IdGenerator
, optional Object that generates Source IDs and random seeds.
- fakeCats
- Returns:
- resultStruct
lsst.pipe.base.struct.Struct
Result struct containing:
outputExposure:
lsst.afw.image.exposure.exposure.ExposureF
outputCat:
lsst.afw.table.source.source.SourceCatalog
- resultStruct
Notes
Adds pixel coordinates for each source to the fakeCat and removes objects with bulge or disk half light radius = 0 (if
config.cleanCat = True
). These columns are calledx
andy
and are in pixels.Adds the
Fake
mask plane to the exposure which is then set byaddFakeSources
to mark where fake sources have been added. Uses the information in thefakeCat
to make fake galaxies (using galsim) and fake stars, using the PSF models from the PSF information for the calexp. These are then added to the calexp and the calexp with fakes included returned.The galsim galaxies are made using a double sersic profile, one for the bulge and one for the disk, this is then convolved with the PSF at that point.
- runQuantum(butlerQC, inputRefs, outputRefs)¶
Do butler IO and transform to provide in memory objects for tasks
run
method.- Parameters:
- butlerQC
QuantumContext
A butler which is specialized to operate in the context of a
lsst.daf.butler.Quantum
.- inputRefs
InputQuantizedConnection
Datastructure whose attribute names are the names that identify connections defined in corresponding
PipelineTaskConnections
class. The values of these attributes are thelsst.daf.butler.DatasetRef
objects associated with the defined input/prerequisite connections.- outputRefs
OutputQuantizedConnection
Datastructure whose attribute names are the names that identify connections defined in corresponding
PipelineTaskConnections
class. The values of these attributes are thelsst.daf.butler.DatasetRef
objects associated with the defined output connections.
- butlerQC