ai.djl.modality.cv.transform.RandomBrightness Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

Deep Java Library - api

There is a newer version: 0.30.0

/*
 * Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
 * with the License. A copy of the License is located at
 *
 * http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
 * OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package ai.djl.modality.cv.transform;

import ai.djl.modality.cv.util.NDImageUtils;
import ai.djl.ndarray.NDArray;
import ai.djl.translate.Transform;

/**
 * A {@link Transform} that randomly jitters image brightness with a factor chosen from [max(0, 1 -
 * brightness), 1 + brightness].
 */
public class RandomBrightness implements Transform {

    private float brightness;

    /**
     * Creates a {@code RandomBrightness} {@link Transform}.
     *
     * @param brightness the brightness factor from 0 to 1
     */
    public RandomBrightness(float brightness) {
        this.brightness = brightness;
    }

    /** {@inheritDoc} */
    @Override
    public NDArray transform(NDArray array) {
        return NDImageUtils.randomBrightness(array, brightness);
    }
}