feat: added the geometric operations to BoundingBox

[PeterStaar-IBM]

No description provided.

[mergify]

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

• title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert)(?:\(.+\))?(!)?:

🟢 Require two reviewer for test updates

Wonderful, this rule succeeded.

When test data is updated, we require two reviewers

• #approved-reviews-by >= 2

[cau-git]

I like that we get more functions but we should never add page_height as an argument, neither to existing nor to new methods. If the "other" bbox does not agree in coord_origin with the self bbox, it must raise an exception instead. It is user business to ensure this beforehand.

[dolfim-ibm]

This is also a useful geometric operation to add: https://github.com/DS4SD/docling/blob/main/docling/models/base_model.py#L71

[dolfim-ibm]

Just mentioning here one possibility that was discussed.

One wish is a simple way of dealing with rescaling from a given page size to a new one. In the current solution this can be done as a combination of .normalize(old_page_size).scale(new_page_size).

Would it worth leaving the scale() and normalize() untouched, and bring a new function

def resize_by_scale(self, x_scale: float, y_scale: float):
    return BoundingBox(
        l=self.l * x_scale,
        r=self.r * x_scale,
        t=self.t * y_scale,
        b=self.b * y_scale,
        coord_origin=self.coord_origin,
    )

def scale_to_size(self, orig_page_size: Size, new_page_size: Size):
    return self.resize_by_scale(x_scale=new_page_size.width/orig_page_size.width, y_scale=new_page_size.height/orig_page_size.height)

# same as before, but using the implementation above
def scale(self, scale: float):
    return self.resize_by_scale(scale, scale)

# same as before, but using the implementation above
def normalized(self, page_size: Size):
    return self.scale_to_size(orig_page_size=page_size, new_page_size=Size(1.0,1.0))

[PeterStaar-IBM]

def resize_by_scale(self, x_scale: float, y_scale: float):
    return BoundingBox(
        l=self.l * x_scale,
        r=self.r * x_scale,
        t=self.t * y_scale,
        b=self.b * y_scale,
        coord_origin=self.coord_origin,
    )

def scale_to_size(self, orig_page_size: Size, new_page_size: Size):
    return self.resize_by_scale(x_scale=new_page_size.width/orig_page_size.width, y_scale=new_page_size.height/orig_page_size.height)

# same as before, but using the implementation above
def scale(self, scale: float):
    return self.resize_by_scale(scale, scale)

# same as before, but using the implementation above
def normalized(self, page_size: Size):
    return self.scale_to_size(orig_page_size=page_size, new_page_size=Size(1.0,1.0))

well, that was basically what was originally proposed, just different names. Anyhow, adapted this now ...

[dolfim-ibm]

Tested within Docling here DS4SD/docling#830