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.
- 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
class_config (ClassConfig) –
crs_transformer (CRSTransformer) –
- Return type
- classmethod deserialize(inp: str | dict | Config) Self #
Deserialize Config from a JSON file or dict, upgrading if possible.
If
inp
is already aConfig
, it is returned as is.
- dict(with_rv_metadata: bool = False, **kwargs) dict #
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- 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().
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.
- 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
pipeline (Optional[RVPipelineConfig]) –
scene (Optional[SceneConfig]) –
- 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.