RasterSourceConfig#

Note

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

pydantic model RasterSourceConfig[source]#

Configure a RasterSource.

Show JSON schema

{
   "title": "RasterSourceConfig",
   "description": "Configure a :class:`.RasterSource`.",
   "type": "object",
   "properties": {
      "channel_order": {
         "title": "Channel Order",
         "description": "The sequence of channel indices to use when reading imagery.",
         "type": "array",
         "items": {
            "type": "integer"
         }
      },
      "transformers": {
         "title": "Transformers",
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/RasterTransformerConfig"
         }
      },
      "extent": {
         "title": "Extent",
         "description": "Use-specified extent 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.",
         "type": "array",
         "minItems": 4,
         "maxItems": 4,
         "items": [
            {
               "type": "integer"
            },
            {
               "type": "integer"
            },
            {
               "type": "integer"
            },
            {
               "type": "integer"
            }
         ]
      },
      "type_hint": {
         "title": "Type Hint",
         "default": "raster_source",
         "enum": [
            "raster_source"
         ],
         "type": "string"
      }
   },
   "additionalProperties": false,
   "definitions": {
      "RasterTransformerConfig": {
         "title": "RasterTransformerConfig",
         "description": "Configure a :class:`.RasterTransformer`.",
         "type": "object",
         "properties": {
            "type_hint": {
               "title": "Type Hint",
               "default": "raster_transformer",
               "enum": [
                  "raster_transformer"
               ],
               "type": "string"
            }
         },
         "additionalProperties": false
      }
   }
}

Config

extra: str = forbid
validate_assignment: bool = True

Fields

channel_order (Optional[List[int]])
extent (Optional[Tuple[int, int, int, int]])
transformers (List[rastervision.core.data.raster_transformer.raster_transformer_config.RasterTransformerConfig])
type_hint (Literal['raster_source'])

Validators

validate_extent » extent

field channel_order: Optional[List[int]] = None#: The sequence of channel indices to use when reading imagery.

field extent: Optional[Tuple[int, int, int, int]] = None#

Use-specified extent 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.

Validated by

validate_extent

field transformers: List[RasterTransformerConfig] = []#

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

build(tmp_dir, use_transformers=True)[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.

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.

validator validate_extent » extent[source]#

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