Inheritance diagram for lsst.pipe.tasks.fakes.BaseFakeSourcesTask:

Public Member Functions
def	__init__ (self, **kwargs)

def	run (self, exposure, background)

Public Attributes
	bitmask

Static Public Attributes
	ConfigClass = BaseFakeSourcesConfig

Detailed Description

An abstract base class for subtasks that inject fake sources into images to test completeness and
other aspects of the processing.

This class simply adds a mask plane that subclasses should use to mark pixels that have been touched.

This is an abstract base class (abc) and is not intended to be directly used. To create a fake sources
injector, create a child class and re-implement the required methods.

Definition at line 36 of file fakes.py.

Constructor & Destructor Documentation

◆ init()

def lsst.pipe.tasks.fakes.BaseFakeSourcesTask.__init__	(		self,
		**	kwargs
	)

Initialize the Task.

Subclasses that define their own __init__ should simply forward all arguments to the base
class constructor.  They can then assume self.config is an instance of their ConfigClass.

If an external catalog is used to add sources consistently to multiple overlapping images,
that catalog should generally be loaded and attached to self here, so it can be used
multiple times by the run() method.

Definition at line 49 of file fakes.py.

     def __init__(self, **kwargs):
         """Initialize the Task.
  
         Subclasses that define their own __init__ should simply forward all arguments to the base
         class constructor.  They can then assume self.config is an instance of their ConfigClass.
  
         If an external catalog is used to add sources consistently to multiple overlapping images,
         that catalog should generally be loaded and attached to self here, so it can be used
         multiple times by the run() method.
         """
         lsst.pipe.base.Task.__init__(self, **kwargs)
         lsst.afw.image.Mask[lsst.afw.image.MaskPixel].addMaskPlane(self.config.maskPlaneName)
         self.bitmask = lsst.afw.image.Mask[lsst.afw.image.MaskPixel]\
             .getPlaneBitMask(self.config.maskPlaneName)
  

Member Function Documentation

◆ run()

def lsst.pipe.tasks.fakes.BaseFakeSourcesTask.run	(	self,
		exposure,
		background
	)

Add fake sources to the given Exposure, making use of the given BackgroundList if desired.

If pixels in the Exposure are replaced, not added to, extra care should be taken with the background,
mask, and variance planes.  The Exposure as given is background-subtracted (using the supplied
background model) and should be returned in the same state.

Definition at line 65 of file fakes.py.

     def run(self, exposure, background):
         """Add fake sources to the given Exposure, making use of the given BackgroundList if desired.
  
         If pixels in the Exposure are replaced, not added to, extra care should be taken with the background,
         mask, and variance planes.  The Exposure as given is background-subtracted (using the supplied
         background model) and should be returned in the same state.
         """
         raise NotImplementedError("FakeSourcesTask is abstract, create a child class to use this method")

Member Data Documentation

◆ bitmask

lsst.pipe.tasks.fakes.BaseFakeSourcesTask.bitmask

Definition at line 61 of file fakes.py.

◆ ConfigClass

lsst.pipe.tasks.fakes.BaseFakeSourcesTask.ConfigClass = BaseFakeSourcesConfig

static

Definition at line 46 of file fakes.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/fakes.py

Public Member Functions

Public Attributes

Static Public Attributes