lsst.meas.base.references.BaseReferencesTask Class Reference

Inheritance diagram for lsst.meas.base.references.BaseReferencesTask:

Public Member Functions
def	__init__ (self, butler=None, schema=None, **kwargs)
def	getSchema (self, butler)
def	getWcs (self, dataRef)
def	fetchInBox (self, dataRef, bbox, wcs)
def	fetchInPatches (self, dataRef, patchList)
def	subset (self, sources, bbox, wcs)
def	emptyMetadata (self)
def	getSchemaCatalogs (self)
def	getAllSchemaCatalogs (self)
def	getFullMetadata (self)
def	getFullName (self)
def	getName (self)
def	getTaskDict (self)
def	makeSubtask (self, name, **keyArgs)
def	timer (self, name, logLevel=Log.DEBUG)
def	makeField (cls, doc)
def	__reduce__ (self)

Public Attributes
	metadata
	log
	config

Static Public Attributes
	ConfigClass = BaseReferencesConfig

Detailed Description

Base class for forced photometry subtask that fetches reference sources.

Parameters
----------
schema : `lsst.afw.table.Schema`, optional
    The schema of the reference catalog.
butler : `lsst.daf.persistence.butler.Butler`, optional
    A butler that will allow the task to load its schema from disk.

Notes
-----
At least one of the ``schema`` and ``butler`` arguments must be present;
if both are, ``schema`` takes precedence.

``BaseReferencesTask`` defines the required API for the references task,
which consists of:

- ``getSchema(butler)``
- ``fetchInPatches(butler, tract, filter, patchList)``
- ``fetchInBox(self, butler, tract, filter, bbox, wcs)``
- the ``removePatchOverlaps`` config option

It also provides the ``subset`` method, which may be of use to derived
classes when reimplementing ``fetchInBox``.

Definition at line 49 of file references.py.

Constructor & Destructor Documentation

__init__()

def lsst.meas.base.references.BaseReferencesTask.__init__	(		self,
			butler = None,
			schema = None,
		**	kwargs
	)

Reimplemented in lsst.meas.base.references.CoaddSrcReferencesTask.

Definition at line 80 of file references.py.

    def __init__(self, butler=None, schema=None, **kwargs):
        lsst.pipe.base.Task.__init__(self, **kwargs)
 

Member Function Documentation

__reduce__()

def lsst.pipe.base.task.Task.__reduce__ (   self )

inherited

Pickler.

Reimplemented in lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask, and lsst.pipe.drivers.coaddDriver.CoaddDriverTask.

Definition at line 432 of file task.py.

    def __reduce__(self):
        """Pickler.
        """
        return self._unpickle_via_factory, (self.__class__, [], self._reduce_kwargs())

emptyMetadata()

def lsst.pipe.base.task.Task.emptyMetadata (   self )

inherited

Empty (clear) the metadata for this Task and all sub-Tasks.

Definition at line 166 of file task.py.

    def emptyMetadata(self):
        """Empty (clear) the metadata for this Task and all sub-Tasks.
        """
        for subtask in self._taskDict.values():
            subtask.metadata = dafBase.PropertyList()
 

fetchInBox()

def lsst.meas.base.references.BaseReferencesTask.fetchInBox	(		self,
			dataRef,
			bbox,
			wcs
	)

Return reference sources within a given bounding box.

Reference sources are selected if they overlap a region defined by a
pixel-coordinate bounding box and corresponding WCS.

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    Butler data reference. The implied data ID must contain the
    ``tract`` key.
bbox : `lsst.afw.geom.Box2I` or `lsst.afw.geom.Box2D`
    Defines the selection region in pixel coordinates.
wcs : `lsst.afw.image.SkyWcs`
    Maps ``bbox`` to sky coordinates.

Returns
-------
sources : iterable of `~lsst.afw.table.SourceRecord`
    Reference sources. May be any Python iterable, including a lazy
    iterator.

Notes
-----
The returned set of sources should be complete and close to minimal.

Definition at line 108 of file references.py.

    def fetchInBox(self, dataRef, bbox, wcs):
        """Return reference sources within a given bounding box.
 
        Reference sources are selected if they overlap a region defined by a
        pixel-coordinate bounding box and corresponding WCS.
 
        Parameters
        ----------
        dataRef : `lsst.daf.persistence.ButlerDataRef`
            Butler data reference. The implied data ID must contain the
            ``tract`` key.
        bbox : `lsst.afw.geom.Box2I` or `lsst.afw.geom.Box2D`
            Defines the selection region in pixel coordinates.
        wcs : `lsst.afw.image.SkyWcs`
            Maps ``bbox`` to sky coordinates.
 
        Returns
        -------
        sources : iterable of `~lsst.afw.table.SourceRecord`
            Reference sources. May be any Python iterable, including a lazy
            iterator.
 
        Notes
        -----
        The returned set of sources should be complete and close to minimal.
        """
        raise NotImplementedError("BaseReferencesTask is pure abstract, and cannot be used directly.")
 

fetchInPatches()

def lsst.meas.base.references.BaseReferencesTask.fetchInPatches	(		self,
			dataRef,
			patchList
	)

Return reference sources within one or more patches.

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    Butler data reference. The implied data ID must contain the
    ``tract`` key.
patchList : `list` of `lsst.skymap.PatchInfo`
    Patches for which to fetch reference sources.

Returns
-------
sources : iterable of `~lsst.afw.table.SourceRecord`
    Reference sources. May be any Python iterable, including a lazy
    iterator.

Notes
-----
The returned set of sources should be complete and close to minimal.

If ``config.removePatchOverlaps`` is `True`, only sources within each
patch's "inner" bounding box should be returned.

Reimplemented in lsst.meas.base.references.CoaddSrcReferencesTask.

Definition at line 136 of file references.py.

    def fetchInPatches(self, dataRef, patchList):
        """Return reference sources within one or more patches.
 
        Parameters
        ----------
        dataRef : `lsst.daf.persistence.ButlerDataRef`
            Butler data reference. The implied data ID must contain the
            ``tract`` key.
        patchList : `list` of `lsst.skymap.PatchInfo`
            Patches for which to fetch reference sources.
 
        Returns
        -------
        sources : iterable of `~lsst.afw.table.SourceRecord`
            Reference sources. May be any Python iterable, including a lazy
            iterator.
 
        Notes
        -----
        The returned set of sources should be complete and close to minimal.
 
        If ``config.removePatchOverlaps`` is `True`, only sources within each
        patch's "inner" bounding box should be returned.
        """
        raise NotImplementedError("BaseReferencesTask is pure abstract, and cannot be used directly.")
 

getAllSchemaCatalogs()

def lsst.pipe.base.task.Task.getAllSchemaCatalogs (   self )

inherited

Get schema catalogs for all tasks in the hierarchy, combining the
results into a single dict.

Returns
-------
schemacatalogs : `dict`
    Keys are butler dataset type, values are a empty catalog (an
    instance of the appropriate `lsst.afw.table` Catalog type) for all
    tasks in the hierarchy, from the top-level task down
    through all subtasks.

Notes
-----
This method may be called on any task in the hierarchy; it will return
the same answer, regardless.

The default implementation should always suffice. If your subtask uses
schemas the override `Task.getSchemaCatalogs`, not this method.

Definition at line 204 of file task.py.

    def getAllSchemaCatalogs(self):
        """Get schema catalogs for all tasks in the hierarchy, combining the
        results into a single dict.
 
        Returns
        -------
        schemacatalogs : `dict`
            Keys are butler dataset type, values are a empty catalog (an
            instance of the appropriate `lsst.afw.table` Catalog type) for all
            tasks in the hierarchy, from the top-level task down
            through all subtasks.
 
        Notes
        -----
        This method may be called on any task in the hierarchy; it will return
        the same answer, regardless.
 
        The default implementation should always suffice. If your subtask uses
        schemas the override `Task.getSchemaCatalogs`, not this method.
        """
        schemaDict = self.getSchemaCatalogs()
        for subtask in self._taskDict.values():
            schemaDict.update(subtask.getSchemaCatalogs())
        return schemaDict
 

getFullMetadata()

def lsst.pipe.base.task.Task.getFullMetadata (   self )

inherited

Get metadata for all tasks.

Returns
-------
metadata : `lsst.daf.base.PropertySet`
    The `~lsst.daf.base.PropertySet` keys are the full task name.
    Values are metadata for the top-level task and all subtasks,
    sub-subtasks, etc.

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.

Definition at line 229 of file task.py.

    def getFullMetadata(self):
        """Get metadata for all tasks.
 
        Returns
        -------
        metadata : `lsst.daf.base.PropertySet`
            The `~lsst.daf.base.PropertySet` keys are the full task name.
            Values are metadata for the top-level task and all subtasks,
            sub-subtasks, etc.
 
        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.
        """
        fullMetadata = dafBase.PropertySet()
        for fullName, task in self.getTaskDict().items():
            fullMetadata.set(fullName.replace(".", ":"), task.metadata)
        return fullMetadata
 

getFullName()

def lsst.pipe.base.task.Task.getFullName (   self )

inherited

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".

Definition at line 256 of file task.py.

    def getFullName(self):
        """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".
        """
        return self._fullName
 

getName()

def lsst.pipe.base.task.Task.getName (   self )

inherited

Get the name of the task.

Returns
-------
taskName : `str`
    Name of the task.

See also
--------
getFullName

Definition at line 274 of file task.py.

    def getName(self):
        """Get the name of the task.
 
        Returns
        -------
        taskName : `str`
            Name of the task.
 
        See also
        --------
        getFullName
        """
        return self._name
 

getSchema()

def lsst.meas.base.references.BaseReferencesTask.getSchema	(		self,
			butler
	)

Return the schema for the reference sources.

Parameters
----------
butler : `lsst.daf.persistence.butler.Butler`
    Data butler from which the schema will be fetched.

Notes
-----
Must be available even before any data has been processed.

Definition at line 83 of file references.py.

    def getSchema(self, butler):
        """Return the schema for the reference sources.
 
        Parameters
        ----------
        butler : `lsst.daf.persistence.butler.Butler`
            Data butler from which the schema will be fetched.
 
        Notes
        -----
        Must be available even before any data has been processed.
        """
        raise NotImplementedError("BaseReferencesTask is pure abstract, and cannot be used directly.")
 

getSchemaCatalogs()

def lsst.pipe.base.task.Task.getSchemaCatalogs (   self )

inherited

Get the schemas generated by this task.

Returns
-------
schemaCatalogs : `dict`
    Keys are butler dataset type, values are an empty catalog (an
    instance of the appropriate `lsst.afw.table` Catalog type) for
    this task.

Notes
-----

.. warning::

   Subclasses that use schemas must override this method. The default
   implementation returns an empty dict.

This method may be called at any time after the Task is constructed,
which means that all task schemas should be computed at construction
time, *not* when data is actually processed. This reflects the
philosophy that the schema should not depend on the data.

Returning catalogs rather than just schemas allows us to save e.g.
slots for SourceCatalog as well.

See also
--------
Task.getAllSchemaCatalogs

Definition at line 172 of file task.py.

    def getSchemaCatalogs(self):
        """Get the schemas generated by this task.
 
        Returns
        -------
        schemaCatalogs : `dict`
            Keys are butler dataset type, values are an empty catalog (an
            instance of the appropriate `lsst.afw.table` Catalog type) for
            this task.
 
        Notes
        -----
 
        .. warning::
 
           Subclasses that use schemas must override this method. The default
           implementation returns an empty dict.
 
        This method may be called at any time after the Task is constructed,
        which means that all task schemas should be computed at construction
        time, *not* when data is actually processed. This reflects the
        philosophy that the schema should not depend on the data.
 
        Returning catalogs rather than just schemas allows us to save e.g.
        slots for SourceCatalog as well.
 
        See also
        --------
        Task.getAllSchemaCatalogs
        """
        return {}
 

getTaskDict()

def lsst.pipe.base.task.Task.getTaskDict (   self )

inherited

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.

Definition at line 288 of file task.py.

    def getTaskDict(self):
        """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.
        """
        return self._taskDict.copy()
 

getWcs()

def lsst.meas.base.references.BaseReferencesTask.getWcs	(		self,
			dataRef
	)

Return the WCS for reference sources.

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    The data reference from which the WCS will be fetched. This must
    include the tract in its dataId.

Reimplemented in lsst.meas.base.references.CoaddSrcReferencesTask.

Definition at line 97 of file references.py.

    def getWcs(self, dataRef):
        """Return the WCS for reference sources.
 
        Parameters
        ----------
        dataRef : `lsst.daf.persistence.ButlerDataRef`
            The data reference from which the WCS will be fetched. This must
            include the tract in its dataId.
        """
        raise NotImplementedError("BaseReferencesTask is pure abstract, and cannot be used directly.")
 

makeField()

def lsst.pipe.base.task.Task.makeField (   cls,   doc  )

inherited

Make a `lsst.pex.config.ConfigurableField` for this task.

Parameters
----------
doc : `str`
    Help text for the field.

Returns
-------
configurableField : `lsst.pex.config.ConfigurableField`
    A `~ConfigurableField` for this task.

Examples
--------
Provides a convenient way to specify this task is a subtask of another
task.

Here is an example of use:

.. code-block:: python

    class OtherTaskConfig(lsst.pex.config.Config):
        aSubtask = ATaskClass.makeField("brief description of task")

Definition at line 359 of file task.py.

    def makeField(cls, doc):
        """Make a `lsst.pex.config.ConfigurableField` for this task.
 
        Parameters
        ----------
        doc : `str`
            Help text for the field.
 
        Returns
        -------
        configurableField : `lsst.pex.config.ConfigurableField`
            A `~ConfigurableField` for this task.
 
        Examples
        --------
        Provides a convenient way to specify this task is a subtask of another
        task.
 
        Here is an example of use:
 
        .. code-block:: python
 
            class OtherTaskConfig(lsst.pex.config.Config):
                aSubtask = ATaskClass.makeField("brief description of task")
        """
        return ConfigurableField(doc=doc, target=cls)
 

makeSubtask()

def lsst.pipe.base.task.Task.makeSubtask (   self,   name, **  keyArgs  )

inherited

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".

Notes
-----
The subtask must be defined by ``Task.config.name``, an instance of
`~lsst.pex.config.ConfigurableField` or
`~lsst.pex.config.RegistryField`.

Definition at line 299 of file task.py.

    def makeSubtask(self, name, **keyArgs):
        """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".
 
        Notes
        -----
        The subtask must be defined by ``Task.config.name``, an instance of
        `~lsst.pex.config.ConfigurableField` or
        `~lsst.pex.config.RegistryField`.
        """
        taskField = getattr(self.config, name, None)
        if taskField is None:
            raise KeyError(f"{self.getFullName()}'s config does not have field {name!r}")
        subtask = taskField.apply(name=name, parentTask=self, **keyArgs)
        setattr(self, name, subtask)
 

subset()

def lsst.meas.base.references.BaseReferencesTask.subset	(		self,
			sources,
			bbox,
			wcs
	)

Filter a list of sources to only those within the bounding box.

Parameters
----------
sources : iterable of `~lsst.afw.table.SourceRecord`
    Reference sources. May be any Python iterable, including a lazy
    iterator.
bbox : `lsst.afw.geom.Box2I` or `lsst.afw.geom.Box2D`
    Defines the selection region.
wcs : `lsst.afw.image.SkyWcs`
    Maps ``bbox`` to sky coordinates.

Returns
-------
sources : iterable of `~lsst.afw.table.SourceRecord`
    Filtered sources. May be any Python iterable, including a lazy
    iterator.

Notes
-----
Instead of filtering sources directly via their positions, we filter
based on the positions of parent objects, then include or discard all
children based on their parent's status. This is necessary to support
replacement with noise in measurement, which requires all child
sources have their parent present.

This is not a part of the required `BaseReferencesTask` interface;
it's a convenience function used in implementing `fetchInBox` that may
be of use to subclasses.

Definition at line 162 of file references.py.

    def subset(self, sources, bbox, wcs):
        """Filter a list of sources to only those within the bounding box.
 
        Parameters
        ----------
        sources : iterable of `~lsst.afw.table.SourceRecord`
            Reference sources. May be any Python iterable, including a lazy
            iterator.
        bbox : `lsst.afw.geom.Box2I` or `lsst.afw.geom.Box2D`
            Defines the selection region.
        wcs : `lsst.afw.image.SkyWcs`
            Maps ``bbox`` to sky coordinates.
 
        Returns
        -------
        sources : iterable of `~lsst.afw.table.SourceRecord`
            Filtered sources. May be any Python iterable, including a lazy
            iterator.
 
        Notes
        -----
        Instead of filtering sources directly via their positions, we filter
        based on the positions of parent objects, then include or discard all
        children based on their parent's status. This is necessary to support
        replacement with noise in measurement, which requires all child
        sources have their parent present.
 
        This is not a part of the required `BaseReferencesTask` interface;
        it's a convenience function used in implementing `fetchInBox` that may
        be of use to subclasses.
        """
        boxD = lsst.geom.Box2D(bbox)
        # We're passed an arbitrary iterable, but we need a catalog so we can
        # iterate over parents and then children.
        catalog = lsst.afw.table.SourceCatalog(self.schema)
        catalog.extend(sources)
        # catalog must be sorted by parent ID for lsst.afw.table.getChildren
        # to work
        catalog.sort(lsst.afw.table.SourceTable.getParentKey())
        # Iterate over objects that have no parent.
        parentSources = catalog.getChildren(0)
        skyCoordList = [source.getCoord() for source in parentSources]
        pixelPosList = wcs.skyToPixel(skyCoordList)
        for parent, pixel in zip(parentSources, pixelPosList):
            if boxD.contains(pixel):
                yield parent
                for child in catalog.getChildren(parent.getId()):
                    yield child
 
 

timer()

def lsst.pipe.base.task.Task.timer (   self,   name,   logLevel = Log.DEBUG  )

inherited

Context manager to log performance data for an arbitrary block of
code.

Parameters
----------
name : `str`
    Name of code being timed; data will be logged using item name:
    ``Start`` and ``End``.
logLevel
    A `lsst.log` level constant.

Examples
--------
Creating a timer context:

.. code-block:: python

    with self.timer("someCodeToTime"):
        pass  # code to time

See also
--------
timer.logInfo

Definition at line 327 of file task.py.

    def timer(self, name, logLevel=Log.DEBUG):
        """Context manager to log performance data for an arbitrary block of
        code.
 
        Parameters
        ----------
        name : `str`
            Name of code being timed; data will be logged using item name:
            ``Start`` and ``End``.
        logLevel
            A `lsst.log` level constant.
 
        Examples
        --------
        Creating a timer context:
 
        .. code-block:: python
 
            with self.timer("someCodeToTime"):
                pass  # code to time
 
        See also
        --------
        timer.logInfo
        """
        logInfo(obj=self, prefix=name + "Start", logLevel=logLevel)
        try:
            yield
        finally:
            logInfo(obj=self, prefix=name + "End", logLevel=logLevel)
 

Member Data Documentation

config

lsst.pipe.base.task.Task.config

inherited

Definition at line 162 of file task.py.

ConfigClass

lsst.meas.base.references.BaseReferencesTask.ConfigClass = BaseReferencesConfig

static

Definition at line 76 of file references.py.

log

lsst.pipe.base.task.Task.log

inherited

Definition at line 161 of file task.py.

metadata

lsst.pipe.base.task.Task.metadata

inherited

Definition at line 134 of file task.py.

---

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

• /j/snowflake/release/lsstsw/stack/0.4.3/Linux64/meas_base/21.0.0-7-g04766d7+cd19d05db2/python/lsst/meas/base/references.py