various ¶
Classes:
Bilinear ¶
Bilinear(**kwargs: Any)
Bases: ZimgComplexKernel
Bilinear resizer.
Initialize the scaler with optional keyword arguments.
These keyword arguments are automatically forwarded to the _implemented_funcs
methods but only if the method explicitly accepts them as named parameters. If the same keyword is passed to both __init__
and one of the _implemented_funcs
, the one passed to func
takes precedence.
Parameters:
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
bob
–Apply bob deinterlacing to a given clip using the selected resizer.
-
deinterlace
–Apply deinterlacing to a given clip using the selected resizer.
-
descale
–Descale a clip to the given resolution, with image borders handling and sampling grid alignment,
-
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_bob_args
–Generate the keyword arguments used for bobbing.
-
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
–Resample a video clip to the given format.
-
rescale
–Rescale a clip to the given resolution from a previously descaled clip,
-
scale
–Scale a clip to the given resolution, with aspect ratio and linear light support.
-
shift
–Apply a subpixel shift to the clip using the kernel's scaling logic.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
bob_function
(Callable[..., ConstantFormatVideoNode]
) –Bob function called internally when performing bobbing operations.
-
descale_function
(Callable[..., ConstantFormatVideoNode]
) – -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
resample_function
(Callable[..., ConstantFormatVideoNode]
) – -
rescale_function
(Callable[..., ConstantFormatVideoNode]
) – -
scale_function
(Callable[..., VideoNode]
) –
Source code
281 282 283 284 285 286 287 288 289 290 291 292 |
|
bob_function class-attribute
instance-attribute
¶
bob_function: Callable[..., ConstantFormatVideoNode] = Bob
Bob function called internally when performing bobbing operations.
descale_function class-attribute
instance-attribute
¶
descale_function: Callable[..., ConstantFormatVideoNode] = Debilinear
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
resample_function class-attribute
instance-attribute
¶
resample_function: Callable[..., ConstantFormatVideoNode] = Bilinear
rescale_function class-attribute
instance-attribute
¶
rescale_function: Callable[..., ConstantFormatVideoNode] = Bilinear
scale_function class-attribute
instance-attribute
¶
scale_function: Callable[..., VideoNode] = Bilinear
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 |
|
bob ¶
bob(
clip: VideoNode, *, tff: FieldBasedT | bool | None = None, **kwargs: Any
) -> ConstantFormatVideoNode
Apply bob deinterlacing to a given clip using the selected resizer.
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
-
tff
¶FieldBasedT | bool | None
, default:None
) –Field order of the clip.
Returns:
-
ConstantFormatVideoNode
–The bobbed clip.
Source code
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
|
deinterlace ¶
deinterlace(
clip: VideoNode,
*,
tff: FieldBasedT | bool | None = None,
double_rate: bool = True,
**kwargs: Any
) -> ConstantFormatVideoNode
Apply deinterlacing to a given clip using the selected resizer.
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
-
tff
¶FieldBasedT | bool | None
, default:None
) –Field order of the clip.
-
double_rate
¶bool
, default:True
) –Wether to double the frame rate (True) of retain the original rate (False).
Returns:
-
ConstantFormatVideoNode
–The bobbed clip.
Source code
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
|
descale ¶
descale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: ShiftT = (0, 0),
*,
linear: bool | None = None,
sigmoid: bool | tuple[Slope, Center] = False,
border_handling: int | BorderHandling = MIRROR,
sample_grid_model: int | SampleGridModel = MATCH_EDGES,
field_based: FieldBasedT | None = None,
ignore_mask: VideoNode | None = None,
blur: float | None = None,
**kwargs: Any
) -> ConstantFormatVideoNode
Descale a clip to the given resolution, with image borders handling and sampling grid alignment, optionally using linear light processing.
Supports both progressive and interlaced sources. When interlaced, it will separate fields, perform per-field descaling, and weave them back.
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
, default:None
) –Target descaled width (defaults to clip width if None).
-
height
¶int | None
, default:None
) –Target descaled height (defaults to clip height if None).
-
shift
¶ShiftT
, default:(0, 0)
) –Subpixel shift (top, left) or per-field shifts.
-
linear
¶bool | None
, default:None
) –Whether to linearize the input before descaling. If None, inferred from sigmoid.
-
sigmoid
¶bool | tuple[Slope, Center]
, default:False
) –Whether to use sigmoid transfer curve. Can be True, False, or a tuple of (slope, center).
True
applies the defaults values (6.5, 0.75). Keep in mind sigmoid slope has to be in range 1.0-20.0 (inclusive) and sigmoid center has to be in range 0.0-1.0 (inclusive). -
border_handling
¶int | BorderHandling
, default:MIRROR
) –Method for handling image borders during sampling.
-
sample_grid_model
¶int | SampleGridModel
, default:MATCH_EDGES
) –Model used to align sampling grid.
-
field_based
¶FieldBasedT | None
, default:None
) –Field-based processing mode (interlaced or progressive).
-
ignore_mask
¶VideoNode | None
, default:None
) –Optional mask specifying areas to ignore during descaling.
-
blur
¶float | None
, default:None
) –Amount of blur to apply during scaling.
-
kwargs
¶Any
, default:{}
) –Additional arguments passed to
descale_function
.
Returns:
-
ConstantFormatVideoNode
–The descaled video node, optionally processed in linear light.
Source code
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 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 |
|
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_bob_args ¶
get_bob_args(
clip: VideoNode, shift: tuple[TopShift, LeftShift] = (0, 0), **kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for bobbing.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
|
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
Resample a video clip to the given format.
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.
-
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
, default:None
) –An optional color transformation matrix to apply.
-
matrix_in
¶MatrixT | None
, default:None
) –An optional input matrix for color transformations.
-
kwargs
¶Any
, default:{}
) –Additional keyword arguments passed to the
resample_function
.
Returns:
-
ConstantFormatVideoNode
–The resampled clip.
Source code
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 |
|
rescale ¶
rescale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: ShiftT = (0, 0),
*,
linear: bool | None = None,
sigmoid: bool | tuple[Slope, Center] = False,
border_handling: int | BorderHandling = MIRROR,
sample_grid_model: int | SampleGridModel = MATCH_EDGES,
field_based: FieldBasedT | None = None,
ignore_mask: VideoNode | None = None,
blur: float | None = None,
**kwargs: Any
) -> ConstantFormatVideoNode
Rescale a clip to the given resolution from a previously descaled clip, with image borders handling and sampling grid alignment, optionally using linear light processing.
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
, default:None
) –Target scaled width (defaults to clip width if None).
-
height
¶int | None
, default:None
) –Target scaled height (defaults to clip height if None).
-
shift
¶ShiftT
, default:(0, 0)
) –Subpixel shift (top, left) or per-field shifts.
-
linear
¶bool | None
, default:None
) –Whether to linearize the input before rescaling. If None, inferred from sigmoid.
-
sigmoid
¶bool | tuple[Slope, Center]
, default:False
) –Whether to use sigmoid transfer curve. Can be True, False, or a tuple of (slope, center).
True
applies the defaults values (6.5, 0.75). Keep in mind sigmoid slope has to be in range 1.0-20.0 (inclusive) and sigmoid center has to be in range 0.0-1.0 (inclusive). -
border_handling
¶int | BorderHandling
, default:MIRROR
) –Method for handling image borders during sampling.
-
sample_grid_model
¶int | SampleGridModel
, default:MATCH_EDGES
) –Model used to align sampling grid.
-
field_based
¶FieldBasedT | None
, default:None
) –Field-based processing mode (interlaced or progressive).
-
ignore_mask
¶VideoNode | None
, default:None
) –Optional mask specifying areas to ignore during rescaling.
-
blur
¶float | None
, default:None
) –Amount of blur to apply during rescaling.
-
kwargs
¶Any
, default:{}
) –Additional arguments passed to
rescale_function
.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
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 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[TopShift | list[TopShift], LeftShift | list[LeftShift]] = (
0,
0,
),
*,
linear: bool | None = None,
sigmoid: bool | tuple[Slope, Center] = False,
border_handling: BorderHandling = MIRROR,
sample_grid_model: SampleGridModel = MATCH_EDGES,
sar: Sar | float | bool | None = None,
dar: Dar | float | bool | None = None,
dar_in: Dar | bool | float | None = None,
keep_ar: bool | None = None,
blur: float | None = None,
**kwargs: Any
) -> VideoNode | ConstantFormatVideoNode
Scale a clip to the given resolution, with aspect ratio and linear light support.
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
, default:None
) –Target width (defaults to clip width if None).
-
height
¶int | None
, default:None
) –Target height (defaults to clip height if None).
-
shift
¶tuple[TopShift | list[TopShift], LeftShift | list[LeftShift]]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling. If a tuple is provided, it is used uniformly. If a list is given, the shift is applied per plane.
-
linear
¶bool | None
, default:None
) –Whether to linearize the input before descaling. If None, inferred from sigmoid.
-
sigmoid
¶bool | tuple[Slope, Center]
, default:False
) –Whether to use sigmoid transfer curve. Can be True, False, or a tuple of (slope, center).
True
applies the defaults values (6.5, 0.75). Keep in mind sigmoid slope has to be in range 1.0-20.0 (inclusive) and sigmoid center has to be in range 0.0-1.0 (inclusive). -
border_handling
¶BorderHandling
, default:MIRROR
) –Method for handling image borders during sampling.
-
sample_grid_model
¶SampleGridModel
, default:MATCH_EDGES
) –Model used to align sampling grid.
-
sar
¶Sar | float | bool | None
, default:None
) –Sample aspect ratio to assume or convert to.
-
dar
¶Dar | float | bool | None
, default:None
) –Desired display aspect ratio.
-
dar_in
¶Dar | bool | float | None
, default:None
) –Input display aspect ratio, if different from clip's.
-
keep_ar
¶bool | None
, default:None
) –Whether to adjust dimensions to preserve aspect ratio.
-
blur
¶float | None
, default:None
) –Amount of blur to apply during scaling.
Returns:
-
VideoNode | ConstantFormatVideoNode
–Scaled clip, optionally aspect-corrected and linearized.
Source code
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 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 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 |
|
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 |
|
Lanczos ¶
Bases: ZimgComplexKernel
Lanczos resizer.
Initialize the kernel with a specific number of taps.
Parameters:
-
taps
¶float
, default:3
) –Determines the radius of the kernel.
-
kwargs
¶Any
, default:{}
) –Additional keyword arguments passed to the superclass.
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
bob
–Apply bob deinterlacing to a given clip using the selected resizer.
-
deinterlace
–Apply deinterlacing to a given clip using the selected resizer.
-
descale
–Descale a clip to the given resolution, with image borders handling and sampling grid alignment,
-
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_bob_args
– -
get_descale_args
–Generate and normalize argument dictionary for a descale operation.
-
get_params_args
– -
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
– -
multi
–Deprecated alias for
supersample
. -
pretty_string
–Cached property returning a user-friendly string representation.
-
resample
–Resample a video clip to the given format.
-
rescale
–Rescale a clip to the given resolution from a previously descaled clip,
-
scale
–Scale a clip to the given resolution, with aspect ratio and linear light support.
-
shift
–Apply a subpixel shift to the clip using the kernel's scaling logic.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
bob_function
(Callable[..., ConstantFormatVideoNode]
) –Bob function called internally when performing bobbing operations.
-
descale_function
(Callable[..., ConstantFormatVideoNode]
) – -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
resample_function
(Callable[..., ConstantFormatVideoNode]
) – -
rescale_function
(Callable[..., ConstantFormatVideoNode]
) – -
scale_function
(Callable[..., VideoNode]
) – -
taps
–
Source code
46 47 48 49 50 51 52 53 54 |
|
bob_function class-attribute
instance-attribute
¶
bob_function: Callable[..., ConstantFormatVideoNode] = Bob
Bob function called internally when performing bobbing operations.
descale_function class-attribute
instance-attribute
¶
descale_function: Callable[..., ConstantFormatVideoNode] = Delanczos
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
resample_function class-attribute
instance-attribute
¶
resample_function: Callable[..., ConstantFormatVideoNode] = Lanczos
rescale_function class-attribute
instance-attribute
¶
rescale_function: Callable[..., ConstantFormatVideoNode] = Lanczos
scale_function class-attribute
instance-attribute
¶
scale_function: Callable[..., VideoNode] = Lanczos
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 |
|
bob ¶
bob(
clip: VideoNode, *, tff: FieldBasedT | bool | None = None, **kwargs: Any
) -> ConstantFormatVideoNode
Apply bob deinterlacing to a given clip using the selected resizer.
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
-
tff
¶FieldBasedT | bool | None
, default:None
) –Field order of the clip.
Returns:
-
ConstantFormatVideoNode
–The bobbed clip.
Source code
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
|
deinterlace ¶
deinterlace(
clip: VideoNode,
*,
tff: FieldBasedT | bool | None = None,
double_rate: bool = True,
**kwargs: Any
) -> ConstantFormatVideoNode
Apply deinterlacing to a given clip using the selected resizer.
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
-
tff
¶FieldBasedT | bool | None
, default:None
) –Field order of the clip.
-
double_rate
¶bool
, default:True
) –Wether to double the frame rate (True) of retain the original rate (False).
Returns:
-
ConstantFormatVideoNode
–The bobbed clip.
Source code
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
|
descale ¶
descale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: ShiftT = (0, 0),
*,
linear: bool | None = None,
sigmoid: bool | tuple[Slope, Center] = False,
border_handling: int | BorderHandling = MIRROR,
sample_grid_model: int | SampleGridModel = MATCH_EDGES,
field_based: FieldBasedT | None = None,
ignore_mask: VideoNode | None = None,
blur: float | None = None,
**kwargs: Any
) -> ConstantFormatVideoNode
Descale a clip to the given resolution, with image borders handling and sampling grid alignment, optionally using linear light processing.
Supports both progressive and interlaced sources. When interlaced, it will separate fields, perform per-field descaling, and weave them back.
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
, default:None
) –Target descaled width (defaults to clip width if None).
-
height
¶int | None
, default:None
) –Target descaled height (defaults to clip height if None).
-
shift
¶ShiftT
, default:(0, 0)
) –Subpixel shift (top, left) or per-field shifts.
-
linear
¶bool | None
, default:None
) –Whether to linearize the input before descaling. If None, inferred from sigmoid.
-
sigmoid
¶bool | tuple[Slope, Center]
, default:False
) –Whether to use sigmoid transfer curve. Can be True, False, or a tuple of (slope, center).
True
applies the defaults values (6.5, 0.75). Keep in mind sigmoid slope has to be in range 1.0-20.0 (inclusive) and sigmoid center has to be in range 0.0-1.0 (inclusive). -
border_handling
¶int | BorderHandling
, default:MIRROR
) –Method for handling image borders during sampling.
-
sample_grid_model
¶int | SampleGridModel
, default:MATCH_EDGES
) –Model used to align sampling grid.
-
field_based
¶FieldBasedT | None
, default:None
) –Field-based processing mode (interlaced or progressive).
-
ignore_mask
¶VideoNode | None
, default:None
) –Optional mask specifying areas to ignore during descaling.
-
blur
¶float | None
, default:None
) –Amount of blur to apply during scaling.
-
kwargs
¶Any
, default:{}
) –Additional arguments passed to
descale_function
.
Returns:
-
ConstantFormatVideoNode
–The descaled video node, optionally processed in linear light.
Source code
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 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 |
|
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_bob_args ¶
get_bob_args(
clip: VideoNode, shift: tuple[TopShift, LeftShift] = (0, 0), **kwargs: Any
) -> dict[str, Any]
Source code
64 65 66 67 68 69 70 |
|
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]
Source code
56 57 58 59 60 61 62 |
|
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
Source code
72 73 74 |
|
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
Resample a video clip to the given format.
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.
-
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
, default:None
) –An optional color transformation matrix to apply.
-
matrix_in
¶MatrixT | None
, default:None
) –An optional input matrix for color transformations.
-
kwargs
¶Any
, default:{}
) –Additional keyword arguments passed to the
resample_function
.
Returns:
-
ConstantFormatVideoNode
–The resampled clip.
Source code
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 |
|
rescale ¶
rescale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: ShiftT = (0, 0),
*,
linear: bool | None = None,
sigmoid: bool | tuple[Slope, Center] = False,
border_handling: int | BorderHandling = MIRROR,
sample_grid_model: int | SampleGridModel = MATCH_EDGES,
field_based: FieldBasedT | None = None,
ignore_mask: VideoNode | None = None,
blur: float | None = None,
**kwargs: Any
) -> ConstantFormatVideoNode
Rescale a clip to the given resolution from a previously descaled clip, with image borders handling and sampling grid alignment, optionally using linear light processing.
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
, default:None
) –Target scaled width (defaults to clip width if None).
-
height
¶int | None
, default:None
) –Target scaled height (defaults to clip height if None).
-
shift
¶ShiftT
, default:(0, 0)
) –Subpixel shift (top, left) or per-field shifts.
-
linear
¶bool | None
, default:None
) –Whether to linearize the input before rescaling. If None, inferred from sigmoid.
-
sigmoid
¶bool | tuple[Slope, Center]
, default:False
) –Whether to use sigmoid transfer curve. Can be True, False, or a tuple of (slope, center).
True
applies the defaults values (6.5, 0.75). Keep in mind sigmoid slope has to be in range 1.0-20.0 (inclusive) and sigmoid center has to be in range 0.0-1.0 (inclusive). -
border_handling
¶int | BorderHandling
, default:MIRROR
) –Method for handling image borders during sampling.
-
sample_grid_model
¶int | SampleGridModel
, default:MATCH_EDGES
) –Model used to align sampling grid.
-
field_based
¶FieldBasedT | None
, default:None
) –Field-based processing mode (interlaced or progressive).
-
ignore_mask
¶VideoNode | None
, default:None
) –Optional mask specifying areas to ignore during rescaling.
-
blur
¶float | None
, default:None
) –Amount of blur to apply during rescaling.
-
kwargs
¶Any
, default:{}
) –Additional arguments passed to
rescale_function
.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
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 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[TopShift | list[TopShift], LeftShift | list[LeftShift]] = (
0,
0,
),
*,
linear: bool | None = None,
sigmoid: bool | tuple[Slope, Center] = False,
border_handling: BorderHandling = MIRROR,
sample_grid_model: SampleGridModel = MATCH_EDGES,
sar: Sar | float | bool | None = None,
dar: Dar | float | bool | None = None,
dar_in: Dar | bool | float | None = None,
keep_ar: bool | None = None,
blur: float | None = None,
**kwargs: Any
) -> VideoNode | ConstantFormatVideoNode
Scale a clip to the given resolution, with aspect ratio and linear light support.
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
, default:None
) –Target width (defaults to clip width if None).
-
height
¶int | None
, default:None
) –Target height (defaults to clip height if None).
-
shift
¶tuple[TopShift | list[TopShift], LeftShift | list[LeftShift]]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling. If a tuple is provided, it is used uniformly. If a list is given, the shift is applied per plane.
-
linear
¶bool | None
, default:None
) –Whether to linearize the input before descaling. If None, inferred from sigmoid.
-
sigmoid
¶bool | tuple[Slope, Center]
, default:False
) –Whether to use sigmoid transfer curve. Can be True, False, or a tuple of (slope, center).
True
applies the defaults values (6.5, 0.75). Keep in mind sigmoid slope has to be in range 1.0-20.0 (inclusive) and sigmoid center has to be in range 0.0-1.0 (inclusive). -
border_handling
¶BorderHandling
, default:MIRROR
) –Method for handling image borders during sampling.
-
sample_grid_model
¶SampleGridModel
, default:MATCH_EDGES
) –Model used to align sampling grid.
-
sar
¶Sar | float | bool | None
, default:None
) –Sample aspect ratio to assume or convert to.
-
dar
¶Dar | float | bool | None
, default:None
) –Desired display aspect ratio.
-
dar_in
¶Dar | bool | float | None
, default:None
) –Input display aspect ratio, if different from clip's.
-
keep_ar
¶bool | None
, default:None
) –Whether to adjust dimensions to preserve aspect ratio.
-
blur
¶float | None
, default:None
) –Amount of blur to apply during scaling.
Returns:
-
VideoNode | ConstantFormatVideoNode
–Scaled clip, optionally aspect-corrected and linearized.
Source code
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 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 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 |
|
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 |
|
Point ¶
Point(**kwargs: Any)
Bases: ZimgComplexKernel
Point resizer.
Initialize the scaler with optional keyword arguments.
These keyword arguments are automatically forwarded to the _implemented_funcs
methods but only if the method explicitly accepts them as named parameters. If the same keyword is passed to both __init__
and one of the _implemented_funcs
, the one passed to func
takes precedence.
Parameters:
Classes:
-
cached_property
–Read only version of functools.cached_property.
Methods:
-
bob
–Apply bob deinterlacing to a given clip using the selected resizer.
-
deinterlace
–Apply deinterlacing to a given clip using the selected resizer.
-
descale
–Descale a clip to the given resolution, with image borders handling and sampling grid alignment,
-
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_bob_args
–Generate the keyword arguments used for bobbing.
-
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
–Resample a video clip to the given format.
-
rescale
–Rescale a clip to the given resolution from a previously descaled clip,
-
scale
–Scale a clip to the given resolution, with aspect ratio and linear light support.
-
shift
–Apply a subpixel shift to the clip using the kernel's scaling logic.
-
supersample
–Supersample a clip by a given scaling factor.
Attributes:
-
bob_function
(Callable[..., ConstantFormatVideoNode]
) –Bob function called internally when performing bobbing operations.
-
descale_function
(Callable[..., ConstantFormatVideoNode]
) – -
kwargs
(dict[str, Any]
) –Arguments passed to the implemented funcs or internal scale function.
-
resample_function
(Callable[..., ConstantFormatVideoNode]
) – -
rescale_function
(Callable[..., ConstantFormatVideoNode]
) – -
scale_function
(Callable[..., VideoNode]
) –
Source code
281 282 283 284 285 286 287 288 289 290 291 292 |
|
bob_function class-attribute
instance-attribute
¶
bob_function: Callable[..., ConstantFormatVideoNode] = Bob
Bob function called internally when performing bobbing operations.
descale_function class-attribute
instance-attribute
¶
descale_function: Callable[..., ConstantFormatVideoNode] = Depoint
kwargs instance-attribute
¶
Arguments passed to the implemented funcs or internal scale function.
resample_function class-attribute
instance-attribute
¶
resample_function: Callable[..., ConstantFormatVideoNode] = Point
rescale_function class-attribute
instance-attribute
¶
rescale_function: Callable[..., ConstantFormatVideoNode] = Point
scale_function class-attribute
instance-attribute
¶
scale_function: Callable[..., VideoNode] = Point
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 |
|
bob ¶
bob(
clip: VideoNode, *, tff: FieldBasedT | bool | None = None, **kwargs: Any
) -> ConstantFormatVideoNode
Apply bob deinterlacing to a given clip using the selected resizer.
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
-
tff
¶FieldBasedT | bool | None
, default:None
) –Field order of the clip.
Returns:
-
ConstantFormatVideoNode
–The bobbed clip.
Source code
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
|
deinterlace ¶
deinterlace(
clip: VideoNode,
*,
tff: FieldBasedT | bool | None = None,
double_rate: bool = True,
**kwargs: Any
) -> ConstantFormatVideoNode
Apply deinterlacing to a given clip using the selected resizer.
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
-
tff
¶FieldBasedT | bool | None
, default:None
) –Field order of the clip.
-
double_rate
¶bool
, default:True
) –Wether to double the frame rate (True) of retain the original rate (False).
Returns:
-
ConstantFormatVideoNode
–The bobbed clip.
Source code
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
|
descale ¶
descale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: ShiftT = (0, 0),
*,
linear: bool | None = None,
sigmoid: bool | tuple[Slope, Center] = False,
border_handling: int | BorderHandling = MIRROR,
sample_grid_model: int | SampleGridModel = MATCH_EDGES,
field_based: FieldBasedT | None = None,
ignore_mask: VideoNode | None = None,
blur: float | None = None,
**kwargs: Any
) -> ConstantFormatVideoNode
Descale a clip to the given resolution, with image borders handling and sampling grid alignment, optionally using linear light processing.
Supports both progressive and interlaced sources. When interlaced, it will separate fields, perform per-field descaling, and weave them back.
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
, default:None
) –Target descaled width (defaults to clip width if None).
-
height
¶int | None
, default:None
) –Target descaled height (defaults to clip height if None).
-
shift
¶ShiftT
, default:(0, 0)
) –Subpixel shift (top, left) or per-field shifts.
-
linear
¶bool | None
, default:None
) –Whether to linearize the input before descaling. If None, inferred from sigmoid.
-
sigmoid
¶bool | tuple[Slope, Center]
, default:False
) –Whether to use sigmoid transfer curve. Can be True, False, or a tuple of (slope, center).
True
applies the defaults values (6.5, 0.75). Keep in mind sigmoid slope has to be in range 1.0-20.0 (inclusive) and sigmoid center has to be in range 0.0-1.0 (inclusive). -
border_handling
¶int | BorderHandling
, default:MIRROR
) –Method for handling image borders during sampling.
-
sample_grid_model
¶int | SampleGridModel
, default:MATCH_EDGES
) –Model used to align sampling grid.
-
field_based
¶FieldBasedT | None
, default:None
) –Field-based processing mode (interlaced or progressive).
-
ignore_mask
¶VideoNode | None
, default:None
) –Optional mask specifying areas to ignore during descaling.
-
blur
¶float | None
, default:None
) –Amount of blur to apply during scaling.
-
kwargs
¶Any
, default:{}
) –Additional arguments passed to
descale_function
.
Returns:
-
ConstantFormatVideoNode
–The descaled video node, optionally processed in linear light.
Source code
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 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 |
|
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_bob_args ¶
get_bob_args(
clip: VideoNode, shift: tuple[TopShift, LeftShift] = (0, 0), **kwargs: Any
) -> dict[str, Any]
Generate the keyword arguments used for bobbing.
Parameters:
-
clip
¶VideoNode
) –The source clip.
-
shift
¶tuple[TopShift, LeftShift]
, default:(0, 0)
) –Subpixel shift (top, left).
-
kwargs
¶Any
, default:{}
) –Extra parameters to merge.
Returns:
Source code
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
|
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
Resample a video clip to the given format.
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.
-
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
, default:None
) –An optional color transformation matrix to apply.
-
matrix_in
¶MatrixT | None
, default:None
) –An optional input matrix for color transformations.
-
kwargs
¶Any
, default:{}
) –Additional keyword arguments passed to the
resample_function
.
Returns:
-
ConstantFormatVideoNode
–The resampled clip.
Source code
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 |
|
rescale ¶
rescale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: ShiftT = (0, 0),
*,
linear: bool | None = None,
sigmoid: bool | tuple[Slope, Center] = False,
border_handling: int | BorderHandling = MIRROR,
sample_grid_model: int | SampleGridModel = MATCH_EDGES,
field_based: FieldBasedT | None = None,
ignore_mask: VideoNode | None = None,
blur: float | None = None,
**kwargs: Any
) -> ConstantFormatVideoNode
Rescale a clip to the given resolution from a previously descaled clip, with image borders handling and sampling grid alignment, optionally using linear light processing.
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
, default:None
) –Target scaled width (defaults to clip width if None).
-
height
¶int | None
, default:None
) –Target scaled height (defaults to clip height if None).
-
shift
¶ShiftT
, default:(0, 0)
) –Subpixel shift (top, left) or per-field shifts.
-
linear
¶bool | None
, default:None
) –Whether to linearize the input before rescaling. If None, inferred from sigmoid.
-
sigmoid
¶bool | tuple[Slope, Center]
, default:False
) –Whether to use sigmoid transfer curve. Can be True, False, or a tuple of (slope, center).
True
applies the defaults values (6.5, 0.75). Keep in mind sigmoid slope has to be in range 1.0-20.0 (inclusive) and sigmoid center has to be in range 0.0-1.0 (inclusive). -
border_handling
¶int | BorderHandling
, default:MIRROR
) –Method for handling image borders during sampling.
-
sample_grid_model
¶int | SampleGridModel
, default:MATCH_EDGES
) –Model used to align sampling grid.
-
field_based
¶FieldBasedT | None
, default:None
) –Field-based processing mode (interlaced or progressive).
-
ignore_mask
¶VideoNode | None
, default:None
) –Optional mask specifying areas to ignore during rescaling.
-
blur
¶float | None
, default:None
) –Amount of blur to apply during rescaling.
-
kwargs
¶Any
, default:{}
) –Additional arguments passed to
rescale_function
.
Returns:
-
ConstantFormatVideoNode
–The scaled clip.
Source code
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 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 |
|
scale ¶
scale(
clip: VideoNode,
width: int | None = None,
height: int | None = None,
shift: tuple[TopShift | list[TopShift], LeftShift | list[LeftShift]] = (
0,
0,
),
*,
linear: bool | None = None,
sigmoid: bool | tuple[Slope, Center] = False,
border_handling: BorderHandling = MIRROR,
sample_grid_model: SampleGridModel = MATCH_EDGES,
sar: Sar | float | bool | None = None,
dar: Dar | float | bool | None = None,
dar_in: Dar | bool | float | None = None,
keep_ar: bool | None = None,
blur: float | None = None,
**kwargs: Any
) -> VideoNode | ConstantFormatVideoNode
Scale a clip to the given resolution, with aspect ratio and linear light support.
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
, default:None
) –Target width (defaults to clip width if None).
-
height
¶int | None
, default:None
) –Target height (defaults to clip height if None).
-
shift
¶tuple[TopShift | list[TopShift], LeftShift | list[LeftShift]]
, default:(0, 0)
) –Subpixel shift (top, left) applied during scaling. If a tuple is provided, it is used uniformly. If a list is given, the shift is applied per plane.
-
linear
¶bool | None
, default:None
) –Whether to linearize the input before descaling. If None, inferred from sigmoid.
-
sigmoid
¶bool | tuple[Slope, Center]
, default:False
) –Whether to use sigmoid transfer curve. Can be True, False, or a tuple of (slope, center).
True
applies the defaults values (6.5, 0.75). Keep in mind sigmoid slope has to be in range 1.0-20.0 (inclusive) and sigmoid center has to be in range 0.0-1.0 (inclusive). -
border_handling
¶BorderHandling
, default:MIRROR
) –Method for handling image borders during sampling.
-
sample_grid_model
¶SampleGridModel
, default:MATCH_EDGES
) –Model used to align sampling grid.
-
sar
¶Sar | float | bool | None
, default:None
) –Sample aspect ratio to assume or convert to.
-
dar
¶Dar | float | bool | None
, default:None
) –Desired display aspect ratio.
-
dar_in
¶Dar | bool | float | None
, default:None
) –Input display aspect ratio, if different from clip's.
-
keep_ar
¶bool | None
, default:None
) –Whether to adjust dimensions to preserve aspect ratio.
-
blur
¶float | None
, default:None
) –Amount of blur to apply during scaling.
Returns:
-
VideoNode | ConstantFormatVideoNode
–Scaled clip, optionally aspect-corrected and linearized.
Source code
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 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 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 |
|
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 |
|