Skip to content

Geometry

GeometryExtract

Bases: ExtractionMethod

Accepts a dictionary of coordinate values and converts to RFC 7946, <https://tools.ietf.org/html/rfc7946>_ formatted geometry.

Method name: geometry

Example Configuration

.. code-block:: yaml

- method: geometry
  inputs:
    type: line
    coordinates:
      -
        - 0
        - 0
      -
        - $lon_2
        - $lat_2
Source code in extraction_methods/plugins/geometry.py 
 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
178
179
180
181
182
183
184
class GeometryExtract(ExtractionMethod):
    """
    Accepts a dictionary of coordinate values and converts to `RFC 7946, <https://tools.ietf.org/html/rfc7946>`_
    formatted geometry.

    **Method name:** ``geometry``

    Example Configuration:
        .. code-block:: yaml

            - method: geometry
              inputs:
                type: line
                coordinates:
                  -
                    - 0
                    - 0
                  -
                    - $lon_2
                    - $lat_2
    """

    input_class = GeometryInput

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

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

        :return: coordinates
        :rtype: list
        """

        return [
            float(coordinates[0]),
            float(coordinates[1]),
        ]

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

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

        :return: coordinates
        :rtype: list
        """

        return [self.point(coordinate) for coordinate in coordinates]

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

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

        :return: coordinates
        :rtype: list
        """

        output = self.line(coordinates)

        if output[0] != output[-1]:
            # Add the first point to the end to complete the shape
            output.append(output[0])

        return [output]

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

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

        :return: coordinates
        :rtype: list
        """

        return [
            self.get_coordinates(coordinate_type.lstrip("Multi"), coordinate)
            for coordinate in coordinates
        ]

    def get_coordinates(
        self, coordinate_type: str, coordinates: list[Any]
    ) -> list[Any]:
        """
        Get coordinates

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

        :return: 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)

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

        return []

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

        try:
            body[self.input.output_key] = {
                "type": self.input.type,
                "coordinates": self.get_coordinates(
                    self.input.type,
                    self.input.coordinates,
                ),
            }

        except KeyError:
            LOGGER.warning(
                "Unable to convert to a line geometry.",
                exc_info=True,
            )

        return body

get_coordinates(coordinate_type, coordinates)

Get coordinates

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

:return: coordinates :rtype: list

Source code in extraction_methods/plugins/geometry.py 
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
def get_coordinates(
    self, coordinate_type: str, coordinates: list[Any]
) -> list[Any]:
    """
    Get coordinates

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

    :return: 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)

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

    return []

line(coordinates)

Get line coordinates

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

:return: coordinates :rtype: list

Source code in extraction_methods/plugins/geometry.py 
87
88
89
90
91
92
93
94
95
96
97
98
def line(self, coordinates: list[list[str | float]]) -> list[list[float]]:
    """
    Get line coordinates

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

    :return: coordinates
    :rtype: list
    """

    return [self.point(coordinate) for coordinate in coordinates]

multi(coordinate_type, coordinates)

Get polygon coordinates

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

:return: coordinates :rtype: list

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

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

    :return: coordinates
    :rtype: list
    """

    return [
        self.get_coordinates(coordinate_type.lstrip("Multi"), coordinate)
        for coordinate in coordinates
    ]

point(coordinates)

Get point coordinates

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

:return: coordinates :rtype: list

Source code in extraction_methods/plugins/geometry.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def point(self, coordinates: list[str | float]) -> list[float]:
    """
    Get point coordinates

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

    :return: coordinates
    :rtype: list
    """

    return [
        float(coordinates[0]),
        float(coordinates[1]),
    ]

polygon(coordinates)

Get polygon coordinates

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

:return: coordinates :rtype: list

Source code in extraction_methods/plugins/geometry.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
def polygon(self, coordinates: list[list[str | float]]) -> list[list[list[float]]]:
    """
    Get polygon coordinates

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

    :return: coordinates
    :rtype: list
    """

    output = self.line(coordinates)

    if output[0] != output[-1]:
        # Add the first point to the end to complete the shape
        output.append(output[0])

    return [output]

GeometryInput

Bases: Input

Model for Geometry Input.

Parameters:

Name Type Description Default
type Literal['Point', 'LineString', 'Polygon', 'MultiPointString', 'MultiLineString', 'MultiPolygon']

Type of geometry to be produced.

 required
coordinates list[Any]

list of coordinates to convert to geometry. Ordering is respected.

 required
output_key str

key to output to.

 'geometry'
Source code in extraction_methods/plugins/geometry.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class GeometryInput(Input):
    """
    Model for Geometry Input.
    """

    type: Literal[
        "Point",
        "LineString",
        "Polygon",
        "MultiPointString",
        "MultiLineString",
        "MultiPolygon",
    ] = Field(
        description="Type of geometry to be produced.",
    )
    coordinates: list[Any] = Field(
        description="list of coordinates to convert to geometry. Ordering is respected.",
    )
    output_key: str = Field(
        default="geometry",
        description="key to output to.",
    )