lsst.meas.base.forcedPhotImage.ProcessImageForcedTask Class Reference

A base class for command-line forced measurement drivers. More...

Inheritance diagram for lsst.meas.base.forcedPhotImage.ProcessImageForcedTask:

Public Member Functions
def	__init__
def	run
	Measure a single exposure using forced detection for a reference catalog. More...
def	makeIdFactory
	Hook for derived classes to define how to make an IdFactory for forced sources. More...
def	fetchReferences
	Hook for derived classes to define how to get references objects. More...
def	attachFootprints
	Hook for derived classes to define how to attach Footprints to blank sources prior to measurement. More...
def	getExposure
	Read input exposure on which to perform the measurements. More...
def	writeOutput
	Write forced source table. More...
def	getSchemaCatalogs
	Get a dict of Schema catalogs that will be used by this Task. More...

Static Public Attributes
	ConfigClass = ProcessImageForcedConfig

Private Member Functions
def	_getConfigName
	Return the name of the config dataset. More...
def	_getMetadataName
	Return the name of the metadata dataset. More...

Static Private Attributes
string	_DefaultName = "processImageForcedTask"

Detailed Description

A base class for command-line forced measurement drivers.

This is a an abstract class, which is the common ancestor for ForcedPhotCcdTask and ForcedPhotCoaddTask. It provides the run() method that does most of the work, while delegating a few customization tasks to other methods that are overridden by subclasses.

This task is not directly usable as a CmdLineTask; subclasses must:

• Set the _DefaultName class attribute
• Implement makeIdFactory
• Implement fetchReferences
• (optional) Implement attachFootprints

Definition at line 71 of file forcedPhotImage.py.

Constructor & Destructor Documentation

def lsst.meas.base.forcedPhotImage.ProcessImageForcedTask.__init__	(		self,
			butler = None,
			refSchema = None,
			kwds
	)

Initialize the task.

ForcedPhotImageTask takes two keyword arguments beyond the usual CmdLineTask arguments:
 - refSchema: the Schema of the reference catalog, passed to the constructor of the references
   subtask
 - butler: a butler that will be passed to the references subtask to allow it to load its Schema
   from disk
At least one of these arguments must be present; if both are, schema takes precedence.

Definition at line 88 of file forcedPhotImage.py.

    def __init__(self, butler=None, refSchema=None, **kwds):
        """Initialize the task.

        ForcedPhotImageTask takes two keyword arguments beyond the usual CmdLineTask arguments:
         - refSchema: the Schema of the reference catalog, passed to the constructor of the references
           subtask
         - butler: a butler that will be passed to the references subtask to allow it to load its Schema
           from disk
        At least one of these arguments must be present; if both are, schema takes precedence.
        """
        super(lsst.pipe.base.CmdLineTask, self).__init__(**kwds)
        self.makeSubtask("references", butler=butler, schema=refSchema)
        if refSchema is None:
            refSchema = self.references.schema
        self.makeSubtask("measurement", refSchema=refSchema)