abstract class Image

A container for image data.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

class Image {
    /**
     * Get the width of the image in pixels.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    attr width: Int
    /**
     * Get the height of the image in pixels.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    attr height: Int
    /**
     * Get the number of channels of the image.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    attr channel: Int
    /**
     * Get the `ImageSize` of the image.
     */
    attr size: ImageSize

    /**
     * Create an image from a file.
     *
     * @param path The path to the image file.
     *
     * @result image The image.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Impure([ImpurityReason.FileReadFromParameterizedPath("path")])
    @PythonName("from_file")
    static fun fromFile(
        path: String
    ) -> image: Image

    /**
     * Save the image as a JPEG file.
     *
     * @param path The path to the JPEG file.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Impure([ImpurityReason.FileWriteToParameterizedPath("path")])
    @PythonName("to_jpeg_file")
    fun toJpegFile(
        path: String
    )

    /**
     * Save the image as a PNG file.
     *
     * @param path The path to the PNG file.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Impure([ImpurityReason.FileWriteToParameterizedPath("path")])
    @PythonName("to_png_file")
    fun toPngFile(
        path: String
    )

    /**
     * Return a new `Image` that has the given number of channels.
     *
     * The original image is not modified.
     *
     * @param channel The new number of channels. 1 will result in a grayscale image.
     *
     * @result result1 The image with the given number of channels.
     */
    @Pure
    @PythonName("change_channel")
    fun changeChannel(
        channel: Int
    ) -> result1: Image

    /**
     * Return a new `Image` that has been resized to a given size.
     *
     * The original image is not modified.
     *
     * @param newWidth The new width of the image.
     * @param newHeight The new height of the image.
     *
     * @result result1 The image with the given width and height.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Pure
    fun resize(
        @PythonName("new_width") const newWidth: Int,
        @PythonName("new_height") const newHeight: Int
    ) -> result1: Image where {
        newWidth >= 0,
        newHeight >= 0
    }

    /**
     * Return a new `Image` that is converted to grayscale.
     *
     * The original image is not modified.
     *
     * @result result1 The grayscale image.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Pure
    @PythonName("convert_to_grayscale")
    fun convertToGrayscale() -> result1: Image

    /**
     * Return a new `Image` that has been cropped to a given bounding rectangle.
     *
     * The original image is not modified.
     *
     * @param x The x coordinate of the top-left corner of the bounding rectangle.
     * @param y The y coordinate of the top-left corner of the bounding rectangle.
     * @param width The width of the bounding rectangle.
     * @param height The height of the bounding rectangle.
     *
     * @result result1 The cropped image.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Pure
    fun crop(
        const x: Int,
        const y: Int,
        const width: Int,
        const height: Int
    ) -> result1: Image where {
        x >= 0,
        y >= 0,
        width >= 0,
        height >= 0
    }

    /**
     * Return a new `Image` that is flipped vertically (horizontal axis, flips up-down and vice versa).
     *
     * The original image is not modified.
     *
     * @result result1 The flipped image.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Pure
    @PythonName("flip_vertically")
    fun flipVertically() -> result1: Image

    /**
     * Return a new `Image` that is flipped horizontally (vertical axis, flips left-right and vice versa).
     *
     * The original image is not modified.
     *
     * @result result1 The flipped image.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Pure
    @PythonName("flip_horizontally")
    fun flipHorizontally() -> result1: Image

    /**
     * Return a new `Image` with an adjusted brightness.
     *
     * The original image is not modified.
     *
     * @param factor The brightness factor.
     * 1.0 will not change the brightness.
     * Below 1.0 will result in a darker image.
     * Above 1.0 will resolut in a brighter image.
     * Has to be bigger than or equal to 0 (black).
     *
     * @result result1 The Image with adjusted brightness.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Pure
    @PythonName("adjust_brightness")
    fun adjustBrightness(
        const factor: Float
    ) -> result1: Image where {
        factor >= 0.0
    }

    /**
     * Return a new `Image` with noise added to the image.
     *
     * The original image is not modified.
     *
     * @param standardDeviation The standard deviation of the normal distribution. Has to be bigger than or equal to 0.
     *
     * @result result1 The image with added noise.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Pure
    @PythonName("add_noise")
    fun addNoise(
        @PythonName("standard_deviation") const standardDeviation: Float
    ) -> result1: Image where {
        standardDeviation >= 0.0
    }

    /**
     * Return a new `Image` with adjusted contrast.
     *
     * The original image is not modified.
     *
     * @param factor If factor > 1, increase contrast of image.
     * If factor = 1, no changes will be made.
     * If factor < 1, make image greyer.
     * Has to be bigger than or equal to 0 (gray).
     *
     * @result result1 New image with adjusted contrast.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Pure
    @PythonName("adjust_contrast")
    fun adjustContrast(
        const factor: Float
    ) -> result1: Image where {
        factor >= 0.0
    }

    /**
     * Return a new `Image` with adjusted color balance.
     *
     * The original image is not modified.
     *
     * @param factor Has to be bigger than or equal to 0.
     * If 0 <= factor < 1, make image greyer.
     * If factor = 1, no changes will be made.
     * If factor > 1, increase color balance of image.
     *
     * @result result1 The new, adjusted image.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Pure
    @PythonName("adjust_color_balance")
    fun adjustColorBalance(
        const factor: Float
    ) -> result1: Image where {
        factor >= 0.0
    }

    /**
     * Return a blurred version of the image.
     *
     * The original image is not modified.
     *
     * @param radius Radius is directly proportional to the blur value. The radius is equal to the amount of pixels united in
     * each direction. A radius of 1 will result in a united box of 9 pixels.
     *
     * @result result1 The blurred image.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Pure
    fun blur(
        const radius: Int
    ) -> result1: Image where {
        radius >= 0
    }

    /**
     * Return a sharpened version of the image.
     *
     * The original image is not modified.
     *
     * @param factor If factor > 1, increase the sharpness of the image.
     * If factor = 1, no changes will be made.
     * If factor < 1, blur the image.
     * Has to be bigger than or equal to 0 (blurred).
     *
     * @result result1 The image sharpened by the given factor.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Pure
    fun sharpen(
        const factor: Float
    ) -> result1: Image where {
        factor >= 0.0
    }

    /**
     * Return a new `Image` with colors inverted.
     *
     * The original image is not modified.
     *
     * @result result1 The image with inverted colors.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Pure
    @PythonName("invert_colors")
    fun invertColors() -> result1: Image

    /**
     * Return a new `Image` that is rotated 90 degrees clockwise.
     *
     * The original image is not modified.
     *
     * @result result1 The image rotated 90 degrees clockwise.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Pure
    @PythonName("rotate_right")
    fun rotateRight() -> result1: Image

    /**
     * Return a new `Image` that is rotated 90 degrees counter-clockwise.
     *
     * The original image is not modified.
     *
     * @result result1 The image rotated 90 degrees counter-clockwise.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Pure
    @PythonName("rotate_left")
    fun rotateLeft() -> result1: Image

    /**
     * Return a grayscale version of the image with the edges highlighted.
     *
     * The original image is not modified.
     *
     * @result result1 The image with edges found.
     *
     * @example
     * pipeline example {
     *     // TODO
     * }
     */
    @Pure
    @PythonName("find_edges")
    fun findEdges() -> result1: Image
}

attr channel

Get the number of channels of the image.

Type: Int

Examples:

pipeline example {
    // TODO
}

attr height

Get the height of the image in pixels.

Type: Int

Examples:

pipeline example {
    // TODO
}

attr size

Get the ImageSize of the image.

Type: ImageSize

attr width

Get the width of the image in pixels.

Type: Int

Examples:

pipeline example {
    // TODO
}

fun addNoise

Return a new Image with noise added to the image.

The original image is not modified.

Parameters:

Name	Type	Description	Default
standardDeviation	Float	The standard deviation of the normal distribution. Has to be bigger than or equal to 0.	-

Results:

Name	Type	Description
result1	Image	The image with added noise.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Pure
@PythonName("add_noise")
fun addNoise(
    @PythonName("standard_deviation") const standardDeviation: Float
) -> result1: Image where {
    standardDeviation >= 0.0
}

fun adjustBrightness

Return a new Image with an adjusted brightness.

The original image is not modified.

Parameters:

Name	Type	Description	Default
factor	Float	The brightness factor. 1.0 will not change the brightness. Below 1.0 will result in a darker image. Above 1.0 will resolut in a brighter image. Has to be bigger than or equal to 0 (black).	-

Results:

Name	Type	Description
result1	Image	The Image with adjusted brightness.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Pure
@PythonName("adjust_brightness")
fun adjustBrightness(
    const factor: Float
) -> result1: Image where {
    factor >= 0.0
}

fun adjustColorBalance

Return a new Image with adjusted color balance.

The original image is not modified.

Parameters:

Name	Type	Description	Default
factor	Float	Has to be bigger than or equal to 0. If 0 <= factor < 1, make image greyer. If factor = 1, no changes will be made. If factor > 1, increase color balance of image.	-

Results:

Name	Type	Description
result1	Image	The new, adjusted image.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Pure
@PythonName("adjust_color_balance")
fun adjustColorBalance(
    const factor: Float
) -> result1: Image where {
    factor >= 0.0
}

fun adjustContrast

Return a new Image with adjusted contrast.

The original image is not modified.

Parameters:

Name	Type	Description	Default
factor	Float	If factor > 1, increase contrast of image. If factor = 1, no changes will be made. If factor < 1, make image greyer. Has to be bigger than or equal to 0 (gray).	-

Results:

Name	Type	Description
result1	Image	New image with adjusted contrast.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Pure
@PythonName("adjust_contrast")
fun adjustContrast(
    const factor: Float
) -> result1: Image where {
    factor >= 0.0
}

fun blur

Return a blurred version of the image.

The original image is not modified.

Parameters:

Name	Type	Description	Default
radius	Int	Radius is directly proportional to the blur value. The radius is equal to the amount of pixels united in each direction. A radius of 1 will result in a united box of 9 pixels.	-

Results:

Name	Type	Description
result1	Image	The blurred image.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Pure
fun blur(
    const radius: Int
) -> result1: Image where {
    radius >= 0
}

fun changeChannel

Return a new Image that has the given number of channels.

The original image is not modified.

Parameters:

Name	Type	Description	Default
channel	Int	The new number of channels. 1 will result in a grayscale image.	-

Results:

Name	Type	Description
result1	Image	The image with the given number of channels.

Stub code in Image.sdsstub

@Pure
@PythonName("change_channel")
fun changeChannel(
    channel: Int
) -> result1: Image

fun convertToGrayscale

Return a new Image that is converted to grayscale.

The original image is not modified.

Results:

Name	Type	Description
result1	Image	The grayscale image.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Pure
@PythonName("convert_to_grayscale")
fun convertToGrayscale() -> result1: Image

fun crop

Return a new Image that has been cropped to a given bounding rectangle.

The original image is not modified.

Parameters:

Name	Type	Description	Default
x	Int	The x coordinate of the top-left corner of the bounding rectangle.	-
y	Int	The y coordinate of the top-left corner of the bounding rectangle.	-
width	Int	The width of the bounding rectangle.	-
height	Int	The height of the bounding rectangle.	-

Results:

Name	Type	Description
result1	Image	The cropped image.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Pure
fun crop(
    const x: Int,
    const y: Int,
    const width: Int,
    const height: Int
) -> result1: Image where {
    x >= 0,
    y >= 0,
    width >= 0,
    height >= 0
}

fun findEdges

Return a grayscale version of the image with the edges highlighted.

The original image is not modified.

Results:

Name	Type	Description
result1	Image	The image with edges found.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Pure
@PythonName("find_edges")
fun findEdges() -> result1: Image

fun flipHorizontally

Return a new Image that is flipped horizontally (vertical axis, flips left-right and vice versa).

The original image is not modified.

Results:

Name	Type	Description
result1	Image	The flipped image.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Pure
@PythonName("flip_horizontally")
fun flipHorizontally() -> result1: Image

fun flipVertically

Return a new Image that is flipped vertically (horizontal axis, flips up-down and vice versa).

The original image is not modified.

Results:

Name	Type	Description
result1	Image	The flipped image.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Pure
@PythonName("flip_vertically")
fun flipVertically() -> result1: Image

fun invertColors

Return a new Image with colors inverted.

The original image is not modified.

Results:

Name	Type	Description
result1	Image	The image with inverted colors.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Pure
@PythonName("invert_colors")
fun invertColors() -> result1: Image

fun resize

Return a new Image that has been resized to a given size.

The original image is not modified.

Parameters:

Name	Type	Description	Default
newWidth	Int	The new width of the image.	-
newHeight	Int	The new height of the image.	-

Results:

Name	Type	Description
result1	Image	The image with the given width and height.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Pure
fun resize(
    @PythonName("new_width") const newWidth: Int,
    @PythonName("new_height") const newHeight: Int
) -> result1: Image where {
    newWidth >= 0,
    newHeight >= 0
}

fun rotateLeft

Return a new Image that is rotated 90 degrees counter-clockwise.

The original image is not modified.

Results:

Name	Type	Description
result1	Image	The image rotated 90 degrees counter-clockwise.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Pure
@PythonName("rotate_left")
fun rotateLeft() -> result1: Image

fun rotateRight

Return a new Image that is rotated 90 degrees clockwise.

The original image is not modified.

Results:

Name	Type	Description
result1	Image	The image rotated 90 degrees clockwise.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Pure
@PythonName("rotate_right")
fun rotateRight() -> result1: Image

fun sharpen

Return a sharpened version of the image.

The original image is not modified.

Parameters:

Name	Type	Description	Default
factor	Float	If factor > 1, increase the sharpness of the image. If factor = 1, no changes will be made. If factor < 1, blur the image. Has to be bigger than or equal to 0 (blurred).	-

Results:

Name	Type	Description
result1	Image	The image sharpened by the given factor.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Pure
fun sharpen(
    const factor: Float
) -> result1: Image where {
    factor >= 0.0
}

fun toJpegFile

Save the image as a JPEG file.

Parameters:

Name	Type	Description	Default
path	String	The path to the JPEG file.	-

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Impure([ImpurityReason.FileWriteToParameterizedPath("path")])
@PythonName("to_jpeg_file")
fun toJpegFile(
    path: String
)

fun toPngFile

Save the image as a PNG file.

Parameters:

Name	Type	Description	Default
path	String	The path to the PNG file.	-

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Impure([ImpurityReason.FileWriteToParameterizedPath("path")])
@PythonName("to_png_file")
fun toPngFile(
    path: String
)

static fun fromFile

Create an image from a file.

Parameters:

Name	Type	Description	Default
path	String	The path to the image file.	-

Results:

Name	Type	Description
image	Image	The image.

Examples:

pipeline example {
    // TODO
}

Stub code in Image.sdsstub

@Impure([ImpurityReason.FileReadFromParameterizedPath("path")])
@PythonName("from_file")
static fun fromFile(
    path: String
) -> image: Image