get_match_centers_scaling: New function #165
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Warning Rate Limit Exceeded@LightArrowsEXE has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 4 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. WalkthroughThis update introduces a significant enhancement to the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (1)
- lvsfunc/util.py (2 hunks)
Additional comments: 1
lvsfunc/util.py (1)
- 8-10: Consider grouping imports from
vstoolsinto a single line for consistency and readability.
lvsfunc/util.py
Outdated
Comment on lines
106
to
189
| def get_match_centers_scaling( | ||
| clip: vs.VideoNode, target_width: int | None = None, target_height: int | None = 720 | ||
| ) -> KwargsT: | ||
| """ | ||
| Convenience function to calculate the native resolution for sources that were upsampled | ||
| using the "match centers" model as opposed to the more common "match edges" models. | ||
|
|
||
| While match edges will align the edges of the outermost pixels in the target image, | ||
| match centers will instead align the *centers* of the outermost pixels. | ||
|
|
||
| Here's a visual example for a 3x1 image upsampled to 9x1: | ||
|
|
||
| * Match edges: | ||
|
|
||
| +-----------+-----------+-----------+ | ||
| | . | . | . | | ||
| +-----------+-----------+-----------+ | ||
| ↓ ↓ | ||
| +---+---+---+---+---+---+---+---+---+ | ||
| | . | . | . | . | . | . | . | . | . | | ||
| +---+---+---+---+---+---+---+---+---+ | ||
|
|
||
| * Match centers: | ||
|
|
||
| +-----------+-----------+-----------+ | ||
| | . | . | . | | ||
| +-----------+-----------+-----------+ | ||
| ↓ ↓ | ||
| +---+---+---+---+---+---+---+---+---+ | ||
| | . | . | . | . | . | . | . | . | . | | ||
| +---+---+---+---+---+---+---+---+---+ | ||
|
|
||
| For a more detailed explanation, refer to this page: `<https://entropymine.com/imageworsener/matching/>`. | ||
|
|
||
| The formula for calculating values we can use during desampling is simple: | ||
|
|
||
| * width: clip.width * (target_width - 1) / (clip.width - 1) | ||
| * height: clip.height * (target_height - 1) / (clip.height - 1) | ||
|
|
||
| Example usage: | ||
|
|
||
| .. code-block:: python | ||
|
|
||
| >>> from vodesfunc import DescaleTarget | ||
| >>> ... | ||
| >>> native_res = get_match_centers_scaling(src, 1280, 720) | ||
| >>> rescaled = DescaleTarget(kernel=Catrom, upscaler=Waifu2x, downscaler=Hermite(linear=True), **native_res) | ||
|
|
||
| The output is meant to be passed to `vodesfunc.DescaleTarget` as keyword arguments, | ||
| but it may also apply to other functions that require similar parameters. | ||
|
|
||
| :param clip: The clip to base the calculations on. | ||
| :param target_width: Target width for the descale. This should probably be equal to the base width. | ||
| If not provided, this value is calculated using the `target_height`. | ||
| Default: None. | ||
| :param target_height: Target height for the descale. This should probably be equal to the base height. | ||
| If not provided, this value is calculated using the `target_width`. | ||
| Default: 720. | ||
|
|
||
| :return: A dictionary with the keys, {width, height, base_width, base_height}, | ||
| which can be passed directly to `vodesfunc.DescaleTarget` or similar functions. | ||
| """ | ||
|
|
||
| if target_width is None and target_height is None: | ||
| raise CustomValueError("Either `target_width` or `target_height` must be provided.", get_match_centers_scaling) | ||
|
|
||
| check_variable_resolution(clip, get_match_centers_scaling) | ||
|
|
||
| if target_height is None: | ||
| target_height = get_h(target_width, clip, 1) | ||
|
|
||
| if not float(target_height).is_integer(): | ||
| raise CustomValueError("`target_height` must be an integer.", get_match_centers_scaling) | ||
|
|
||
| elif target_width is None: | ||
| target_width = get_w(target_height, clip, 1) | ||
|
|
||
| if not float(target_width).is_integer(): | ||
| raise CustomValueError("`target_width` must be an integer.", get_match_centers_scaling) | ||
|
|
||
| width = clip.width * (target_width - 1) / (clip.width - 1) | ||
| height = clip.height * (target_height - 1) / (clip.height - 1) | ||
|
|
||
| return KwargsT(width=width, height=height, base_width=target_width, base_height=target_height) |
There was a problem hiding this comment.
- The function
get_match_centers_scalinglacks validation fortarget_widthandtarget_heightbeing positive integers. This is crucial to prevent unexpected behavior or division by zero errors. - The calculation of
target_heightfromtarget_width(lines 174-178) and vice versa (lines 180-184) does not account for the case where both are provided but one does not match the expected calculation based on the clip's aspect ratio. This could lead to incorrect scaling. - The use of
float(target_height).is_integer()(line 177) andfloat(target_width).is_integer()(line 183) is unnecessary sincetarget_heightandtarget_widthshould already be integers if provided or calculated. A direct integer check would be more appropriate. - The formula used for calculating
widthandheight(lines 186-187) does not handle the case whereclip.widthorclip.heightis 1, leading to a division by zero error. - The function documentation (lines 157-166) promises to return a dictionary but actually returns a
KwargsTobject. Ensure the documentation accurately reflects the return type. - The example usage (lines 145-155) references
vodesfuncinstead ofvstoolsorlvsfunc, which might be a typo or incorrect reference. - The function does not handle non-integer results for
widthandheightcalculations (lines 186-187), which could be problematic for functions expecting integer dimensions.
- return KwargsT(width=width, height=height, base_width=target_width, base_height=target_height)
+ return KwargsT(width=int(round(width)), height=int(round(height)), base_width=int(target_width), base_height=int(target_height))- Add validation for positive
target_widthandtarget_height. - Clarify behavior and validation when both
target_widthandtarget_heightare provided. - Correct the documentation and example usage to accurately reflect the function's behavior and return type.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| def get_match_centers_scaling( | |
| clip: vs.VideoNode, target_width: int | None = None, target_height: int | None = 720 | |
| ) -> KwargsT: | |
| """ | |
| Convenience function to calculate the native resolution for sources that were upsampled | |
| using the "match centers" model as opposed to the more common "match edges" models. | |
| While match edges will align the edges of the outermost pixels in the target image, | |
| match centers will instead align the *centers* of the outermost pixels. | |
| Here's a visual example for a 3x1 image upsampled to 9x1: | |
| * Match edges: | |
| +-----------+-----------+-----------+ | |
| | . | . | . | | |
| +-----------+-----------+-----------+ | |
| ↓ ↓ | |
| +---+---+---+---+---+---+---+---+---+ | |
| | . | . | . | . | . | . | . | . | . | | |
| +---+---+---+---+---+---+---+---+---+ | |
| * Match centers: | |
| +-----------+-----------+-----------+ | |
| | . | . | . | | |
| +-----------+-----------+-----------+ | |
| ↓ ↓ | |
| +---+---+---+---+---+---+---+---+---+ | |
| | . | . | . | . | . | . | . | . | . | | |
| +---+---+---+---+---+---+---+---+---+ | |
| For a more detailed explanation, refer to this page: `<https://entropymine.com/imageworsener/matching/>`. | |
| The formula for calculating values we can use during desampling is simple: | |
| * width: clip.width * (target_width - 1) / (clip.width - 1) | |
| * height: clip.height * (target_height - 1) / (clip.height - 1) | |
| Example usage: | |
| .. code-block:: python | |
| >>> from vodesfunc import DescaleTarget | |
| >>> ... | |
| >>> native_res = get_match_centers_scaling(src, 1280, 720) | |
| >>> rescaled = DescaleTarget(kernel=Catrom, upscaler=Waifu2x, downscaler=Hermite(linear=True), **native_res) | |
| The output is meant to be passed to `vodesfunc.DescaleTarget` as keyword arguments, | |
| but it may also apply to other functions that require similar parameters. | |
| :param clip: The clip to base the calculations on. | |
| :param target_width: Target width for the descale. This should probably be equal to the base width. | |
| If not provided, this value is calculated using the `target_height`. | |
| Default: None. | |
| :param target_height: Target height for the descale. This should probably be equal to the base height. | |
| If not provided, this value is calculated using the `target_width`. | |
| Default: 720. | |
| :return: A dictionary with the keys, {width, height, base_width, base_height}, | |
| which can be passed directly to `vodesfunc.DescaleTarget` or similar functions. | |
| """ | |
| if target_width is None and target_height is None: | |
| raise CustomValueError("Either `target_width` or `target_height` must be provided.", get_match_centers_scaling) | |
| check_variable_resolution(clip, get_match_centers_scaling) | |
| if target_height is None: | |
| target_height = get_h(target_width, clip, 1) | |
| if not float(target_height).is_integer(): | |
| raise CustomValueError("`target_height` must be an integer.", get_match_centers_scaling) | |
| elif target_width is None: | |
| target_width = get_w(target_height, clip, 1) | |
| if not float(target_width).is_integer(): | |
| raise CustomValueError("`target_width` must be an integer.", get_match_centers_scaling) | |
| width = clip.width * (target_width - 1) / (clip.width - 1) | |
| height = clip.height * (target_height - 1) / (clip.height - 1) | |
| return KwargsT(width=width, height=height, base_width=target_width, base_height=target_height) | |
| def get_match_centers_scaling( | |
| clip: vs.VideoNode, target_width: int | None = None, target_height: int | None = 720 | |
| ) -> KwargsT: | |
| """ | |
| Convenience function to calculate the native resolution for sources that were upsampled | |
| using the "match centers" model as opposed to the more common "match edges" models. | |
| While match edges will align the edges of the outermost pixels in the target image, | |
| match centers will instead align the *centers* of the outermost pixels. | |
| Here's a visual example for a 3x1 image upsampled to 9x1: | |
| * Match edges: | |
| +-----------+-----------+-----------+ | |
| | . | . | . | | |
| +-----------+-----------+-----------+ | |
| ↓ ↓ | |
| +---+---+---+---+---+---+---+---+---+ | |
| | . | . | . | . | . | . | . | . | . | | |
| +---+---+---+---+---+---+---+---+---+ | |
| * Match centers: | |
| +-----------+-----------+-----------+ | |
| | . | . | . | | |
| +-----------+-----------+-----------+ | |
| ↓ ↓ | |
| +---+---+---+---+---+---+---+---+---+ | |
| | . | . | . | . | . | . | . | . | . | | |
| +---+---+---+---+---+---+---+---+---+ | |
| For a more detailed explanation, refer to this page: `<https://entropymine.com/imageworsener/matching/>`. | |
| The formula for calculating values we can use during desampling is simple: | |
| * width: clip.width * (target_width - 1) / (clip.width - 1) | |
| * height: clip.height * (target_height - 1) / (clip.height - 1) | |
| Example usage: | |
| .. code-block:: python | |
| >>> from vodesfunc import DescaleTarget | |
| >>> ... | |
| >>> native_res = get_match_centers_scaling(src, 1280, 720) | |
| >>> rescaled = DescaleTarget(kernel=Catrom, upscaler=Waifu2x, downscaler=Hermite(linear=True), **native_res) | |
| The output is meant to be passed to `vodesfunc.DescaleTarget` as keyword arguments, | |
| but it may also apply to other functions that require similar parameters. | |
| :param clip: The clip to base the calculations on. | |
| :param target_width: Target width for the descale. This should probably be equal to the base width. | |
| If not provided, this value is calculated using the `target_height`. | |
| Default: None. | |
| :param target_height: Target height for the descale. This should probably be equal to the base height. | |
| If not provided, this value is calculated using the `target_width`. | |
| Default: 720. | |
| :return: A dictionary with the keys, {width, height, base_width, base_height}, | |
| which can be passed directly to `vodesfunc.DescaleTarget` or similar functions. | |
| """ | |
| if target_width is None and target_height is None: | |
| raise CustomValueError("Either `target_width` or `target_height` must be provided.", get_match_centers_scaling) | |
| check_variable_resolution(clip, get_match_centers_scaling) | |
| if target_height is None: | |
| target_height = get_h(target_width, clip, 1) | |
| if not float(target_height).is_integer(): | |
| raise CustomValueError("`target_height` must be an integer.", get_match_centers_scaling) | |
| elif target_width is None: | |
| target_width = get_w(target_height, clip, 1) | |
| if not float(target_width).is_integer(): | |
| raise CustomValueError("`target_width` must be an integer.", get_match_centers_scaling) | |
| width = clip.width * (target_width - 1) / (clip.width - 1) | |
| height = clip.height * (target_height - 1) / (clip.height - 1) | |
| return KwargsT(width=int(round(width)), height=int(round(height)), base_width=int(target_width), base_height=int(target_height)) |
LightArrowsEXE
added a commit
that referenced
this pull request
Sep 25, 2024
* match_centers_formula: new util function * match_centers_formula: Expand docstring * get_match_centers_scaling: rename function, expand docs, minor optimisations * get_match_centers_scaling: Updates based on review
LightArrowsEXE
added a commit
that referenced
this pull request
Sep 25, 2024
* match_centers_formula: new util function * match_centers_formula: Expand docstring * get_match_centers_scaling: rename function, expand docs, minor optimisations * get_match_centers_scaling: Updates based on review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit