custom-layoutparser 0.1.0__tar.gz

custom_layoutparser-0.1.0/PKG-INFO

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: custom-layoutparser
+Version: 0.1.0
+Requires-Python: >=3.8
+Dynamic: requires-python

custom_layoutparser-0.1.0/custom_layoutparser.egg-info/PKG-INFO

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: custom-layoutparser
+Version: 0.1.0
+Requires-Python: >=3.8
+Dynamic: requires-python

custom_layoutparser-0.1.0/custom_layoutparser.egg-info/SOURCES.txt

@@ -0,0 +1,37 @@
+setup.py
+custom_layoutparser.egg-info/PKG-INFO
+custom_layoutparser.egg-info/SOURCES.txt
+custom_layoutparser.egg-info/dependency_links.txt
+custom_layoutparser.egg-info/top_level.txt
+layoutparser/__init__.py
+layoutparser/file_utils.py
+layoutparser/visualization.py
+layoutparser/elements/__init__.py
+layoutparser/elements/base.py
+layoutparser/elements/errors.py
+layoutparser/elements/layout.py
+layoutparser/elements/layout_elements.py
+layoutparser/elements/utils.py
+layoutparser/io/__init__.py
+layoutparser/io/basic.py
+layoutparser/io/pdf.py
+layoutparser/models/__init__.py
+layoutparser/models/auto_layoutmodel.py
+layoutparser/models/base_catalog.py
+layoutparser/models/base_layoutmodel.py
+layoutparser/models/model_config.py
+layoutparser/models/detectron2/__init__.py
+layoutparser/models/detectron2/catalog.py
+layoutparser/models/detectron2/layoutmodel.py
+layoutparser/models/effdet/__init__.py
+layoutparser/models/effdet/catalog.py
+layoutparser/models/effdet/layoutmodel.py
+layoutparser/models/paddledetection/__init__.py
+layoutparser/models/paddledetection/catalog.py
+layoutparser/models/paddledetection/layoutmodel.py
+layoutparser/ocr/__init__.py
+layoutparser/ocr/base.py
+layoutparser/ocr/gcv_agent.py
+layoutparser/ocr/tesseract_agent.py
+layoutparser/tools/__init__.py
+layoutparser/tools/shape_operations.py

custom_layoutparser-0.1.0/custom_layoutparser.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

custom_layoutparser-0.1.0/custom_layoutparser.egg-info/top_level.txt

@@ -0,0 +1 @@
+layoutparser

custom_layoutparser-0.1.0/layoutparser/__init__.py

@@ -0,0 +1,89 @@
+# Copyright 2021 The Layout Parser team. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+__version__ = "0.3.4"
+
+import sys
+
+from .file_utils import (
+    _LazyModule,
+    is_detectron2_available,
+    is_paddle_available,
+    is_effdet_available,
+    is_pytesseract_available,
+    is_gcv_available,
+)
+
+_import_structure = {
+    "elements": [
+        "Interval", 
+        "Rectangle", 
+        "Quadrilateral", 
+        "TextBlock", 
+        "Layout"
+    ],
+    "visualization": [
+        "draw_box", 
+        "draw_text"
+    ],
+    "io": [
+        "load_json", 
+        "load_dict", 
+        "load_csv", 
+        "load_dataframe",
+        "load_pdf"
+    ],
+    "file_utils":[
+        "is_torch_available",
+        "is_torch_cuda_available",
+        "is_detectron2_available",
+        "is_paddle_available",
+        "is_pytesseract_available",
+        "is_gcv_available",
+        "requires_backends"
+    ],
+    "tools": [
+        "generalized_connected_component_analysis_1d",
+        "simple_line_detection",
+        "group_textblocks_based_on_category"
+    ]
+}
+
+_import_structure["models"] = ["AutoLayoutModel"]
+
+if is_detectron2_available():
+    _import_structure["models.detectron2"] = ["Detectron2LayoutModel"]
+
+if is_paddle_available():
+    _import_structure["models.paddledetection"] = ["PaddleDetectionLayoutModel"]
+
+if is_effdet_available():
+    _import_structure["models.effdet"] = ["EfficientDetLayoutModel"]
+
+if is_pytesseract_available():
+    _import_structure["ocr.tesseract_agent"] = [
+        "TesseractAgent",
+        "TesseractFeatureType",
+    ]
+
+if is_gcv_available():
+    _import_structure["ocr.gcv_agent"] = ["GCVAgent", "GCVFeatureType"]
+
+sys.modules[__name__] = _LazyModule(
+    __name__,
+    globals()["__file__"],
+    _import_structure,
+    module_spec=__spec__,
+    extra_objects={"__version__": __version__},
+)

custom_layoutparser-0.1.0/layoutparser/elements/__init__.py

@@ -0,0 +1,25 @@
+# Copyright 2021 The Layout Parser team. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from .base import BaseCoordElement, BaseLayoutElement
+from .layout_elements import (
+    Interval,
+    Rectangle,
+    Quadrilateral,
+    TextBlock,
+    ALL_BASECOORD_ELEMENTS,
+    BASECOORD_ELEMENT_NAMEMAP,
+    BASECOORD_ELEMENT_INDEXMAP,
+)
+from .layout import Layout

custom_layoutparser-0.1.0/layoutparser/elements/base.py

@@ -0,0 +1,275 @@
+# Copyright 2021 The Layout Parser team. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from typing import List, Dict, Dict, Any
+from abc import ABC, abstractmethod
+from copy import copy
+
+class BaseLayoutElement:
+    def set(self, inplace=False, **kwargs):
+
+        obj = self if inplace else copy(self)
+        var_dict = vars(obj)
+        for key, val in kwargs.items():
+            if key in var_dict:
+                var_dict[key] = val
+            elif f"_{key}" in var_dict:
+                var_dict[f"_{key}"] = val
+            else:
+                raise ValueError(f"Unknown attribute name: {key}")
+
+        return obj
+
+    def __repr__(self):
+
+        info_str = ", ".join([f"{key}={val}" for key, val in vars(self).items()])
+        return f"{self.__class__.__name__}({info_str})"
+
+    def __eq__(self, other):
+
+        if other.__class__ is not self.__class__:
+            return False
+
+        return vars(self) == vars(other)
+
+
+class BaseCoordElement(ABC, BaseLayoutElement):
+    @property
+    @abstractmethod
+    def _name(self) -> str:
+        """The name of the class"""
+        pass
+
+    @property
+    @abstractmethod
+    def _features(self) -> List[str]:
+        """A list of features names used for initializing the class object"""
+        pass
+
+    #######################################################################
+    #########################  Layout Properties  #########################
+    #######################################################################
+
+    @property
+    @abstractmethod
+    def width(self):
+        pass
+
+    @property
+    @abstractmethod
+    def height(self):
+        pass
+
+    @property
+    @abstractmethod
+    def coordinates(self):
+        pass
+
+    @property
+    @abstractmethod
+    def points(self):
+        pass
+
+    @property
+    @abstractmethod
+    def area(self):
+        pass
+
+    #######################################################################
+    ###   Geometric Relations (relative to, condition on, and is in)    ###
+    #######################################################################
+
+    @abstractmethod
+    def condition_on(self, other):
+        """
+        Given the current element in relative coordinates to another element which is in absolute coordinates,
+        generate a new element of the current element in absolute coordinates.
+
+        Args:
+            other (:obj:`BaseCoordElement`):
+                The other layout element involved in the geometric operations.
+
+        Raises:
+            Exception: Raise error when the input type of the other element is invalid.
+
+        Returns:
+            :obj:`BaseCoordElement`:
+                The BaseCoordElement object of the original element in the absolute coordinate system.
+        """
+
+        pass
+
+    @abstractmethod
+    def relative_to(self, other):
+        """
+        Given the current element and another element both in absolute coordinates,
+        generate a new element of the current element in relative coordinates to the other element.
+
+        Args:
+            other (:obj:`BaseCoordElement`): The other layout element involved in the geometric operations.
+
+        Raises:
+            Exception: Raise error when the input type of the other element is invalid.
+
+        Returns:
+            :obj:`BaseCoordElement`:
+                The BaseCoordElement object of the original element in the relative coordinate system.
+        """
+
+        pass
+
+    @abstractmethod
+    def is_in(self, other, soft_margin={}, center=False):
+        """
+        Identify whether the current element is within another element.
+
+        Args:
+            other (:obj:`BaseCoordElement`):
+                The other layout element involved in the geometric operations.
+            soft_margin (:obj:`dict`, `optional`, defaults to `{}`):
+                Enlarge the other element with wider margins to relax the restrictions.
+            center (:obj:`bool`, `optional`, defaults to `False`):
+                The toggle to determine whether the center (instead of the four corners)
+                of the current element is in the other element.
+
+        Returns:
+            :obj:`bool`: Returns `True` if the current element is in the other element and `False` if not.
+        """
+
+        pass
+
+    #######################################################################
+    ################# Shape Operations (intersect, union)  ################
+    #######################################################################
+
+    @abstractmethod
+    def intersect(self, other: "BaseCoordElement", strict: bool = True):
+        """Intersect the current shape with the other object, with operations defined in
+        :doc:`../notes/shape_operations`.
+        """
+
+    @abstractmethod
+    def union(self, other: "BaseCoordElement", strict: bool = True):
+        """Union the current shape with the other object, with operations defined in
+        :doc:`../notes/shape_operations`.
+        """
+
+    #######################################################################
+    ############### Geometric Operations (pad, shift, scale) ##############
+    #######################################################################
+
+    @abstractmethod
+    def pad(self, left=0, right=0, top=0, bottom=0, safe_mode=True):
+        """Pad the layout element on the four sides of the polygon with the user-defined pixels. If
+        safe_mode is set to True, the function will cut off the excess padding that falls on the negative
+        side of the coordinates.
+
+        Args:
+            left (:obj:`int`, `optional`, defaults to 0): The number of pixels to pad on the upper side of the polygon.
+            right (:obj:`int`, `optional`, defaults to 0): The number of pixels to pad on the lower side of the polygon.
+            top (:obj:`int`, `optional`, defaults to 0): The number of pixels to pad on the left side of the polygon.
+            bottom (:obj:`int`, `optional`, defaults to 0): The number of pixels to pad on the right side of the polygon.
+            safe_mode (:obj:`bool`, `optional`, defaults to True): A bool value to toggle the safe_mode.
+
+        Returns:
+            :obj:`BaseCoordElement`: The padded BaseCoordElement object.
+        """
+
+        pass
+
+    @abstractmethod
+    def shift(self, shift_distance=0):
+        """
+        Shift the layout element by user specified amounts on x and y axis respectively. If shift_distance is one
+        numeric value, the element will by shifted by the same specified amount on both x and y axis.
+
+        Args:
+            shift_distance (:obj:`numeric` or :obj:`Tuple(numeric)` or :obj:`List[numeric]`):
+                The number of pixels used to shift the element.
+
+        Returns:
+            :obj:`BaseCoordElement`: The shifted BaseCoordElement of the same shape-specific class.
+        """
+
+        pass
+
+    @abstractmethod
+    def scale(self, scale_factor=1):
+        """
+        Scale the layout element by a user specified amount on x and y axis respectively. If scale_factor is one
+        numeric value, the element will by scaled by the same specified amount on both x and y axis.
+
+        Args:
+            scale_factor (:obj:`numeric` or :obj:`Tuple(numeric)` or :obj:`List[numeric]`): The amount for downscaling or upscaling the element.
+
+        Returns:
+            :obj:`BaseCoordElement`: The scaled BaseCoordElement of the same shape-specific class.
+        """
+
+        pass
+
+    #######################################################################
+    ################################# MISC ################################
+    #######################################################################
+
+    @abstractmethod
+    def crop_image(self, image):
+        """
+        Crop the input image according to the coordinates of the element.
+
+        Args:
+            image (:obj:`Numpy array`): The array of the input image.
+
+        Returns:
+            :obj:`Numpy array`: The array of the cropped image.
+        """
+
+        pass
+
+    #######################################################################
+    ########################## Import and Export ##########################
+    #######################################################################
+
+    def to_dict(self) -> Dict[str, Any]:
+        """
+        Generate a dictionary representation of the current object:
+            {
+                "block_type": <"interval", "rectangle", "quadrilateral"> ,
+                "non_empty_block_attr1": value1,
+                ...
+            }
+        """
+
+        data = {
+            key: getattr(self, key)
+            for key in self._features
+            if getattr(self, key) is not None
+        }
+        data["block_type"] = self._name
+        return data
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "BaseCoordElement":
+        """Initialize an instance based on the dictionary representation
+
+        Args:
+            data (:obj:`dict`): The dictionary representation of the object
+        """
+
+        assert (
+            cls._name == data["block_type"]
+        ), f"Incompatible block types {data['block_type']}"
+
+        return cls(**{f: data[f] for f in cls._features})
+

custom_layoutparser-0.1.0/layoutparser/elements/errors.py

@@ -0,0 +1,26 @@
+# Copyright 2021 The Layout Parser team. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class NotSupportedShapeError(Exception):
+    """For now (v0.2), if the created shape might be a polygon (shapes with more than 4 vertices),
+    layoutparser will raise NotSupportedShapeError. It is expected to be fixed in the future versions.
+    See
+    :ref:`shape_operations:problems-related-to-the-quadrilateral-class`.
+    """
+
+
+class InvalidShapeError(Exception):
+    """For shape operations like intersection of union, lp will raise the InvalidShapeError when
+    invalid shapes are created (e.g., intersecting a rectangle and an interval).
+    """