lsst.pipe.tasks g67fd32f368+06ff137360
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.configurableActions._configurableAction.ConfigurableAction Class Reference
Inheritance diagram for lsst.pipe.tasks.configurableActions._configurableAction.ConfigurableAction:
lsst::pex::config::config::Config lsst::pex::config::config::ConfigMeta lsst.pipe.tasks.configurableActions.tests.ActionTest1 lsst.pipe.tasks.configurableActions.tests.ActionTest2 lsst.pipe.tasks.configurableActions.tests.ActionTest3 lsst.pipe.tasks.dataFrameActions._baseDataFrameActions.DataFrameAction lsst.pipe.tasks.dataFrameActions._actions.AddColumn lsst.pipe.tasks.dataFrameActions._actions.MultiColumnAction lsst.pipe.tasks.dataFrameActions._actions.SingleColumnAction lsst.pipe.tasks.dataFrameActions._actions.CoordColumn lsst.pipe.tasks.dataFrameActions._actions.MagColumnDN lsst.pipe.tasks.dataFrameActions._actions.MagColumnNanoJansky lsst.pipe.tasks.dataFrameActions._actions.NanoJansky lsst.pipe.tasks.dataFrameActions._actions.NanoJanskyErr

Public Member Functions

def __setattr__ (self, attr, value, at=None, label="assignment")
 
Any __call__ (self, *Any args, **Any kwargs)
 
def __iter__ (self)
 
def keys (self)
 
def values (self)
 
def items (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 loadFromString (self, code, root="config", filename=None)
 
def save (self, filename, root="config")
 
def saveToString (self, skipImports=False)
 
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)
 
def __init_subclass__ (cls, **kwargs)
 

Static Public Attributes

 None
 

Detailed Description

A `ConfigurableAction` is an interface that extends a
`lsst.pex.config.Config` class to include a `__call__` method.

This interface is designed to create an action that can be used at
runtime with state that is determined during the configuration stage. A
single action thus may be assigned multiple times, each with different
configurations.

This allows state to be set and recorded at configuration time,
making future reproduction of results easy.

This class is intended to be an interface only, but because of various
inheritance conflicts this class can not be implemented as an Abstract
Base Class. Instead, the `__call__` method is purely virtual, meaning that
it will raise a `NotImplementedError` when called. Subclasses that
represent concrete actions must provide an override.

Definition at line 33 of file _configurableAction.py.

Member Function Documentation

◆ __call__()

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

◆ __setattr__()

def lsst.pipe.tasks.configurableActions._configurableAction.ConfigurableAction.__setattr__ (   self,
  attr,
  value,
  at = None,
  label = "assignment" 
)

Definition at line 58 of file _configurableAction.py.

Member Data Documentation

◆ None

lsst.pipe.tasks.configurableActions._configurableAction.ConfigurableAction.None
static

Definition at line 52 of file _configurableAction.py.


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