ObjectDetectionChipOptions#

Note

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

pydantic model ObjectDetectionChipOptions[source]#

Show JSON schema

{
   "title": "ObjectDetectionChipOptions",
   "type": "object",
   "properties": {
      "sampling": {
         "$ref": "#/$defs/ObjectDetectionWindowSamplingConfig",
         "description": "Window sampling config."
      },
      "nodata_threshold": {
         "default": 1.0,
         "description": "Discard chips where the proportion of NODATA values is greater than or equal to this value. Might result in false positives if there are many legitimate black pixels in the chip. Use with caution. If 1.0, only chips that are fully NODATA will be discarded. Defaults to 1.0.",
         "maximum": 1.0,
         "minimum": 0.0,
         "title": "Nodata Threshold",
         "type": "number"
      },
      "type_hint": {
         "const": "object_detection_chip_options",
         "default": "object_detection_chip_options",
         "title": "Type Hint",
         "type": "string"
      }
   },
   "$defs": {
      "ObjectDetectionWindowSamplingConfig": {
         "additionalProperties": false,
         "properties": {
            "method": {
               "$ref": "#/$defs/WindowSamplingMethod",
               "default": "sliding",
               "description": ""
            },
            "size": {
               "anyOf": [
                  {
                     "exclusiveMinimum": 0,
                     "type": "integer"
                  },
                  {
                     "maxItems": 2,
                     "minItems": 2,
                     "prefixItems": [
                        {
                           "exclusiveMinimum": 0,
                           "type": "integer"
                        },
                        {
                           "exclusiveMinimum": 0,
                           "type": "integer"
                        }
                     ],
                     "type": "array"
                  }
               ],
               "description": "If method = sliding, this is the size of sliding window. If method = random, this is the size that all the windows are resized to before they are returned. If method = random and neither size_lims nor h_lims and w_lims have been specified, then size_lims is set to (size, size + 1).",
               "title": "Size"
            },
            "stride": {
               "anyOf": [
                  {
                     "exclusiveMinimum": 0,
                     "type": "integer"
                  },
                  {
                     "maxItems": 2,
                     "minItems": 2,
                     "prefixItems": [
                        {
                           "exclusiveMinimum": 0,
                           "type": "integer"
                        },
                        {
                           "exclusiveMinimum": 0,
                           "type": "integer"
                        }
                     ],
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Stride of sliding window. Only used if method = sliding.",
               "title": "Stride"
            },
            "padding": {
               "anyOf": [
                  {
                     "minimum": 0,
                     "type": "integer"
                  },
                  {
                     "maxItems": 2,
                     "minItems": 2,
                     "prefixItems": [
                        {
                           "minimum": 0,
                           "type": "integer"
                        },
                        {
                           "minimum": 0,
                           "type": "integer"
                        }
                     ],
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "How many pixels are windows allowed to overflow the edges of the raster source.",
               "title": "Padding"
            },
            "pad_direction": {
               "default": "end",
               "description": "If \"end\", only pad ymax and xmax (bottom and right). If \"start\", only pad ymin and xmin (top and left). If \"both\", pad all sides. Has no effect if padding is zero. Defaults to \"end\".",
               "enum": [
                  "both",
                  "start",
                  "end"
               ],
               "title": "Pad Direction",
               "type": "string"
            },
            "size_lims": {
               "anyOf": [
                  {
                     "maxItems": 2,
                     "minItems": 2,
                     "prefixItems": [
                        {
                           "exclusiveMinimum": 0,
                           "type": "integer"
                        },
                        {
                           "exclusiveMinimum": 0,
                           "type": "integer"
                        }
                     ],
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "[min, max) interval from which window sizes will be uniformly randomly sampled. The upper limit is exclusive. To fix the size to a constant value, use size_lims = (sz, sz + 1). Only used if method = random. Specify either size_lims or h_lims and w_lims, but not both. If neither size_lims nor h_lims and w_lims have been specified, then this will be set to (size, size + 1).",
               "title": "Size Lims"
            },
            "h_lims": {
               "anyOf": [
                  {
                     "maxItems": 2,
                     "minItems": 2,
                     "prefixItems": [
                        {
                           "exclusiveMinimum": 0,
                           "type": "integer"
                        },
                        {
                           "exclusiveMinimum": 0,
                           "type": "integer"
                        }
                     ],
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "[min, max] interval from which window heights will be uniformly randomly sampled. Only used if method = random.",
               "title": "H Lims"
            },
            "w_lims": {
               "anyOf": [
                  {
                     "maxItems": 2,
                     "minItems": 2,
                     "prefixItems": [
                        {
                           "exclusiveMinimum": 0,
                           "type": "integer"
                        },
                        {
                           "exclusiveMinimum": 0,
                           "type": "integer"
                        }
                     ],
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "[min, max] interval from which window widths will be uniformly randomly sampled. Only used if method = random.",
               "title": "W Lims"
            },
            "max_windows": {
               "default": 10000,
               "description": "Max number of windows to sample. Only used if method = random.",
               "minimum": 0,
               "title": "Max Windows",
               "type": "integer"
            },
            "max_sample_attempts": {
               "default": 100,
               "description": "Max attempts when trying to find a window within the AOI of a scene. Only used if method = random and the scene has aoi_polygons specified.",
               "exclusiveMinimum": 0,
               "title": "Max Sample Attempts",
               "type": "integer"
            },
            "efficient_aoi_sampling": {
               "default": true,
               "description": "If the scene has AOIs, sampling windows at random anywhere in the extent and then checking if they fall within any of the AOIs can be very inefficient. This flag enables the use of an alternate algorithm that only samples window locations inside the AOIs. Only used if method = random and the scene has aoi_polygons specified. Defaults to True",
               "title": "Efficient Aoi Sampling",
               "type": "boolean"
            },
            "within_aoi": {
               "default": true,
               "description": "If True and if the scene has an AOI, only sample windows that lie fully within the AOI. If False, windows only partially intersecting the AOI will also be allowed.",
               "title": "Within Aoi",
               "type": "boolean"
            },
            "type_hint": {
               "const": "object_detection_window_sampling",
               "default": "object_detection_window_sampling",
               "title": "Type Hint",
               "type": "string"
            },
            "ioa_thresh": {
               "default": 0.8,
               "description": "When a box is partially outside of a training chip, it is not clear if (a clipped version) of the box should be included in the chip. If the IOA (intersection over area) of the box with the chip is greater than ioa_thresh, it is included in the chip. Defaults to 0.8.",
               "title": "Ioa Thresh",
               "type": "number"
            },
            "clip": {
               "default": false,
               "description": "Clip bounding boxes to window limits when retrieving labels for a window.",
               "title": "Clip",
               "type": "boolean"
            },
            "neg_ratio": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ratio of negative chips (those containing no bounding boxes) to positive chips. This can be useful if the statistics of the background is different in positive chips. For example, in car detection, the positive chips will always contain roads, but no examples of rooftops since cars tend to not be near rooftops. Defaults to None.",
               "title": "Neg Ratio"
            },
            "neg_ioa_thresh": {
               "default": 0.2,
               "description": "A window will be considered negative if its max IoA with any bounding box is less than this threshold. Defaults to 0.2.",
               "title": "Neg Ioa Thresh",
               "type": "number"
            }
         },
         "required": [
            "size"
         ],
         "title": "ObjectDetectionWindowSamplingConfig",
         "type": "object"
      },
      "WindowSamplingMethod": {
         "description": "Enum for window sampling methods.\n\nAttributes:\n    sliding: Sliding windows.\n    random: Randomly sampled windows.",
         "enum": [
            "sliding",
            "random"
         ],
         "title": "WindowSamplingMethod",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "sampling"
   ]
}

Config:

extra: str = forbid
validate_assignment: bool = True

Fields:

nodata_threshold ()
sampling ()
type_hint (Literal['object_detection_chip_options'])

field nodata_threshold: Proportion = 1.0#

Discard chips where the proportion of NODATA values is greater than or equal to this value. Might result in false positives if there are many legitimate black pixels in the chip. Use with caution. If 1.0, only chips that are fully NODATA will be discarded. Defaults to 1.0.

Constraints:

ge = 0
le = 1

field sampling: ObjectDetectionWindowSamplingConfig [Required]#: Window sampling config.

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

build()#

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.

classmethod deserialize(inp: str | dict | Config) → Self#

Deserialize Config from a JSON file or dict, upgrading if possible.

If inp is already a Config, it is returned as is.

Parameters:: inp (str | dict | Config) – a URI to a JSON file or a dict.
Return type:: Self

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

get_chip_sz(scene_id: str | None = None) → int#

Parameters:: scene_id (str | None) –
Return type:: int

keep_chip(chip: ndarray, label: Any) → bool#

Decide whether to keep or discard chip.

Parameters:

chip (ndarray) – Chip raster.
label (Any) – Associated label.

Return type:

bool

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().

to_file(uri: str, with_rv_metadata: bool = True) → None#

Save a Config to a JSON file, optionally with RV metadata.

Parameters:

uri (str) – URI to save to.
with_rv_metadata (bool) – If True, inject Raster Vision metadata such as plugin_versions, so that the config can be upgraded when loaded.

Return type:

None

update(*args, **kwargs)#

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.

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