Core Structures and Base Classes (core
)¶
Introduction¶
The ctapipe.core
module contains base classes the provide developers
with the core functionality to implement an application that processes
data.
Container
provides a common data class,
Component
lets one define a module (worker, maker,
etc.) for a particular algorithm along with its user-editable
configuration parameters, and Tool
defines a
command-line application, complete with configuration file or
command-line parameter processing, and logging setup. In the future
this will also handle provenance metadata.
All ctapipe applications should derive from these classes in order to provide a common interface and to make use of the configuration system.
For details about creating command-line tools, see Command line tools (tools)
The following shows the conceptual difference between Tools and Components with overall pipelines and stages. Serialization and Deserialization are simply specialized Components that perform data access.
Reference/API¶
ctapipe.core Package¶
Core functionality of ctapipe
Functions¶
|
Return all non-abstract subclasses of a base class recursively. |
|
|
|
Utility run a certain tool in a python session without exitinig |
Classes¶
|
Base class of all Components. |
|
A component that needs a |
|
Generic class that can hold and accumulate data to be passed |
|
A base class for all executable tools (applications) that handles configuration loading/saving, logging, command-line processing, and provenance meta-data handling. |
|
Class for storing data in a |
|
used to mark which fields may be removed in next version |
A dictionary of sub-containers that can be added to a Container. |
|
|
Manage the provenance info for a stack of activities |
|
|
|
Manages a set of user-configurable (at runtime or in a config file) selection criteria that operate on the same type of input. |
Signal a problem with a user-defined selection criteria function |
|
ctapipe.core.component Module¶
Class to handle configuration for algorithms
Functions¶
|
Return all non-abstract subclasses of a base class recursively. |
Classes¶
|
Base class of all Components. |
|
A component that needs a |
ctapipe.core.tool Module¶
Classes to handle configurable command-line user interfaces.
Classes¶
|
A base class for all executable tools (applications) that handles configuration loading/saving, logging, command-line processing, and provenance meta-data handling. |
|