SemanticSegmentationLabelSourceConfig

Note

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

pydantic model SemanticSegmentationLabelSourceConfig

Configure a SemanticSegmentationLabelSource.

Show JSON schema

{
   "title": "SemanticSegmentationLabelSourceConfig",
   "description": "Configure a :class:`.SemanticSegmentationLabelSource`.",
   "type": "object",
   "properties": {
      "type_hint": {
         "const": "semantic_segmentation_label_source",
         "default": "semantic_segmentation_label_source",
         "enum": [
            "semantic_segmentation_label_source"
         ],
         "title": "Type Hint",
         "type": "string"
      },
      "raster_source": {
         "anyOf": [
            {
               "$ref": "#/$defs/RasterSourceConfig"
            },
            {
               "$ref": "#/$defs/RasterizedSourceConfig"
            }
         ],
         "description": "The labels in the form of rasters.",
         "title": "Raster Source"
      }
   },
   "$defs": {
      "RasterSourceConfig": {
         "additionalProperties": false,
         "description": "Configure a :class:`.RasterSource`.",
         "properties": {
            "channel_order": {
               "anyOf": [
                  {
                     "items": {
                        "type": "integer"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The sequence of channel indices to use when reading imagery.",
               "title": "Channel Order"
            },
            "transformers": {
               "default": [],
               "items": {
                  "$ref": "#/$defs/RasterTransformerConfig"
               },
               "title": "Transformers",
               "type": "array"
            },
            "bbox": {
               "anyOf": [
                  {
                     "maxItems": 4,
                     "minItems": 4,
                     "prefixItems": [
                        {
                           "type": "integer"
                        },
                        {
                           "type": "integer"
                        },
                        {
                           "type": "integer"
                        },
                        {
                           "type": "integer"
                        }
                     ],
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "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.",
               "title": "Bbox"
            },
            "type_hint": {
               "const": "raster_source",
               "default": "raster_source",
               "enum": [
                  "raster_source"
               ],
               "title": "Type Hint",
               "type": "string"
            }
         },
         "title": "RasterSourceConfig",
         "type": "object"
      },
      "RasterTransformerConfig": {
         "additionalProperties": false,
         "description": "Configure a :class:`.RasterTransformer`.",
         "properties": {
            "type_hint": {
               "const": "raster_transformer",
               "default": "raster_transformer",
               "enum": [
                  "raster_transformer"
               ],
               "title": "Type Hint",
               "type": "string"
            }
         },
         "title": "RasterTransformerConfig",
         "type": "object"
      },
      "RasterizedSourceConfig": {
         "additionalProperties": false,
         "description": "Configure a :class:`.RasterizedSource`.",
         "properties": {
            "vector_source": {
               "$ref": "#/$defs/VectorSourceConfig"
            },
            "rasterizer_config": {
               "$ref": "#/$defs/RasterizerConfig"
            },
            "type_hint": {
               "const": "rasterized_source",
               "default": "rasterized_source",
               "enum": [
                  "rasterized_source"
               ],
               "title": "Type Hint",
               "type": "string"
            }
         },
         "required": [
            "vector_source",
            "rasterizer_config"
         ],
         "title": "RasterizedSourceConfig",
         "type": "object"
      },
      "RasterizerConfig": {
         "additionalProperties": false,
         "description": "Configure rasterization params for a :class:`.RasterizedSource`.",
         "properties": {
            "background_class_id": {
               "description": "The class_id to use for any background pixels, i.e. pixels not covered by a polygon.",
               "title": "Background Class Id",
               "type": "integer"
            },
            "all_touched": {
               "default": false,
               "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).",
               "title": "All Touched",
               "type": "boolean"
            },
            "type_hint": {
               "const": "rasterizer",
               "default": "rasterizer",
               "enum": [
                  "rasterizer"
               ],
               "title": "Type Hint",
               "type": "string"
            }
         },
         "required": [
            "background_class_id"
         ],
         "title": "RasterizerConfig",
         "type": "object"
      },
      "VectorSourceConfig": {
         "additionalProperties": false,
         "description": "Configure a :class:`.VectorSource`.",
         "properties": {
            "transformers": {
               "default": [],
               "description": "List of VectorTransformers.",
               "items": {
                  "$ref": "#/$defs/VectorTransformerConfig"
               },
               "title": "Transformers",
               "type": "array"
            },
            "type_hint": {
               "const": "vector_source",
               "default": "vector_source",
               "enum": [
                  "vector_source"
               ],
               "title": "Type Hint",
               "type": "string"
            }
         },
         "title": "VectorSourceConfig",
         "type": "object"
      },
      "VectorTransformerConfig": {
         "additionalProperties": false,
         "description": "Configure a :class:`.VectorTransformer`.",
         "properties": {
            "type_hint": {
               "const": "vector_transformer",
               "default": "vector_transformer",
               "enum": [
                  "vector_transformer"
               ],
               "title": "Type Hint",
               "type": "string"
            }
         },
         "title": "VectorTransformerConfig",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "raster_source"
   ]
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

Fields:

• raster_source ()

• type_hint (Literal['semantic_segmentation_label_source'])

field raster_source: 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

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 deserialize(inp: str | dict | Config) → Self

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

If inp is already a Config, it is returned as is.

Parameters:

inp (str | dict | Config) – a URI to a JSON file or a dict.

Return type:

Self

classmethod from_dict(cfg_dict: dict) → Self

Deserialize Config from a dict.

Parameters:

cfg_dict (dict) – Dict to deserialize.

Return type:

Self

classmethod from_file(uri: str) → Self

Deserialize Config from a JSON file, upgrading if possible.

Parameters:

uri (str) – URI to load from.

Return type:

Self

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().

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: RVPipelineConfig | None = None, scene: SceneConfig | None = 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:

• pipeline (RVPipelineConfig | None) –

• scene (SceneConfig | None) –

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