fiftyone.utils.patches

module documentation

(source)

Image patch utilities.

Class	`ImagePatchesExtractor`	Class for iterating over the labeled/unlabeled image patches in a collection.
Function	`extract_patch`	Extracts the patch from the image.
Function	`parse_patches`	Parses the patches from the given document.
Function	`_load_image`	Undocumented
Function	`_to_classification`	Undocumented

def extract_patch(img, detection, force_square=False, alpha=None): (source) ¶

Extracts the patch from the image.

Parameters
img	a numpy image array
detection	a `fiftyone.core.labels.Detection` defining the patch
force_square:`False`	whether to minimally manipulate the patch bounding box into a square prior to extraction
alpha:`None`	an optional expansion/contraction to apply to the patch before extracting it, in `[-1, inf)`. If provided, the length and width of the box are expanded (or contracted, when `alpha < 0`) by `(100 * alpha)%`. For example, set `alpha = 0.1` to expand the box by 10%, and set `alpha = -0.1` to contract the box by 10%
Returns
the image patch

def parse_patches(doc, patches_field, handle_missing='skip'): (source) ¶

Parses the patches from the given document.

Parameters
doc	Undocumented
patches_field	the name of the field defining the image patches. Must be of type `fiftyone.core.labels.Detection`, `fiftyone.core.labels.Detections`, `fiftyone.core.labels.Polyline`, or `fiftyone.core.labels.Polylines`
handle_missing:"skip"	how to handle documents with no patches. Supported values are: "skip": skip the document and return `None` "image": use the whole image as a single patch "error": raise an error
Returns
a `fiftyone.core.labels.Detections` instance, or `None`

def _load_image(image_path, force_rgb=False): (source) ¶

Undocumented

def _to_classification(label): (source) ¶

Undocumented