lsst.pipe.tasks.dataFrameActions._actions.AddColumn Class Reference

Inheritance diagram for lsst.pipe.tasks.dataFrameActions._actions.AddColumn:

Public Member Functions
Iterable[str]	columns (self)
pd.DataFrame	__call__ (self, df, **kwargs)
None	__init_subclass__ (cls, **kwargs)

Static Public Attributes
	aggregator
	newColumn = Field(doc="Name of the new column to add", dtype=str)
	cache
	cacheArgs

Protected Attributes
	_frozen

Static Protected Attributes
Mapping	_actionCache [int, Any]

Detailed Description

Definition at line 164 of file _actions.py.

Member Function Documentation

__call__()

pd.DataFrame lsst.pipe.tasks.dataFrameActions._actions.AddColumn.__call__	(		self,
			df,
		**	kwargs )

Definition at line 173 of file _actions.py.

__init_subclass__()

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

inherited

Definition at line 21 of file _baseDataFrameActions.py.

columns()

Iterable[str] lsst.pipe.tasks.dataFrameActions._actions.AddColumn.columns

(

self

)

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

Reimplemented from lsst.pipe.tasks.dataFrameActions._baseDataFrameActions.DataFrameAction.

Definition at line 170 of file _actions.py.

Member Data Documentation

_actionCache

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

staticprotectedinherited

Definition at line 12 of file _baseDataFrameActions.py.

_frozen

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

protectedinherited

Definition at line 35 of file _baseDataFrameActions.py.

aggregator

lsst.pipe.tasks.dataFrameActions._actions.AddColumn.aggregator

static

Initial value:

=  ConfigurableActionField(doc="This is an instance of a Dataframe action that will be used "
                                             "to create a new column", dtype=DataFrameAction)

Definition at line 165 of file _actions.py.

cache

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

staticinherited

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

staticinherited

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.

newColumn

lsst.pipe.tasks.dataFrameActions._actions.AddColumn.newColumn = Field(doc="Name of the new column to add", dtype=str)

static

Definition at line 167 of file _actions.py.

---

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

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