make_od_scene#

make_od_scene(image_uri: str | list[str], label_vector_uri: str | None = None, class_config: ClassConfig | None = None, aoi_uri: str | list[str] = [], label_vector_default_class_id: int | None = None, image_raster_source_kw: dict = {}, label_vector_source_kw: dict = {}, label_source_kw: dict = {}, scene_id: str | None = None) → Scene[source]#

Create an object detection scene from image and label URIs.

This is a convenience method. For more fine-grained control, it is recommended to use the default constructor.

Parameters:

  • image_uri (str | list[str]) – URI or list of URIs of GeoTIFFs to use as the source of image data.

  • label_vector_uri (str | None) – URI of GeoJSON file to use as the source of label. Defaults to None.

  • class_config (ClassConfig | None) – The ClassConfig. Must be non-None if creating a scene without a LabelSource. Defaults to None.

  • aoi_uri (str | list[str]) – URI or list of URIs of GeoJSONs that specify the area-of-interest. If provided, the dataset will only access data from this area. Defaults to [].

  • label_vector_default_class_id (int | None) – If using label_vector_uri and all polygons in that file belong to the same class and they do not contain a class_id property, then use this argument to map all of the polygons to the appropriate class ID. See docs for ClassInferenceTransformer for more details. Defaults to None.

  • image_raster_source_kw (dict) – Additional arguments to pass to the RasterioSource used for image data. See docs for RasterioSource for more details. Defaults to {}.

  • label_vector_source_kw (dict) – Additional arguments to pass to the GeoJSONVectorSourceConfig used for label data, if label_vector_uri is set. See docs for GeoJSONVectorSourceConfig for more details. Defaults to {}.

  • label_source_kw (dict) – Additional arguments to pass to the ObjectDetectionLabelSourceConfig used for label data, if label_vector_uri is set. See docs for ObjectDetectionLabelSourceConfig for more details. Defaults to {}.

  • scene_id (str | None) – Optional scene ID. If None, will be randomly generated. Defaults to None.

Returns:

An object detection scene.

Return type:

Scene