RasterizerConfig#

Note

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

pydantic model RasterizerConfig[source]#

Configure rasterization params for a RasterizedSource.

Show JSON schema

{
   "title": "RasterizerConfig",
   "description": "Configure rasterization params for a :class:`.RasterizedSource`.",
   "type": "object",
   "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"
      }
   },
   "additionalProperties": false,
   "required": [
      "background_class_id"
   ]
}

Config:

extra: str = forbid
validate_assignment: bool = True

Fields:

all_touched (bool)
background_class_id (int)
type_hint (Literal['rasterizer'])

field all_touched: bool = False#: 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).

field background_class_id: int [Required]#: The class_id to use for any background pixels, i.e. pixels not covered by a polygon.

field type_hint: Literal['rasterizer'] = 'rasterizer'#

build()#

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.

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(*args, **kwargs)#

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.

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