AugmentationResult#

class augraphy.base.augmentationresult.AugmentationResult(augmentation, result, mask=None, keypoints=None, bounding_boxes=None, metadata=None)[source]#

Bases: object

Contains the result of an Augmentation’s application, as well as the Augmentation applied. AugmentationResults are stored in an AugmentationPipeline.

Parameters:

augmentation (object) – The augmentation that was applied.
result (object) – The image transformed by the augmentation. Usually a numpy array.
mask (numpy array (uint8), optional) – The mask of labels for each pixel. Mask value should be in range of 0 to 255.
keypoints (dictionary, optional) – A dictionary of single or multiple labels where each label is a nested list of points coordinate (x, y).
bounding_boxes (list, optional) – A nested list where each nested list contains box location (x1, y1, x2, y2).
metadata (object, optional) – Additional data that may be added by callers.

Overview#

AugmentationResult is the base class to store the each augmentation outputs in the pipeline.