Skip to content

Geometry to bbox

GeometryToBboxExtract

Bases: ExtractionMethod

Accepts a geometry with type and list of coordinates to RFC 7946, section 5 <https://tools.ietf.org/html/rfc7946#section-5>_ formatted bbox.

Method name: geometry_to_bbox

Example Configuration

.. code-block:: yaml

- method: geometry_to_bbox
  inputs:
    geometry:
      type: point
      coordinates:
        - 20
        - 0
Source code in extraction_methods/plugins/geometry_to_bbox.py 
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
class GeometryToBboxExtract(ExtractionMethod):
    """
    Accepts a geometry with type and list of coordinates to `RFC 7946,
    section 5 <https://tools.ietf.org/html/rfc7946#section-5>`_ formatted bbox.

    **Method name:** ``geometry_to_bbox``

    Example Configuration:
        .. code-block:: yaml

            - method: geometry_to_bbox
              inputs:
                geometry:
                  type: point
                  coordinates:
                    - 20
                    - 0
    """

    input_class = GeometryToBboxInput

    def point(self, coordinates: list[float]) -> list[float]:
        """
        Get point bbox

        :param coordinates: list of coordinates
        :type coordinates: list

        :return: bounding box of coordinates
        :rtype: list
        """

        return [
            coordinates[0],
            coordinates[1],
            coordinates[0],
            coordinates[1],
        ]

    def line(self, coordinates: list[list[float]]) -> list[float]:
        """
        Get line bbox

        :param coordinates: list of coordinates
        :type coordinates: list

        :return: bounding box of coordinates
        :rtype: list
        """

        bbox = self.point(coordinates[0])

        for coordinate in coordinates[1:]:

            if coordinate[0] < bbox[0]:
                bbox[0] = coordinate[0]

            elif coordinate[0] > bbox[2]:
                bbox[2] = coordinate[0]

            if coordinate[1] < bbox[1]:
                bbox[1] = coordinate[1]

            elif coordinate[1] > bbox[3]:
                bbox[3] = coordinate[1]

        return bbox

    def polygon(self, coordinates: list[list[float]]) -> list[float]:
        """
        Get polygon bbox

        :param coordinates: list of coordinates
        :type coordinates: list

        :return: bounding box of coordinates
        :rtype: list
        """

        return self.line(coordinates[1:])

    def multi(self, coordinate_type: str, coordinates: list[Any]) -> list[float]:
        """
        Get polygon bbox

        :param coordinate_type: type of coordinates
        :type coordinate_type: str
        :param coordinates: list of coordinates
        :type coordinates: list

        :return: bounding box of coordinates
        :rtype: list
        """

        bboxes = [
            self.get_bbox(coordinate_type.lstrip("Multi"), coordinate)
            for coordinate in coordinates
        ]
        return [
            min(bbox[0] for bbox in bboxes),
            max(bbox[2] for bbox in bboxes),
            min(bbox[1] for bbox in bboxes),
            max(bbox[3] for bbox in bboxes),
        ]

    def get_bbox(self, coordinate_type: str, coordinates: list[Any]) -> list[float]:
        """
        Get bbox from geometry

        :param coordinate_type: type of coordinates
        :type coordinate_type: str
        :param coordinates: list of coordinates
        :type coordinates: list

        :return: bounding box of coordinates
        :rtype: list
        """

        if coordinate_type == "Point":
            return self.point(coordinates)

        if coordinate_type == "Line":
            return self.line(coordinates)

        if coordinate_type == "Polygon":
            return self.polygon(coordinates[0])

        if coordinate_type.startswith("Multi"):
            return self.multi(coordinate_type, coordinates)

        return []

    @update_input
    def run(self, body: dict[str, Any]) -> dict[str, Any]:

        body[self.input.output_key] = self.get_bbox(
            self.input.geometry["type"], self.input.geometry["coordinates"]
        )

        return body

get_bbox(coordinate_type, coordinates)

Get bbox from geometry

:param coordinate_type: type of coordinates :type coordinate_type: str :param coordinates: list of coordinates :type coordinates: list

:return: bounding box of coordinates :rtype: list

Source code in extraction_methods/plugins/geometry_to_bbox.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
def get_bbox(self, coordinate_type: str, coordinates: list[Any]) -> list[float]:
    """
    Get bbox from geometry

    :param coordinate_type: type of coordinates
    :type coordinate_type: str
    :param coordinates: list of coordinates
    :type coordinates: list

    :return: bounding box of coordinates
    :rtype: list
    """

    if coordinate_type == "Point":
        return self.point(coordinates)

    if coordinate_type == "Line":
        return self.line(coordinates)

    if coordinate_type == "Polygon":
        return self.polygon(coordinates[0])

    if coordinate_type.startswith("Multi"):
        return self.multi(coordinate_type, coordinates)

    return []

line(coordinates)

Get line bbox

:param coordinates: list of coordinates :type coordinates: list

:return: bounding box of coordinates :rtype: list

Source code in extraction_methods/plugins/geometry_to_bbox.py 
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def line(self, coordinates: list[list[float]]) -> list[float]:
    """
    Get line bbox

    :param coordinates: list of coordinates
    :type coordinates: list

    :return: bounding box of coordinates
    :rtype: list
    """

    bbox = self.point(coordinates[0])

    for coordinate in coordinates[1:]:

        if coordinate[0] < bbox[0]:
            bbox[0] = coordinate[0]

        elif coordinate[0] > bbox[2]:
            bbox[2] = coordinate[0]

        if coordinate[1] < bbox[1]:
            bbox[1] = coordinate[1]

        elif coordinate[1] > bbox[3]:
            bbox[3] = coordinate[1]

    return bbox

multi(coordinate_type, coordinates)

Get polygon bbox

:param coordinate_type: type of coordinates :type coordinate_type: str :param coordinates: list of coordinates :type coordinates: list

:return: bounding box of coordinates :rtype: list

Source code in extraction_methods/plugins/geometry_to_bbox.py 
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
def multi(self, coordinate_type: str, coordinates: list[Any]) -> list[float]:
    """
    Get polygon bbox

    :param coordinate_type: type of coordinates
    :type coordinate_type: str
    :param coordinates: list of coordinates
    :type coordinates: list

    :return: bounding box of coordinates
    :rtype: list
    """

    bboxes = [
        self.get_bbox(coordinate_type.lstrip("Multi"), coordinate)
        for coordinate in coordinates
    ]
    return [
        min(bbox[0] for bbox in bboxes),
        max(bbox[2] for bbox in bboxes),
        min(bbox[1] for bbox in bboxes),
        max(bbox[3] for bbox in bboxes),
    ]

point(coordinates)

Get point bbox

:param coordinates: list of coordinates :type coordinates: list

:return: bounding box of coordinates :rtype: list

Source code in extraction_methods/plugins/geometry_to_bbox.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def point(self, coordinates: list[float]) -> list[float]:
    """
    Get point bbox

    :param coordinates: list of coordinates
    :type coordinates: list

    :return: bounding box of coordinates
    :rtype: list
    """

    return [
        coordinates[0],
        coordinates[1],
        coordinates[0],
        coordinates[1],
    ]

polygon(coordinates)

Get polygon bbox

:param coordinates: list of coordinates :type coordinates: list

:return: bounding box of coordinates :rtype: list

Source code in extraction_methods/plugins/geometry_to_bbox.py 
106
107
108
109
110
111
112
113
114
115
116
117
def polygon(self, coordinates: list[list[float]]) -> list[float]:
    """
    Get polygon bbox

    :param coordinates: list of coordinates
    :type coordinates: list

    :return: bounding box of coordinates
    :rtype: list
    """

    return self.line(coordinates[1:])

GeometryToBboxInput

Bases: Input

Model for Geometry to Bounding Box Input.

Parameters:

Name Type Description Default
geometry dict[str, Any]

geometry to be converted to bbox.

 '$geometry'
output_key str

key to output to.

 'bbox'
Source code in extraction_methods/plugins/geometry_to_bbox.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
class GeometryToBboxInput(Input):
    """
    Model for Geometry to Bounding Box Input.
    """

    geometry: dict[str, Any] = Field(  # type: ignore[assignment]
        default="$geometry",
        description="geometry to be converted to bbox.",
    )
    output_key: str = Field(
        default="bbox",
        description="key to output to.",
    )