VectorSourceConfig#

Note

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

pydantic model VectorSourceConfig[source]#

Configure a VectorSource.

Show JSON schema
{
   "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,
   "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
      }
   }
}

Config
  • extra: str = forbid

  • validate_assignment: bool = True

Fields
field transformers: List[VectorTransformerConfig] = []#

List of VectorTransformers.

field type_hint: Literal['vector_source'] = 'vector_source'#
abstract build(class_config: ClassConfig, crs_transformer: CRSTransformer) VectorSource[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.

Parameters
Return type

VectorSource

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: Optional[RVPipelineConfig] = None, scene: Optional[SceneConfig] = None) 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.

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