LSST Applications
21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
LSST Data Management Base Package
|
Public Member Functions | |
def | __init__ (self, butler=None, refObjLoader=None, **kwargs) |
def | setRefObjLoader (self, refObjLoader) |
def | run (self, catalog, filterName=None, epoch=None) |
def | calculateCircle (self, catalog) |
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 | |
refObjLoader | |
metadata | |
log | |
config | |
Static Public Attributes | |
ConfigClass = DirectMatchConfig | |
Simple, brute force matching of a source catalog to a reference catalog. Parameters ---------- butler : `lsst.daf.persistence.Butler` Data butler containing the relevant reference catalog data. refObjLoader : `lsst.meas.algorithms.LoadReferenceObjectsTask` or `None` For loading reference objects. **kwargs Other keyword arguments required for instantiating a Task (such as ``config``).
Definition at line 29 of file directMatch.py.
def lsst.meas.astrom.directMatch.DirectMatchTask.__init__ | ( | self, | |
butler = None , |
|||
refObjLoader = None , |
|||
** | kwargs | ||
) |
Definition at line 45 of file directMatch.py.
|
inherited |
Pickler.
Reimplemented in lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask, and lsst.pipe.drivers.coaddDriver.CoaddDriverTask.
def lsst.meas.astrom.directMatch.DirectMatchTask.calculateCircle | ( | self, | |
catalog | |||
) |
Calculate a circle enclosing the catalog. Parameters ---------- catalog : `lsst.afw.table.SourceCatalog` Catalog to encircle. Returns ------- result : `lsst.pipe.base.Struct` Result struct with components: ``center`` ICRS center coordinate (`lsst.afw.geom.SpherePoint`). ``radius`` Radius of the circle (`lsst.geom.Angle`).
Definition at line 123 of file directMatch.py.
|
inherited |
Empty (clear) the metadata for this Task and all sub-Tasks.
Definition at line 166 of file task.py.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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 lsst.meas.astrom.directMatch.DirectMatchTask.run | ( | self, | |
catalog, | |||
filterName = None , |
|||
epoch = None |
|||
) |
Load reference objects and match to them. Parameters ---------- catalog : `lsst.afw.table.SourceCatalog` Catalog to match. filterName : `str` Name of filter loading fluxes. epoch : `astropy.time.Time` or `None` Epoch to which to correct proper motion and parallax, or `None` to not apply such corrections. Returns ------- result : `lsst.pipe.base.Struct` Result struct with components: ``matches`` Matched sources with associated reference (`lsst.afw.table.SourceMatchVector`). ``matchMeta`` Match metadata (`lsst.meas.astrom.MatchMetadata`).
Definition at line 76 of file directMatch.py.
def lsst.meas.astrom.directMatch.DirectMatchTask.setRefObjLoader | ( | self, | |
refObjLoader | |||
) |
Set the reference object loader for the task. Parameters ---------- refObjLoader An instance of a reference object loader, either a `lsst.meas.algorithms.LoadReferenceObjectsTask` task or a `lsst.meas.algorithms.ReferenceObjectLoader` instance. A task can be used as a subtask and is generally used in gen2 middleware. The class is designed to be used with gen3 middleware and is initialized outside the normal task framework.
Definition at line 61 of file directMatch.py.
|
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.
|
static |
Definition at line 42 of file directMatch.py.
lsst.meas.astrom.directMatch.DirectMatchTask.refObjLoader |
Definition at line 54 of file directMatch.py.