Skip to content

data_product module

Source code in d2spy/models/data_product.py 
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
class DataProduct:
    id: UUID
    data_type: str
    filepath: str
    original_filename: str
    is_active: bool
    flight_id: UUID
    deactivated_at: Optional[datetime]
    public: bool
    stac_properties: STACProperties
    status: str
    url: str

    def __init__(self, client: APIClient, **kwargs):
        self.client = client
        # data product attributes returned from API
        self.__dict__.update(kwargs)

    def __repr__(self):
        return (
            f"DataProduct(data_type={self.data_type!r}, "
            f"filepath={self.filepath!r}, "
            f"original_filename={self.original_filename!r}, "
            f"is_active={self.is_active!r}, public={self.public!r}, "
            f"stac_properties={self.stac_properties!r}, status={self.status!r}, "
            f"url={self.url!r})"
        )

    def clip(self, geojson_feature: Dict[Any, Any], out_raster: str) -> bool:
        """Clips data product by GeoJSON Polygon Feature.

        Args:
            geojson_feature (Dict[Any, Any]): GeoJSON Polygon Feature.
            out_raster (str): Path for output raster.

        Returns:
            bool: True if successful. False if clip fails.
        """
        if self.data_type == "point_cloud":
            print("Not available for point clouds")
            return False

        try:
            clip_by_mask(self.url, geojson_feature, out_raster)
            print("Raster clipped successfully")
            return True
        except RasterioIOError as e:
            if str(e) == "HTTP response code: 401":
                if os.environ.get("D2S_API_KEY"):
                    try:
                        clip_by_mask(
                            self.url + "?API_KEY=" + os.environ["D2S_API_KEY"],
                            geojson_feature,
                            out_raster,
                        )
                        print("Raster clipped successfully")
                        return True
                    except RasterioIOError as e2:
                        if str(e) == "HTTP response code: 401":
                            print("You do not have permission to access this raster")
                            return False
                        else:
                            raise e2
                else:
                    print("Set the 'D2S_API_KEY' environment variable before clipping")
                    return False
            else:
                raise e
        except Exception as e:
            print(f"Failed to clip raster: {e}")
            return False

    def get_band_info(self) -> Optional[List[STACEOProperties]]:
        """Return STAC Electro-Optical bands information.

        Returns:
            Optional[List[STACEOProperties]]: _description_
        """
        if self.data_type == "point_cloud":
            print("Point cloud does not have band info")
            return None

        if not self.stac_properties.get("eo"):
            print("Missing band properties")
            return None

        eo_properties = self.stac_properties["eo"]

        if not isinstance(eo_properties, List):
            print("Band properties in unexpected format")
            return None

        return eo_properties

    def derive_ndvi(self, red_band_idx: int, nir_band_idx: int) -> bool:
        """Use data product's bands to derive a new NDVI data product. Must provide
        the red and NIR band indexes.

        Args:
            red_band_idx (int): Red band index.
            nir_band_idx (int): NIR band index.

        Returns:
            bool: True if the job was added to the queue, otherwise False.
        """
        # Check if this is a raster data product
        if self.data_type == "point_cloud":
            print("Not available for point clouds")
            return False

        # Get band properties from STAC EO extension
        eo_properties = self.get_band_info()

        # Check if the data product has at least two bands
        if not isinstance(eo_properties, List) or len(eo_properties) < 2:
            print("Data product must have at least two bands - Red and NIR")
            print(eo_properties)
            return False

        # Reject if the red band index and NIR band index are the same
        if red_band_idx == nir_band_idx:
            print("Red band index and NIR band index cannot be the same")

        # Reject if the red band is outside of the range of possible bands
        if red_band_idx + 1 > len(eo_properties) or red_band_idx < 1:
            print("Red band index outside the range of available bands")

        # Reject if the NIR band is outside of the range of possible bands
        if nir_band_idx + 1 > len(eo_properties) or nir_band_idx < 1:
            print("NIR band index outside the range of available bands")

        # Prepare payload for post request
        data = {
            "chm": False,
            "exg": False,
            "exgRed": 0,
            "exgGreen": 0,
            "exgBlue": 0,
            "ndvi": True,
            "ndviNIR": nir_band_idx,
            "ndviRed": red_band_idx,
            "zonal": False,
            "zonal_layer_id": "",
        }

        # Match project ID from data product's URL
        match = re.search(r"/projects/([a-f0-9\-]+)/", self.url)

        # Extract matched project ID
        if match:
            project_id = match.group(1)
        else:
            print("Unable to find project ID associated with data product")
            return False

        # Prepare endpoint for post request
        endpoint = f"/api/v1/projects/{project_id}/flights/{self.flight_id}"
        endpoint += f"/data_products/{self.id}/tools"

        # post form data
        self.client.make_post_request(endpoint, json=data)

        print("Job request has been added to the queue")

        return True

    def derive_exg(
        self, red_band_idx: int, green_band_idx: int, blue_band_idx: int
    ) -> bool:
        """Use data product's bands to derive a new Excess Green Index data product.
        Must provide the red, green, and blue band indexes.

        Args:
            red_band_idx (int): Red band index.
            green_band_idx (int): Green band index.
            blue_band_idx (int): Blue band index.

        Returns:
            bool: True if the job was added to the queue, otherwise False.
        """
        # Check if this is a raster data product
        if self.data_type == "point_cloud":
            print("Not available for point clouds")
            return False

        # Get band properties from STAC EO extension
        eo_properties = self.get_band_info()

        # Check if the data product has at least two bands
        if not isinstance(eo_properties, List) or len(eo_properties) < 3:
            print("Data product must have at least three bands - Red, Green, and Blue")
            print(eo_properties)
            return False

        # Reject if any of the band indexes are the same
        if len({red_band_idx, green_band_idx, blue_band_idx}) < 3:
            print("Each band index must be unique")

        # Reject if the red band is outside of the range of possible bands
        if red_band_idx + 1 > len(eo_properties) or red_band_idx < 1:
            print("Red band index outside the range of available bands")

        # Reject if the green band is outside of the range of possible bands
        if green_band_idx + 1 > len(eo_properties) or green_band_idx < 1:
            print("Green band index outside the range of available bands")

        # Reject if the blue band is outside of the range of possible bands
        if blue_band_idx + 1 > len(eo_properties) or blue_band_idx < 1:
            print("Blue band index outside the range of available bands")

        # Prepare payload for post request
        data = {
            "chm": False,
            "exg": True,
            "exgRed": red_band_idx,
            "exgGreen": green_band_idx,
            "exgBlue": blue_band_idx,
            "ndvi": False,
            "ndviNIR": 0,
            "ndviRed": 0,
            "zonal": False,
            "zonal_layer_id": "",
        }

        # Match project ID from data product's URL
        match = re.search(r"/projects/([a-f0-9\-]+)/", self.url)

        # Extract matched project ID
        if match:
            project_id = match.group(1)
        else:
            print("Unable to find project ID associated with data product")
            return False

        # Prepare endpoint for post request
        endpoint = f"/api/v1/projects/{project_id}/flights/{self.flight_id}"
        endpoint += f"/data_products/{self.id}/tools"

        # post form data
        self.client.make_post_request(endpoint, json=data)

        print("Job request has been added to the queue")

        return True

clip(geojson_feature, out_raster)

Clips data product by GeoJSON Polygon Feature.

Parameters:

Name Type Description Default
geojson_feature Dict[Any, Any]

GeoJSON Polygon Feature.

 required
out_raster str

Path for output raster.

 required

Returns:

Name Type Description
bool bool

True if successful. False if clip fails.
Source code in d2spy/models/data_product.py 
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
def clip(self, geojson_feature: Dict[Any, Any], out_raster: str) -> bool:
    """Clips data product by GeoJSON Polygon Feature.

    Args:
        geojson_feature (Dict[Any, Any]): GeoJSON Polygon Feature.
        out_raster (str): Path for output raster.

    Returns:
        bool: True if successful. False if clip fails.
    """
    if self.data_type == "point_cloud":
        print("Not available for point clouds")
        return False

    try:
        clip_by_mask(self.url, geojson_feature, out_raster)
        print("Raster clipped successfully")
        return True
    except RasterioIOError as e:
        if str(e) == "HTTP response code: 401":
            if os.environ.get("D2S_API_KEY"):
                try:
                    clip_by_mask(
                        self.url + "?API_KEY=" + os.environ["D2S_API_KEY"],
                        geojson_feature,
                        out_raster,
                    )
                    print("Raster clipped successfully")
                    return True
                except RasterioIOError as e2:
                    if str(e) == "HTTP response code: 401":
                        print("You do not have permission to access this raster")
                        return False
                    else:
                        raise e2
            else:
                print("Set the 'D2S_API_KEY' environment variable before clipping")
                return False
        else:
            raise e
    except Exception as e:
        print(f"Failed to clip raster: {e}")
        return False

derive_exg(red_band_idx, green_band_idx, blue_band_idx)

Use data product's bands to derive a new Excess Green Index data product. Must provide the red, green, and blue band indexes.

Parameters:

Name Type Description Default
red_band_idx int

Red band index.

 required
green_band_idx int

Green band index.

 required
blue_band_idx int

Blue band index.

 required

Returns:

Name Type Description
bool bool

True if the job was added to the queue, otherwise False.
Source code in d2spy/models/data_product.py 
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
def derive_exg(
    self, red_band_idx: int, green_band_idx: int, blue_band_idx: int
) -> bool:
    """Use data product's bands to derive a new Excess Green Index data product.
    Must provide the red, green, and blue band indexes.

    Args:
        red_band_idx (int): Red band index.
        green_band_idx (int): Green band index.
        blue_band_idx (int): Blue band index.

    Returns:
        bool: True if the job was added to the queue, otherwise False.
    """
    # Check if this is a raster data product
    if self.data_type == "point_cloud":
        print("Not available for point clouds")
        return False

    # Get band properties from STAC EO extension
    eo_properties = self.get_band_info()

    # Check if the data product has at least two bands
    if not isinstance(eo_properties, List) or len(eo_properties) < 3:
        print("Data product must have at least three bands - Red, Green, and Blue")
        print(eo_properties)
        return False

    # Reject if any of the band indexes are the same
    if len({red_band_idx, green_band_idx, blue_band_idx}) < 3:
        print("Each band index must be unique")

    # Reject if the red band is outside of the range of possible bands
    if red_band_idx + 1 > len(eo_properties) or red_band_idx < 1:
        print("Red band index outside the range of available bands")

    # Reject if the green band is outside of the range of possible bands
    if green_band_idx + 1 > len(eo_properties) or green_band_idx < 1:
        print("Green band index outside the range of available bands")

    # Reject if the blue band is outside of the range of possible bands
    if blue_band_idx + 1 > len(eo_properties) or blue_band_idx < 1:
        print("Blue band index outside the range of available bands")

    # Prepare payload for post request
    data = {
        "chm": False,
        "exg": True,
        "exgRed": red_band_idx,
        "exgGreen": green_band_idx,
        "exgBlue": blue_band_idx,
        "ndvi": False,
        "ndviNIR": 0,
        "ndviRed": 0,
        "zonal": False,
        "zonal_layer_id": "",
    }

    # Match project ID from data product's URL
    match = re.search(r"/projects/([a-f0-9\-]+)/", self.url)

    # Extract matched project ID
    if match:
        project_id = match.group(1)
    else:
        print("Unable to find project ID associated with data product")
        return False

    # Prepare endpoint for post request
    endpoint = f"/api/v1/projects/{project_id}/flights/{self.flight_id}"
    endpoint += f"/data_products/{self.id}/tools"

    # post form data
    self.client.make_post_request(endpoint, json=data)

    print("Job request has been added to the queue")

    return True

derive_ndvi(red_band_idx, nir_band_idx)

Use data product's bands to derive a new NDVI data product. Must provide the red and NIR band indexes.

Parameters:

Name Type Description Default
red_band_idx int

Red band index.

 required
nir_band_idx int

NIR band index.

 required

Returns:

Name Type Description
bool bool

True if the job was added to the queue, otherwise False.
Source code in d2spy/models/data_product.py 
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
def derive_ndvi(self, red_band_idx: int, nir_band_idx: int) -> bool:
    """Use data product's bands to derive a new NDVI data product. Must provide
    the red and NIR band indexes.

    Args:
        red_band_idx (int): Red band index.
        nir_band_idx (int): NIR band index.

    Returns:
        bool: True if the job was added to the queue, otherwise False.
    """
    # Check if this is a raster data product
    if self.data_type == "point_cloud":
        print("Not available for point clouds")
        return False

    # Get band properties from STAC EO extension
    eo_properties = self.get_band_info()

    # Check if the data product has at least two bands
    if not isinstance(eo_properties, List) or len(eo_properties) < 2:
        print("Data product must have at least two bands - Red and NIR")
        print(eo_properties)
        return False

    # Reject if the red band index and NIR band index are the same
    if red_band_idx == nir_band_idx:
        print("Red band index and NIR band index cannot be the same")

    # Reject if the red band is outside of the range of possible bands
    if red_band_idx + 1 > len(eo_properties) or red_band_idx < 1:
        print("Red band index outside the range of available bands")

    # Reject if the NIR band is outside of the range of possible bands
    if nir_band_idx + 1 > len(eo_properties) or nir_band_idx < 1:
        print("NIR band index outside the range of available bands")

    # Prepare payload for post request
    data = {
        "chm": False,
        "exg": False,
        "exgRed": 0,
        "exgGreen": 0,
        "exgBlue": 0,
        "ndvi": True,
        "ndviNIR": nir_band_idx,
        "ndviRed": red_band_idx,
        "zonal": False,
        "zonal_layer_id": "",
    }

    # Match project ID from data product's URL
    match = re.search(r"/projects/([a-f0-9\-]+)/", self.url)

    # Extract matched project ID
    if match:
        project_id = match.group(1)
    else:
        print("Unable to find project ID associated with data product")
        return False

    # Prepare endpoint for post request
    endpoint = f"/api/v1/projects/{project_id}/flights/{self.flight_id}"
    endpoint += f"/data_products/{self.id}/tools"

    # post form data
    self.client.make_post_request(endpoint, json=data)

    print("Job request has been added to the queue")

    return True

get_band_info()

Return STAC Electro-Optical bands information.

Returns:

Type Description
Optional[List[STACEOProperties]]

Optional[List[STACEOProperties]]: description
Source code in d2spy/models/data_product.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def get_band_info(self) -> Optional[List[STACEOProperties]]:
    """Return STAC Electro-Optical bands information.

    Returns:
        Optional[List[STACEOProperties]]: _description_
    """
    if self.data_type == "point_cloud":
        print("Point cloud does not have band info")
        return None

    if not self.stac_properties.get("eo"):
        print("Missing band properties")
        return None

    eo_properties = self.stac_properties["eo"]

    if not isinstance(eo_properties, List):
        print("Band properties in unexpected format")
        return None

    return eo_properties