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

pydantic model ShiftTransformerConfig[source]#

Configure a ShiftTransformer.

Show JSON schema
   "title": "ShiftTransformerConfig",
   "description": "Configure a :class:`.ShiftTransformer`.",
   "type": "object",
   "properties": {
      "type_hint": {
         "title": "Type Hint",
         "default": "shift_transformer",
         "enum": [
         "type": "string"
      "x_shift": {
         "title": "X Shift",
         "default": 0.0,
         "descriptions": "Distance in meters to shift along the x-axis. Postive values shift eastward.",
         "type": "number"
      "y_shift": {
         "title": "Y Shift",
         "default": 0.0,
         "descriptions": "Distance in meters to shift along the y-axis. Postive values shift northward.",
         "type": "number"
      "round_pixels": {
         "title": "Round Pixels",
         "default": true,
         "descriptions": "Whether to round shifted pixel values to integers.",
         "type": "boolean"
   "additionalProperties": false

  • extra: str = forbid

  • validate_assignment: bool = True

field round_pixels: bool = True#
field type_hint: Literal['shift_transformer'] = 'shift_transformer'#
field x_shift: float = 0.0#
field y_shift: float = 0.0#
build(class_config: Optional[ClassConfig] = None) ShiftTransformer[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.


class_config (Optional[ClassConfig]) –

Return type



Recursively validate hierarchies of Configs.

This uses reflection to call validate_config on a hierarchy of Configs using a depth-first pre-order traversal.


Re-validate an instantiated Config.

Runs all Pydantic validators plus self.validate_config().

Adapted from:

update(pipeline: Optional[RVPipelineConfig] = None, scene: Optional[SceneConfig] = None) None#

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.

Return type



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.

  • field (str) – name of field to validate

  • valid_options (List[str]) – values that field is allowed to take


ConfigError – if field is invalid