Skip to content

translate_y

TranslateY

Bases: NumpyOp

Randomly shift the image along the Y axis.

This is a wrapper for functionality provided by the PIL library: https://github.com/python-pillow/Pillow/tree/master/src/PIL.

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
shift_limit float

Shift factor range as a fraction of image height. If shift_limit is a single float, the range will be (-shift_limit, shift_limit).

0.2
Image types

uint8

Source code in fastestimator/fastestimator/op/numpyop/univariate/translate_y.py
@traceable()
class TranslateY(NumpyOp):
    """Randomly shift the image along the Y axis.

    This is a wrapper for functionality provided by the PIL library:
    https://github.com/python-pillow/Pillow/tree/master/src/PIL.

    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".
        shift_limit: Shift factor range as a fraction of image height. If shift_limit is a single float, the range will
            be (-shift_limit, shift_limit).

    Image types:
        uint8
    """
    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,
                 shift_limit: float = 0.2):
        super().__init__(inputs=inputs, outputs=outputs, mode=mode, ds_id=ds_id)
        self.shift_limit = param_to_range(shift_limit)
        self.in_list, self.out_list = True, True

    def set_rua_level(self, magnitude_coef: float) -> None:
        """Set the augmentation intensity based on the magnitude_coef.

        This method is specifically designed to be invoked by the RUA Op.

        Args:
            magnitude_coef: The desired augmentation intensity (range [0-1]).
        """
        param_mid = (self.shift_limit[1] + self.shift_limit[0]) / 2
        param_extent = magnitude_coef * ((self.shift_limit[1] - self.shift_limit[0]) / 2)
        self.shift_limit = (param_mid - param_extent, param_mid + param_extent)

    def forward(self, data: List[np.ndarray], state: Dict[str, Any]) -> List[np.ndarray]:
        factor = random.uniform(self.shift_limit[0], self.shift_limit[1])
        return [TranslateY._apply_translatey(elem, factor) for elem in data]

    @staticmethod
    def _apply_translatey(data: np.ndarray, factor: float) -> np.ndarray:
        im = Image.fromarray(data)
        width, height = im.size
        displacement = factor * height
        im = im.transform((width, height),
                          ImageTransform.AffineTransform((1.0, 0.0, 0.0, 0.0, 1.0, displacement)),
                          resample=Image.BICUBIC)
        return np.array(im)

set_rua_level

Set the augmentation intensity based on the magnitude_coef.

This method is specifically designed to be invoked by the RUA Op.

Parameters:

Name Type Description Default
magnitude_coef float

The desired augmentation intensity (range [0-1]).

required
Source code in fastestimator/fastestimator/op/numpyop/univariate/translate_y.py
def set_rua_level(self, magnitude_coef: float) -> None:
    """Set the augmentation intensity based on the magnitude_coef.

    This method is specifically designed to be invoked by the RUA Op.

    Args:
        magnitude_coef: The desired augmentation intensity (range [0-1]).
    """
    param_mid = (self.shift_limit[1] + self.shift_limit[0]) / 2
    param_extent = magnitude_coef * ((self.shift_limit[1] - self.shift_limit[0]) / 2)
    self.shift_limit = (param_mid - param_extent, param_mid + param_extent)