SemanticSegmentationLabelSourceConfig#

Note

All Configs are derived from rastervision.pipeline.config.Config, which itself is a pydantic Model.

pydantic model SemanticSegmentationLabelSourceConfig[source]#

Configure a SemanticSegmentationLabelSource.

Show JSON schema
{
   "title": "SemanticSegmentationLabelSourceConfig",
   "description": "Configure a :class:`.SemanticSegmentationLabelSource`.",
   "type": "object",
   "properties": {
      "type_hint": {
         "title": "Type Hint",
         "default": "semantic_segmentation_label_source",
         "enum": [
            "semantic_segmentation_label_source"
         ],
         "type": "string"
      },
      "raster_source": {
         "title": "Raster Source",
         "description": "The labels in the form of rasters.",
         "anyOf": [
            {
               "$ref": "#/definitions/RasterSourceConfig"
            },
            {
               "$ref": "#/definitions/RasterizedSourceConfig"
            }
         ]
      }
   },
   "required": [
      "raster_source"
   ],
   "additionalProperties": false,
   "definitions": {
      "RasterTransformerConfig": {
         "title": "RasterTransformerConfig",
         "description": "Configure a :class:`.RasterTransformer`.",
         "type": "object",
         "properties": {
            "type_hint": {
               "title": "Type Hint",
               "default": "raster_transformer",
               "enum": [
                  "raster_transformer"
               ],
               "type": "string"
            }
         },
         "additionalProperties": false
      },
      "RasterSourceConfig": {
         "title": "RasterSourceConfig",
         "description": "Configure a :class:`.RasterSource`.",
         "type": "object",
         "properties": {
            "channel_order": {
               "title": "Channel Order",
               "description": "The sequence of channel indices to use when reading imagery.",
               "type": "array",
               "items": {
                  "type": "integer"
               }
            },
            "transformers": {
               "title": "Transformers",
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/RasterTransformerConfig"
               }
            },
            "bbox": {
               "title": "Bbox",
               "description": "User-specified bbox in pixel coords in the form (ymin, xmin, ymax, xmax). Useful for cropping the raster source so that only part of the raster is read from.",
               "type": "array",
               "minItems": 4,
               "maxItems": 4,
               "items": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "integer"
                  },
                  {
                     "type": "integer"
                  },
                  {
                     "type": "integer"
                  }
               ]
            },
            "type_hint": {
               "title": "Type Hint",
               "default": "raster_source",
               "enum": [
                  "raster_source"
               ],
               "type": "string"
            }
         },
         "additionalProperties": false
      },
      "VectorTransformerConfig": {
         "title": "VectorTransformerConfig",
         "description": "Configure a :class:`.VectorTransformer`.",
         "type": "object",
         "properties": {
            "type_hint": {
               "title": "Type Hint",
               "default": "vector_transformer",
               "enum": [
                  "vector_transformer"
               ],
               "type": "string"
            }
         },
         "additionalProperties": false
      },
      "VectorSourceConfig": {
         "title": "VectorSourceConfig",
         "description": "Configure a :class:`.VectorSource`.",
         "type": "object",
         "properties": {
            "transformers": {
               "title": "Transformers",
               "description": "List of VectorTransformers.",
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/VectorTransformerConfig"
               }
            },
            "type_hint": {
               "title": "Type Hint",
               "default": "vector_source",
               "enum": [
                  "vector_source"
               ],
               "type": "string"
            }
         },
         "additionalProperties": false
      },
      "RasterizerConfig": {
         "title": "RasterizerConfig",
         "description": "Configure rasterization params for a :class:`.RasterizedSource`.",
         "type": "object",
         "properties": {
            "background_class_id": {
               "title": "Background Class Id",
               "description": "The class_id to use for any background pixels, i.e. pixels not covered by a polygon.",
               "type": "integer"
            },
            "all_touched": {
               "title": "All Touched",
               "description": "If True, all pixels touched by geometries will be burned in. If false, only pixels whose center is within the polygon or that are selected by Bresenham's line algorithm will be burned in. (See rasterio.features.rasterize for more details).",
               "default": false,
               "type": "boolean"
            },
            "type_hint": {
               "title": "Type Hint",
               "default": "rasterizer",
               "enum": [
                  "rasterizer"
               ],
               "type": "string"
            }
         },
         "required": [
            "background_class_id"
         ],
         "additionalProperties": false
      },
      "RasterizedSourceConfig": {
         "title": "RasterizedSourceConfig",
         "description": "Configure a :class:`.RasterizedSource`.",
         "type": "object",
         "properties": {
            "vector_source": {
               "$ref": "#/definitions/VectorSourceConfig"
            },
            "rasterizer_config": {
               "$ref": "#/definitions/RasterizerConfig"
            },
            "type_hint": {
               "title": "Type Hint",
               "default": "rasterized_source",
               "enum": [
                  "rasterized_source"
               ],
               "type": "string"
            }
         },
         "required": [
            "vector_source",
            "rasterizer_config"
         ],
         "additionalProperties": false
      }
   }
}

Config
  • extra: str = forbid

  • validate_assignment: bool = True

Fields
field raster_source: Union[RasterSourceConfig, RasterizedSourceConfig] [Required]#

The labels in the form of rasters.

field type_hint: Literal['semantic_segmentation_label_source'] = 'semantic_segmentation_label_source'#
build(class_config, crs_transformer, bbox=None, tmp_dir=None) SemanticSegmentationLabelSource[source]#

Build an instance of the corresponding type of object using this config.

For example, BackendConfig will build a Backend object. The arguments to this method will vary depending on the type of Config.

Return type

SemanticSegmentationLabelSource

classmethod from_file(uri: str) Config#

Deserialize a Config from a JSON file, upgrading if possible.

Parameters

uri (str) – URI to load from.

Return type

Config

recursive_validate_config()#

Recursively validate hierarchies of Configs.

This uses reflection to call validate_config on a hierarchy of Configs using a depth-first pre-order traversal.

revalidate()#

Re-validate an instantiated Config.

Runs all Pydantic validators plus self.validate_config().

Adapted from: https://github.com/samuelcolvin/pydantic/issues/1864#issuecomment-679044432

to_file(uri: str, with_rv_metadata: bool = True) None#

Save a Config to a JSON file, optionally with RV metadata.

Parameters
  • uri (str) – URI to save to.

  • with_rv_metadata (bool) – If True, inject Raster Vision metadata such as plugin_versions, so that the config can be upgraded when loaded.

Return type

None

update(pipeline: Optional[RVPipelineConfig] = None, scene: Optional[SceneConfig] = None) None#

Update any fields before validation.

Subclasses should override this to provide complex default behavior, for example, setting default values as a function of the values of other fields. The arguments to this method will vary depending on the type of Config.

Parameters
Return type

None

validate_config()#

Validate fields that should be checked after update is called.

This is to complement the builtin validation that Pydantic performs at the time of object construction.

validate_list(field: str, valid_options: List[str])#

Validate a list field.

Parameters
  • field (str) – name of field to validate

  • valid_options (List[str]) – values that field is allowed to take

Raises

ConfigError – if field is invalid