RasterizedSourceConfig#
Note
All Configs are derived from rastervision.pipeline.config.Config
, which itself is a pydantic Model.
- pydantic model RasterizedSourceConfig[source]#
Configure a
RasterizedSource
.Show JSON schema
{ "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, "definitions": { "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 } } }
- Config
extra: str = forbid
validate_assignment: bool = True
- Fields
- Validators
- field rasterizer_config: RasterizerConfig [Required]#
- field vector_source: VectorSourceConfig [Required]#
- Validated by
- build(class_config, crs_transformer, extent)[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.
- validator ensure_required_transformers » vector_source[source]#
Add class-inference and buffer transformers if absent.
- Parameters
v (VectorSourceConfig) –
- Return type
- 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
- update(pipeline=None, scene=None)[source]#
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.