brainspace.vtk_interface.decorators.unwrap_input

brainspace.vtk_interface.decorators.unwrap_input(*xargs, vtype=False, skip=False)[source]

Decorator to unwrap input arguments of function.

An object is unwrapped only if it is an instance of BSVTKObjectWrapper or one of its subclasses.

Parameters:
  • xargs (sequence of int and str) – Positional indices (integers) and keys as strings (for keyword args) to unwrap. If no specified, try to unwrap all args.
  • skip (bool, optional) – Unwrap all arguments except those in xargs. Default is False.

See also

unwrap_output, unwrap_func, wrap_input