Skip to content

image_compression

ImageCompression

Bases: ImageOnlyAlbumentation

Decrease compression of an image.

Parameters:

Name Type Description Default
inputs Union[str, Iterable[str]]

Key(s) of images to be modified.

 required
outputs Union[str, Iterable[str]]

Key(s) into which to write the modified images.

 required
mode Union[None, str, Iterable[str]]

What mode(s) to execute this Op in. For example, "train", "eval", "test", or "infer". To execute regardless of mode, pass None. To execute in all modes except for a particular one, you can pass an argument like "!infer" or "!train".

 None
ds_id Union[None, str, Iterable[str]]

What dataset id(s) to execute this Op in. To execute regardless of ds_id, pass None. To execute in all ds_ids except for a particular one, you can pass an argument like "!ds1".

 None
quality_lower float

Lower bound on the image quality. Should be in [0, 100] range for jpeg and [1, 100] for webp.

 99
quality_upper float

Upper bound on the image quality. Should be in [0, 100] range for jpeg and [1, 100] for webp.

 100
compression_type ImageCompressionType

should be ImageCompressionType.JPEG or ImageCompressionType.WEBP.

 JPEG
Image types

uint8, float32

Source code in fastestimator/fastestimator/op/numpyop/univariate/image_compression.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
@traceable()
class ImageCompression(ImageOnlyAlbumentation):
    """Decrease compression of an image.

    Args:
        inputs: Key(s) of images to be modified.
        outputs: Key(s) into which to write the modified images.
        mode: What mode(s) to execute this Op in. For example, "train", "eval", "test", or "infer". To execute
            regardless of mode, pass None. To execute in all modes except for a particular one, you can pass an argument
            like "!infer" or "!train".
        ds_id: What dataset id(s) to execute this Op in. To execute regardless of ds_id, pass None. To execute in all
            ds_ids except for a particular one, you can pass an argument like "!ds1".
        quality_lower: Lower bound on the image quality. Should be in [0, 100] range for jpeg and [1, 100] for webp.
        quality_upper: Upper bound on the image quality. Should be in [0, 100] range for jpeg and [1, 100] for webp.
        compression_type: should be ImageCompressionType.JPEG or ImageCompressionType.WEBP.

    Image types:
        uint8, float32
    """
    def __init__(self,
                 inputs: Union[str, Iterable[str]],
                 outputs: Union[str, Iterable[str]],
                 mode: Union[None, str, Iterable[str]] = None,
                 ds_id: Union[None, str, Iterable[str]] = None,
                 quality_lower: float = 99,
                 quality_upper: float = 100,
                 compression_type: ImgCmpAlb.ImageCompressionType = ImgCmpAlb.ImageCompressionType.JPEG):
        super().__init__(
            ImgCmpAlb(quality_lower=quality_lower,
                      quality_upper=quality_upper,
                      compression_type=compression_type,
                      always_apply=True),
            inputs=inputs,
            outputs=outputs,
            mode=mode,
            ds_id=ds_id)