lsst.pipe.tasks.dataFrameActions._baseDataFrameActions.DataFrameAction Class Reference

Inheritance diagram for lsst.pipe.tasks.dataFrameActions._baseDataFrameActions.DataFrameAction:

Public Member Functions
None	__init_subclass__ (cls, **kwargs)
Iterable[Any]	__call__ (self, dataFrame, **kwargs)
Iterable[str]	columns (self)

Static Public Attributes
	cache
	cacheArgs

Protected Attributes
	_actionCache

Static Protected Attributes
Mapping	_actionCache [int, Any]

Detailed Description

Definition at line 11 of file _baseDataFrameActions.py.

Member Function Documentation

__call__()

Iterable[Any] lsst.pipe.tasks.dataFrameActions._baseDataFrameActions.DataFrameAction.__call__	(		self,
			dataFrame,
		**	kwargs )

This method should return the result of an action performed on a
dataframe

Reimplemented from lsst.pex.config.configurableActions._configurableAction.ConfigurableAction.

Reimplemented in lsst.pipe.tasks.dataFrameActions._actions.CoordColumn, lsst.pipe.tasks.dataFrameActions._actions.SingleColumnAction, lsst.pipe.tasks.dataFrameActions._actions.NanoJansky, lsst.pipe.tasks.dataFrameActions._actions.AddColumn, lsst.pipe.tasks.dataFrameActions._actions.NanoJanskyErr, lsst.pipe.tasks.dataFrameActions._actions.MagColumnDN, and lsst.pipe.tasks.dataFrameActions._actions.MagColumnNanoJansky.

Definition at line 47 of file _baseDataFrameActions.py.

    def __call__(self, dataFrame, **kwargs) -> Iterable[Any]:
        """This method should return the result of an action performed on a
        dataframe
        """
        raise NotImplementedError("This method should be overloaded in a subclass")
 

__init_subclass__()

None lsst.pipe.tasks.dataFrameActions._baseDataFrameActions.DataFrameAction.__init_subclass__	(		cls,
		**	kwargs )

Run initialization for every subclass.

Specifically registers the subclass with a YAML representer
and YAML constructor (if pyyaml is available)

Reimplemented from lsst.pex.config.config.Config.

Definition at line 21 of file _baseDataFrameActions.py.

    def __init_subclass__(cls, **kwargs) -> None:
        cls._actionCache = {}
 
        def call_wrapper(function):
            def inner_wrapper(self, dataFrame, **kwargs):
                dfId = id(dataFrame)
                extra = []
                for name in (self.cacheArgs or tuple()):
                    if name not in kwargs:
                        raise ValueError(f"{name} is not part of call signature and cant be used for "
                                         "caching")
                    extra.append(kwargs[name])
                extra.append(dfId)
                key = tuple(extra)
                if self.cache and self._frozen:
                    # look up to see if the value is in cache already
                    if result := self._actionCache.get(key):
                        return result
                result = function(self, dataFrame, **kwargs)
                if self.cache and self._frozen:
                    self._actionCache[key] = result
                return result
            return inner_wrapper
        cls.__call__ = call_wrapper(cls.__call__)
        super().__init_subclass__(**kwargs)
 

columns()

Iterable[str] lsst.pipe.tasks.dataFrameActions._baseDataFrameActions.DataFrameAction.columns

(

self

)

This property should return an iterable of columns needed by this action

Reimplemented in lsst.pipe.tasks.dataFrameActions._actions.SingleColumnAction, lsst.pipe.tasks.dataFrameActions._actions.MultiColumnAction, lsst.pipe.tasks.dataFrameActions._actions.NanoJanskyErr, and lsst.pipe.tasks.dataFrameActions._actions.AddColumn.

Definition at line 54 of file _baseDataFrameActions.py.

    def columns(self) -> Iterable[str]:
        """This property should return an iterable of columns needed by this action
        """
        raise NotImplementedError("This method should be overloaded in a subclass")

Member Data Documentation

_actionCache [1/2]

Mapping lsst.pipe.tasks.dataFrameActions._baseDataFrameActions.DataFrameAction._actionCache [int, Any]

staticprotected

Definition at line 12 of file _baseDataFrameActions.py.

_actionCache [2/2]

lsst.pipe.tasks.dataFrameActions._baseDataFrameActions.DataFrameAction._actionCache

protected

Definition at line 22 of file _baseDataFrameActions.py.

cache

lsst.pipe.tasks.dataFrameActions._baseDataFrameActions.DataFrameAction.cache

static

Initial value:

=  Field(doc="Controls if the results of this action should be cached,"
                      " only works on frozen actions",
                  dtype=bool, default=False)

Definition at line 14 of file _baseDataFrameActions.py.

cacheArgs

lsst.pipe.tasks.dataFrameActions._baseDataFrameActions.DataFrameAction.cacheArgs

static

Initial value:

=  ListField(doc="If cache is True, this is a list of argument keys that will be used to "
                              "compute the cache key in addition to the DataFrameId",
                          dtype=str, optional=True)

Definition at line 17 of file _baseDataFrameActions.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/g3e7165581c+1687b54203/python/lsst/pipe/tasks/dataFrameActions/_baseDataFrameActions.py