LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
Classes | |
class | GenericPlugin |
class | WrappedForcedPlugin |
class | WrappedSingleFramePlugin |
Functions | |
wrapAlgorithmControl (Base, Control, module=None, hasMeasureN=False) | |
wrapAlgorithm (Base, AlgClass, factory, executionOrder, name=None, Control=None, ConfigClass=None, TransformClass=None, doRegister=True, shouldApCorr=False, apCorrList=(), hasLogName=False, **kwds) | |
wrapSingleFrameAlgorithm (AlgClass, executionOrder, name=None, needsMetadata=False, hasMeasureN=False, hasLogName=False, deprecated=None, **kwds) | |
wrapForcedAlgorithm (AlgClass, executionOrder, name=None, needsMetadata=False, hasMeasureN=False, needsSchemaOnly=False, hasLogName=False, deprecated=None, **kwds) | |
wrapSimpleAlgorithm (AlgClass, executionOrder, name=None, needsMetadata=False, hasMeasureN=False, hasLogName=False, deprecated=None, **kwds) | |
wrapTransform (transformClass, hasLogName=False) | |
lsst.meas.base.wrappers.wrapAlgorithm | ( | Base, | |
AlgClass, | |||
factory, | |||
executionOrder, | |||
name = None, | |||
Control = None, | |||
ConfigClass = None, | |||
TransformClass = None, | |||
doRegister = True, | |||
shouldApCorr = False, | |||
apCorrList = (), | |||
hasLogName = False, | |||
** | kwds ) |
Wrap a C++ algorithm class to create a measurement plugin. Parameters ---------- Base : `SingleFramePlugin` or `ForcedPlugin` Base class for the returned Plugin. AlgClass : API compatible with `SingleFrameAlgorithm` or `ForcedAlgorithm` C++ algorithm class to convert. May either derive directly from `SingleFrameAlgorithm` or `ForcedAlgorithm`, or be an unrelated class which has the same ``measure`` and ``measureN`` signatures. factory : callable A callable that is used to construct an instance of ``AlgClass``. It must take four arguments, either ``(config, name, schema, metadata)`` or ``(config, name, schemaMapper, metadata)``, depending on whether the algorithm is single-frame or forced. executionOrder : `float` The order this plugin should be run, relative to others (see `BasePlugin.getExecutionOrder`). name : `str`, optional String to use when registering the algorithm. Ignored if ``doRegistry=False``, set to ``generateAlgorithmName(AlgClass)`` if `None`. Control : Pybind11-wrapped version of a C++ class, optional Pybind11-wrapped C++ Control class for the algorithm; ``AlgClass.Control`` is used if `None`. Ignored if ``ConfigClass`` is not `None`. ConfigClass : subclass of `BaseMeasurementPluginConfig` Python config class that wraps the C++ algorithm's pybind11-wrapped Control class. If `None`, `wrapAlgorithmControl` is called to generate a Config class using the ``Control`` argument. TransformClass : subclass of `MeasurementTransform`, optional Transformation which may be used to post-process the results of measurement. If `None`, the default defined by `BasePlugin` is used. doRegister : `bool`, optional If `True` (the default), register the plugin with ``Base``'s registry, allowing it to be used by measurement tasks. shouldApCorr : `bool`, optional Does this algorithm measure an instFlux that can be aperture corrected? This is shorthand for ``apCorrList=[name]`` and is ignored if ``apCorrList`` is specified. apCorrList : iterable of `str`, optional Field name prefixes for instFlux fields to be aperture corrected. If an algorithm measures a single instFlux that should be aperture corrected, then it is simpler to set ``shouldApCorr=True``. However, if an algorithm produces multiple such fields, then specify ``apCorrList`` instead. For example, ``modelfit_CModel`` produces three such fields: ``apCorrList= ("modelfit_CModel_exp", "modelfit_CModel_exp", "modelfit_CModel_def")`` If ``apCorrList`` is not empty then ``shouldApCorr`` is ignored. If non-empty and ``doRegister`` is `True` then the names are added to the set retrieved by ``getApCorrNameSet``. hasLogName : `bool`, optional `True` if the C++ algorithm supports ``logName`` as a constructor argument. **kwds Additional keyword arguments passed to generateAlgorithmControl, which may include: - ``hasMeasureN``: Whether the plugin supports fitting multiple objects at once ;if so, a config option to enable/disable this will be added (`bool`). - ``executionOrder``: If not `None`, an override for the default execution order for this plugin (the default is ``2.0``, which is usually appropriate for fluxes; `bool`). Returns ------- PluginClass : subclass of ``Base`` The new plugin class.
Definition at line 124 of file wrappers.py.
lsst.meas.base.wrappers.wrapAlgorithmControl | ( | Base, | |
Control, | |||
module = None, | |||
hasMeasureN = False ) |
Wrap a C++ algorithm's control class into a Python config class. Parameters ---------- Base : `SingleFramePluginConfig` or `ForcedPluginConfig` Base class for the returned config. Control : pybind11-wrapped version of a C++ class. Control class to be wrapped. module : module, `str`, `int`, or `None`; optional Either a module object, a string specifying the name of the module, or an integer specifying how far back in the stack to look for the module to use: ``0`` is `lsst.pex.config.wrap`, ``1`` is `lsst.meas.base.wrappers`, ``2`` is the immediate caller, etc. This will be used to set ``__module__`` for the new config class, and the class will also be added to the module. The default is none in which case module will be looked up from Control. hasMeasureN : `bool`, optional Whether the plugin supports fitting multiple objects at once (if so, a config option to enable/disable this will be added). Returns ------- ConfigClass : `lsst.pex.config.Config` A new subclass of lsst.pex.config.Config. Notes ----- This function is generally only called by `wrapAlgorithm`; it is unlikely users will have to call it directly.
Definition at line 73 of file wrappers.py.
lsst.meas.base.wrappers.wrapForcedAlgorithm | ( | AlgClass, | |
executionOrder, | |||
name = None, | |||
needsMetadata = False, | |||
hasMeasureN = False, | |||
needsSchemaOnly = False, | |||
hasLogName = False, | |||
deprecated = None, | |||
** | kwds ) |
Expose a C++ ``ForcedAlgorithm`` class as a measurement plugin. Parameters ---------- AlgClass : API compatible with `ForcedAlgorithm` C++ algorithm class to convert. May either derive directly from `ForcedAlgorithm` or be an unrelated class which has the same ``measure``, ``measureN`` and ``fail`` signatures. executionOrder : `float` The order this plugin should be run, relative to others (see `BasePlugin.getExecutionOrder`). name : `str`, optional Name to use when registering the algorithm. Ignored if ``doRegistry=False``; set to ``generateAlgorithmName(AlgClass)`` if `None`. needsMetadata : `bool`, optional Sets whether the ``AlgClass``'s constructor should be passed a `~lsst.daf.base.PropertySet` metadata argument. hasMeasureN : `bool`, optional Does the algorithm support simultaneous measurement of multiple sources? If `True`, a `bool` ``doMeasureN`` field will be added to the generated config class, and its value will be passed as the last argument when calling the ``AlgClass`` constructor. hasLogName : `bool`, optional `True` if the C++ algorithm supports ``logName`` as a constructor argument. needsSchemaOnly : `bool`, optional Whether the algorithm constructor expects a Schema argument (representing the output `~lsst.afw.table.Schema`) rather than the full `~lsst.afw.table.SchemaMapper` (which provides access to both the reference schema and the output schema). deprecated : `str`, optional If specified, emit as a deprecation warning when the plugin is constructed. **kwds Additional keyword arguments are passed to the lower-level `wrapAlgorithm` and `wrapAlgorithmControl` classes. Returns ------- forcedPlugin : subclass of `ForcedPlugin` The new measurement plugin class. Notes ----- The first two arguments to the C++ constructor are expected to be ``Control const & ctrl, std::string const & name`` If ``needsSchemaOnly`` is `True`, then the third argument will be ``Schema & schema``; otherwise, it will be ``SchemaMapper & schemaMapper``. If ``needsMetadata`` is `True`, we also append ``PropertySet & metadata``. If ``hasMeasureN`` is `True`, we also append ``bool doMeasureN``. If ``hasLogName`` is `True`, we also append ``std::string logName``. If more than one of the above is `True`, the metadata ``PropertySet`` precedes the ``doMeasureN`` ``bool`` and the ``logName`` comes last of the three.
Definition at line 302 of file wrappers.py.
lsst.meas.base.wrappers.wrapSimpleAlgorithm | ( | AlgClass, | |
executionOrder, | |||
name = None, | |||
needsMetadata = False, | |||
hasMeasureN = False, | |||
hasLogName = False, | |||
deprecated = None, | |||
** | kwds ) |
Expose a C++ ``SimpleAlgorithm`` class as a measurement plugin. ``SimpleAlgorithm``\ s are made available as both `SingleFramePlugin`\ s and `ForcedPlugin`\ s. Parameters ---------- AlgClass : Subclass of C++ ``SimpleAlgorithm``, or API compatible Algorithm class to convert. The C++ class should be wrapped with Pybind11, and must provide ``measure()``, ``measureN()`` and ``fail()` signatures equivalent to ``SimpleAlgorithm``. executionOrder : `float` The order this plugin should be run, relative to others (see `~BasePlugin.getExecutionOrder`). name : `str`, optional Name to use when registering the algorithm. Ignored if ``doRegistry=False``; set to ``generateAlgorithmName(AlgClass)`` if `None`. needsMetadata : `bool`, optional Sets whether the ``AlgClass``'s constructor should be passed a `~lsst.daf.base.PropertySet` metadata argument. hasMeasureN : `bool`, optional Does the algorithm support simultaneous measurement of multiple sources? If `True`, a `bool` ``doMeasureN`` field will be added to the generated config class, and its value will be passed as the last argument when calling the ``AlgClass`` constructor. hasLogName : `bool`, optional `True` if the C++ algorithm supports ``logName`` as a constructor argument. deprecated : `str`, optional If specified, emit as a deprecation warning when the plugin is constructed. **kwds Additional keyword arguments are passed to the lower-level `wrapAlgorithm` and `wrapAlgorithmControl` classes. Returns ------- singleFramePlugin : subclass of `SingleFramePlugin` The new single frame measurement plugin class. forcedPlugin : subclass of `ForcedPlugin` The new forced measurement plugin class. Notes ----- The first three arguments to the C++ constructor are expected to be ``Control const & ctrl, std::string const & name, Schema & schema``. If ``needsMetadata`` is `True`, we also append ``PropertySet & metadata``. If ``hasMeasureN`` is `True`, we also append ``bool doMeasureN``. If ``hasLogName`` is `True`, we also append ``std::string logName``. If more than one of the above is `True`, the metadata ``PropertySet`` precedes the ``doMeasureN`` ``bool`` and the ``logName`` comes last of the three.
Definition at line 404 of file wrappers.py.
lsst.meas.base.wrappers.wrapSingleFrameAlgorithm | ( | AlgClass, | |
executionOrder, | |||
name = None, | |||
needsMetadata = False, | |||
hasMeasureN = False, | |||
hasLogName = False, | |||
deprecated = None, | |||
** | kwds ) |
Expose a C++ ``SingleFrameAlgorithm`` class as a measurement plugin. Parameters ---------- AlgClass : API compatible with `SingleFrameAlgorithm` C++ algorithm class to convert. May either derive directly from `SingleFrameAlgorithm` or be an unrelated class which has the same ``measure``, ``measureN`` and ``fail`` signatures. executionOrder : `float` The order this plugin should be run, relative to others (see `BasePlugin.getExecutionOrder`). name : `str`, optional Name to use when registering the algorithm. Ignored if ``doRegistry=False``; set to ``generateAlgorithmName(AlgClass)`` if `None`. needsMetadata : `bool`, optional Sets whether the ``AlgClass``'s constructor should be passed a `~lsst.daf.base.PropertySet` metadata argument. hasMeasureN : `bool`, optional Does the algorithm support simultaneous measurement of multiple sources? If `True`, a `bool` ``doMeasureN`` field will be added to the generated config class, and its value will be passed as the last argument when calling the ``AlgClass`` constructor. hasLogName : `bool`, optional `True` if the C++ algorithm supports ``logName`` as a constructor argument. deprecated : `str`, optional If specified, emit as a deprecation warning when the plugin is constructed. **kwds Additional keyword arguments are passed to the lower-level `wrapAlgorithm` and `wrapAlgorithmControl` classes. Returns ------- singleFramePlugin : subclass of `SingleFramePlugin` The new measurement plugin class. Notes ----- The first three arguments to the C++ constructor are expected to be ``Control const & ctrl, std::string const & name, Schema & schema``. If ``needsMetadata`` is `True`, we also append ``PropertySet & metadata``. If ``hasMeasureN`` is `True`, we also append ``bool doMeasureN``. If ``hasLogName`` is `True`, we also append ``std::string logName``. If more than one of the above is `True`, the metadata ``PropertySet`` precedes the ``doMeasureN`` ``bool`` and the ``logName`` comes last of the three.
Definition at line 220 of file wrappers.py.
lsst.meas.base.wrappers.wrapTransform | ( | transformClass, | |
hasLogName = False ) |
Modify a C++ transform to accept either a ``Config`` or a ``Control``. That is, the configuration may either be provided as a (C++) ``Control`` object or an instance of a Python class derived from `~lsst.meas.base.BasePluginConfig`. Parameters ---------- transformClass : Subclass of C++ ``BaseTransform`` A C++ transform class, wrapped with pybind11. Its constructor must take a ``Control`` object, a ``std::string``, and a `~lsst.afw.table.SchemaMapper`, in that order. hasLogName : `bool`, optional Unused.
Definition at line 473 of file wrappers.py.