docs ¶
Classes:
-
ExampleBicubicKernel
–Example Kernel class for documentation purposes.
ExampleBicubicKernel ¶
Bases: Kernel
Example Kernel class for documentation purposes.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
descale
–Perform a regular descaling operation.
-
ensure_obj
–Ensure that the given kernel input is returned as a kernel instance.
-
from_param
–Resolve and return a kernel class from a string name, class type, or instance.
-
get_descale_args
–Generate and normalize argument dictionary for a descale operation.
-
get_params_args
–Generate a base set of parameters to pass for scaling, descaling, or resampling.
-
get_resample_args
–Generate and normalize argument dictionary for a resample operation.
-
get_rescale_args
–Generate and normalize argument dictionary for a rescale operation.
-
get_scale_args
–Generate and normalize argument dictionary for a scale operation.
-
kernel_radius
–Return the effective kernel radius for the scaler.
-
multi
–Deprecated alias for
supersample
. -
pretty_string
–Cached property returning a user-friendly string representation.
-
resample
–Perform a regular resampling operation.
-
rescale
–Rescale a clip to the given resolution from a previously descaled clip.
-
scale
–Perform a regular scaling operation.
-
shift
–Apply a subpixel shift to the clip using the kernel's scaling logic.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
b
– -
c
– -
descale_function
(Callable[..., ConstantFormatVideoNode]
) –Descale function called internally when performing descaling operations.
-
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
resample_function
(Callable[..., ConstantFormatVideoNode]
) –Resample function called internally when performing resampling operations.
-
rescale_function
(Callable[..., ConstantFormatVideoNode]
) –Rescale function called internally when performing upscaling operations.
-
scale_function
(Callable[..., VideoNode]
) –Scale function called internally when performing scaling operations.
Source code
18 19 20 21 |
|
descale_function instance-attribute
¶
descale_function: Callable[..., ConstantFormatVideoNode]
Descale function called internally when performing descaling operations.
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
resample_function instance-attribute
¶
resample_function: Callable[..., ConstantFormatVideoNode]
Resample function called internally when performing resampling operations.
rescale_function instance-attribute
¶
rescale_function: Callable[..., ConstantFormatVideoNode]
Rescale function called internally when performing upscaling operations.
scale_function instance-attribute
¶
scale_function: Callable[..., VideoNode]
Scale function called internally when performing scaling operations.
cached_property ¶
cached_property(func: Callable[Concatenate[_BaseScalerT, P], T_co])
Bases: cached_property[T_co]
Read only version of functools.cached_property.
Source code
265 |
|
descale ¶
descale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Perform a regular descaling operation.
Parameters:
-
clip
¶VideoNode
) –Input clip.
-
width
¶int | None
, default:None
) –Output width.
-
height
¶int | None
, default:None
) –Output height.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Shift clip during the operation. Expects a tuple of (src_top, src_left).
Returns:
-
ConstantFormatVideoNode
–The descaled clip.
Source code
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
|
ensure_obj classmethod
¶
ensure_obj(
kernel: KernelLike | None = None, /, func_except: FuncExceptT | None = None
) -> Self
Ensure that the given kernel input is returned as a kernel instance.
Parameters:
-
kernel
¶KernelLike | None
, default:None
) –Kernel name, class, or instance. Defaults to current class if None.
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
Self
–The resolved and instantiated kernel.
Source code
804 805 806 807 808 809 810 811 812 813 814 |
|
from_param classmethod
¶
from_param(
kernel: KernelLike | None = None, /, func_except: FuncExceptT | None = None
) -> type[Self]
Resolve and return a kernel class from a string name, class type, or instance.
Parameters:
-
kernel
¶KernelLike | None
, default:None
) –Kernel identifier as a string, class type, or instance. If None, defaults to the current class.
-
func_except
¶FuncExceptT | None
, default:None
) –Function returned for custom error handling.
Returns:
-
type[Self]
–The resolved kernel class.
Raises:
-
UnknownKernelError
–If the kernel could not be identified.
Source code
791 792 793 794 795 796 797 798 799 800 801 802 |
|
get_descale_args ¶
get_descale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate and normalize argument dictionary for a descale operation.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Vertical and horizontal shift to apply.
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
kwargs
¶Any
, default:{}
) –Additional arguments to pass to the descale function.
Returns:
Source code
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 |
|
get_params_args ¶
get_params_args(
is_descale: bool,
clip: VideoNode,
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate a base set of parameters to pass for scaling, descaling, or resampling.
Parameters:
-
is_descale
¶bool
) –Whether this is for a descale operation.
-
clip
¶VideoNode
) –The source clip.
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
kwargs
¶Any
, default:{}
) –Additional keyword arguments to include.
Returns:
Source code
816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 |
|
get_resample_args ¶
get_resample_args(
clip: VideoNode,
format: int | VideoFormatT | HoldsVideoFormatT,
matrix: MatrixT | None,
matrix_in: MatrixT | None,
**kwargs: Any
) -> dict[str, Any]
Generate and normalize argument dictionary for a resample operation.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
format
¶int | VideoFormatT | HoldsVideoFormatT
) –The target video format, which can either be: - an integer format ID, - a
vs.PresetVideoFormat
orvs.VideoFormat
, - or a source from which a validVideoFormat
can be extracted. -
matrix
¶MatrixT | None
) –Target color matrix.
-
matrix_in
¶MatrixT | None
) –Source color matrix.
-
kwargs
¶Any
, default:{}
) –Additional arguments to pass to the resample function.
Returns:
Source code
895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 |
|
get_rescale_args ¶
get_rescale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate and normalize argument dictionary for a rescale operation.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Vertical and horizontal shift to apply.
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
kwargs
¶Any
, default:{}
) –Additional arguments to pass to the rescale function.
Returns:
Source code
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 |
|
get_scale_args ¶
get_scale_args(
clip: VideoNode,
shift: tuple[TopShift, LeftShift] = (0, 0),
width: int | None = None,
height: int | None = None,
**kwargs: Any
) -> dict[str, Any]
Generate and normalize argument dictionary for a scale operation.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Vertical and horizontal shift to apply.
-
width
¶int | None
, default:None
) –Target width.
-
height
¶int | None
, default:None
) –Target height.
-
kwargs
¶Any
, default:{}
) –Additional arguments to pass to the scale function.
Returns:
Source code
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 |
|
kernel_radius ¶
kernel_radius() -> int
Return the effective kernel radius for the scaler.
Returns:
-
int
–Kernel radius.
Raises:
-
CustomNotImplementedError
–If no kernel radius is defined.
Source code
347 348 349 350 351 352 353 354 355 |
|
multi ¶
multi(
clip: VideoNodeT,
multi: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Deprecated alias for supersample
.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
multi
¶float
, default:2.0
) –Supersampling factor.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Source code
451 452 453 454 455 456 457 458 459 460 461 462 463 464 |
|
pretty_string ¶
pretty_string() -> str
Cached property returning a user-friendly string representation.
Returns:
-
str
–Pretty-printed string with arguments.
Source code
368 369 370 371 372 373 374 375 |
|
resample ¶
resample(
clip: VideoNode,
format: int | VideoFormatT | HoldsVideoFormatT,
matrix: MatrixT | None = None,
matrix_in: MatrixT | None = None,
**kwargs: Any
) -> ConstantFormatVideoNode
Perform a regular resampling operation.
Parameters:
-
clip
¶VideoNode
) –Input clip
-
format
¶int | VideoFormatT | HoldsVideoFormatT
) –Output format
-
matrix
¶MatrixT | None
, default:None
) –Output matrix. If
None
, will take the matrix from the input clip's frameprops. -
matrix_in
¶MatrixT | None
, default:None
) –Input matrix. If
None
, will take the matrix from the input clip's frameprops.
Returns:
-
ConstantFormatVideoNode
–Resampled clip.
Source code
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
|
rescale ¶
rescale(
clip: VideoNode,
width: int | None,
height: int | None,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> ConstantFormatVideoNode
Rescale a clip to the given resolution from a previously descaled clip.
Keyword arguments passed during initialization are automatically injected here, unless explicitly overridden by the arguments provided at call time. Only arguments that match named parameters in this method are injected.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
width
¶int | None
) –Target scaled width (defaults to clip width if None).
-
height
¶int | None
) –Target scaled height (defaults to clip height if None).
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNode
Perform a regular scaling operation.
Parameters:
-
clip
¶VideoNode
) –Input clip.
-
width
¶int | None
, default:None
) –Output width.
-
height
¶int | None
, default:None
) –Output height.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Shift clip during the operation. Expects a tuple of (src_top, src_left).
Returns:
-
VideoNode
–The scaled clip.
Source code
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
|
shift ¶
shift(
clip: VideoNode,
shifts_or_top: float | tuple[float, float] | list[float],
shift_left: float | list[float] | None = None,
/,
**kwargs: Any,
) -> ConstantFormatVideoNode
Apply a subpixel shift to the clip using the kernel's scaling logic.
If a single float or tuple is provided, it is used uniformly. If a list is given, the shift is applied per plane.
Keyword arguments passed during initialization are automatically injected here, unless explicitly overridden by the arguments provided at call time. Only arguments that match named parameters in this method are injected.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shifts_or_top
¶float | tuple[float, float] | list[float]
) –Either a single vertical shift, a (top, left) tuple, or a list of vertical shifts.
-
shift_left
¶float | list[float] | None
, default:None
) –Horizontal shift or list of horizontal shifts. Ignored if
shifts_or_top
is a tuple. -
kwargs
¶Any
, default:{}
) –Additional arguments passed to the internal
scale
call.
Returns:
-
ConstantFormatVideoNode
–A new clip with the applied shift.
Raises:
-
VariableFormatError
–If the input clip has variable format.
-
CustomValueError
–If the input clip is GRAY but lists of shift has been passed.
Source code
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 |
|
supersample ¶
supersample(
clip: VideoNodeT,
rfactor: float = 2.0,
shift: tuple[TopShift, LeftShift] = (0, 0),
**kwargs: Any
) -> VideoNodeT
Supersample a clip by a given scaling factor.
Parameters:
-
clip
¶VideoNodeT
) –The source clip.
-
rfactor
¶float
, default:2.0
) –Scaling factor for supersampling.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling.
-
kwargs
¶Any
, default:{}
) –Additional arguments forwarded to the scale function.
Returns:
-
VideoNodeT
–The supersampled clip.
Raises:
-
CustomValueError
–If resulting resolution is non-positive.
Source code
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 |
|