From 559d44bfde91ff6c31fccf7a97afb48144a4ff20 Mon Sep 17 00:00:00 2001 From: Ichunjo Date: Wed, 15 Jan 2025 04:06:17 +0100 Subject: [PATCH] norm_expr: add docstring --- vsexprtools/funcs.py | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/vsexprtools/funcs.py b/vsexprtools/funcs.py index 8b5fb4b..d27acde 100644 --- a/vsexprtools/funcs.py +++ b/vsexprtools/funcs.py @@ -105,6 +105,25 @@ def norm_expr( split_planes: bool = False, **kwargs: Any ) -> vs.VideoNode: + """ + Evaluates an expression per pixel. + + :param clips: Input clip(s). + :param expr: Expression to be evaluated. + A single str will be processed for all planes. + A list will be concatenated to form a single expr for all planes. + A tuple of these types will allow to specify a different expr for each planes. + A TupleExprList will enable multiple passes of norm_expr based on the ExprLists. + included in it + :param planes: Planes to process, defaults to all. + :param format: Output format, defaults to the first clip format. + :param opt: Forces integer evaluation as much as possible. + :param boundary: Specifies the default boundary condition for relative pixel accesses: + - 0 means clamped + - 1 means mirrored + :param split_planes: Splits the VideoNodes into their individual planes. + :return: Evaluated clip. + """ clips = flatten_vnodes(clips, split_planes=split_planes) if isinstance(expr, str):