columnflow.categorization

columnflow.categorization#

Event categorization tools.

Classes:

Categorizer(*args, **kwargs)

Base class for all categorizers.

Functions:

categorizer([func, bases])

Decorator for creating a new Categorizer subclass with additional, optional bases and attaching the decorated function to it as call_func.
class Categorizer(*args, **kwargs)[source]#

Bases: TaskArrayFunction

Base class for all categorizers.

Attributes:

exposed

cache_instances

Methods:

categorizer([func, bases])

Decorator for creating a new Categorizer subclass with additional, optional bases and attaching the decorated function to it as call_func.
exposed = True#
classmethod categorizer(func=None, bases=(), **kwargs)[source]#

Decorator for creating a new Categorizer subclass with additional, optional bases and attaching the decorated function to it as call_func.

All additional kwargs are added as class members of the new subclass.

Parameters:

  • func (Callable | None, default: None) – Function to be wrapped and integrated into new Categorizer class.

  • bases (tuple, default: ()) – Additional base classes for new Categorizer.

Return type:

DerivableMeta | Callable

Returns:

The new Categorizer subclass.

cache_instances = True#
categorizer(func=None, bases=(), **kwargs)#

Decorator for creating a new Categorizer subclass with additional, optional bases and attaching the decorated function to it as call_func.

All additional kwargs are added as class members of the new subclass.

Parameters:

  • func (Callable | None, default: None) – Function to be wrapped and integrated into new Categorizer class.

  • bases (tuple, default: ()) – Additional base classes for new Categorizer.

Return type:

DerivableMeta | Callable

Returns:

The new Categorizer subclass.

Contents