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
	_frozen

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

Definition at line 47 of file _baseDataFrameActions.py.

__init_subclass__()

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

Definition at line 21 of file _baseDataFrameActions.py.

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.AddColumn, lsst.pipe.tasks.dataFrameActions._actions.MultiColumnAction, lsst.pipe.tasks.dataFrameActions._actions.NanoJanskyErr, and lsst.pipe.tasks.dataFrameActions._actions.SingleColumnAction.

Definition at line 54 of file _baseDataFrameActions.py.

Member Data Documentation

_actionCache

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

staticprotected

Definition at line 12 of file _baseDataFrameActions.py.

_frozen

lsst.pipe.tasks.dataFrameActions._baseDataFrameActions.DataFrameAction._frozen

protected

Definition at line 35 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:

• python/lsst/pipe/tasks/dataFrameActions/_baseDataFrameActions.py