lsst.pipe.tasks  21.0.0-155-g0c33f26d+0510337a8f
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.dataFrameActions._actions.AddColumn Class Reference
Inheritance diagram for lsst.pipe.tasks.dataFrameActions._actions.AddColumn:
lsst.pipe.tasks.dataFrameActions._baseDataFrameActions.DataFrameAction lsst.pipe.tasks.configurableActions._configurableAction.ConfigurableAction lsst::pex::config::config::Config lsst::pex::config::config::ConfigMeta

Public Member Functions

Iterable[str] columns (self)
 
pd.DataFrame __call__ (self, df, **kwargs)
 
Any __call__ (self, *args, **kwargs)
 
None __init_subclass__ (cls, **kwargs)
 
def __init_subclass__ (cls, **kwargs)
 
def __iter__ (self)
 
def keys (self)
 
def values (self)
 
def items (self)
 
def iteritems (self)
 
def itervalues (self)
 
def iterkeys (self)
 
def __contains__ (self, name)
 
def __new__ (cls, *args, **kw)
 
def __reduce__ (self)
 
def setDefaults (self)
 
def update (self, **kw)
 
def load (self, filename, root="config")
 
def loadFromStream (self, stream, root="config", filename=None)
 
def save (self, filename, root="config")
 
def saveToStream (self, outfile, root="config", skipImports=False)
 
def freeze (self)
 
def toDict (self)
 
def names (self)
 
def validate (self)
 
def formatHistory (self, name, **kwargs)
 
def __setattr__ (self, attr, value, at=None, label="assignment")
 
def compare (self, other, shortcut=True, rtol=1E-8, atol=1E-8, output=None)
 

Static Public Attributes

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

Detailed Description

Definition at line 133 of file _actions.py.

Member Function Documentation

◆ __call__() [1/2]

Any lsst.pipe.tasks.configurableActions._configurableAction.ConfigurableAction.__call__ (   self,
args,
**  kwargs 
)
inherited

Definition at line 48 of file _configurableAction.py.

◆ __call__() [2/2]

pd.DataFrame lsst.pipe.tasks.dataFrameActions._actions.AddColumn.__call__ (   self,
  dataFrame,
**  kwargs 
)
This method should return the result of an action performed on a
dataframe

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

Definition at line 142 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 139 of file _actions.py.

Member Data Documentation

◆ 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 134 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 136 of file _actions.py.


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