pliers.transformers.Transformer

class pliers.transformers.Transformer(name=None, **kwargs)[source]

Bases: object

Base class for all pliers Transformers.

Parameters:name (str) – Optional name of Transformer instance. If None (default), the class name is used.
__init__(name=None, **kwargs)[source]
transform(stims, validation='strict', *args, **kwargs)[source]

Executes the transformation on the passed stim(s).

Parameters:
  • stims (str, Stim, list) –

    One or more stimuli to process. Must be one of:

    • A string giving the path to a file that can be read in as a Stim (e.g., a .txt file, .jpg image, etc.)
    • A Stim instance of any type.
    • An iterable of stims, where each element is either a string or a Stim.
  • validation (str) –

    String specifying how validation errors should be handled. Must be one of:

    • ’strict’: Raise an exception on any validation error
    • ’warn’: Issue a warning for all validation errors
    • ’loose’: Silently ignore all validation errors
  • args – Optional positional arguments to pass onto the internal _transform call.
  • kwargs – Optional positional arguments to pass onto the internal _transform call.