.. ################################################################################
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at

         http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing, software
     distributed under the License 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.
   ################################################################################

=====
Image
=====

Image Operations
----------------

- `Transform`_
- `Information`_
- `Detection`_
- `Face`_
- `Quality`_
- `Embedding`_

Transform
~~~~~~~~~

.. automodule:: pyflink.multimodal.operators.image_transform
    :noindex:

.. currentmodule:: pyflink.multimodal.operators

.. autosummary::
    :toctree: api/

    image_decode
    image_encode
    image_compress
    image_convert_format
    image_to_tensor
    image_convert_mode
    image_resize
    image_rescale
    image_crop
    image_crop_black_border
    image_flip
    image_blur
    image_adjust_color
    image_remove_background


Information
~~~~~~~~~~~

.. automodule:: pyflink.multimodal.operators.image_info
    :noindex:

.. currentmodule:: pyflink.multimodal.operators

.. autosummary::
    :toctree: api/

    image_metadata
    image_aspect_ratio
    image_sharpness
    image_hash
    is_valid_image
    image_size_filter
    image_shape_filter
    image_file_size_filter


Detection
~~~~~~~~~

.. automodule:: pyflink.multimodal.operators.image_detect
    :noindex:

.. currentmodule:: pyflink.multimodal.operators

.. autosummary::
    :toctree: api/

    image_detect_objects
    image_segment
    image_ocr
    image_detect_subplot


Face
~~~~

.. automodule:: pyflink.multimodal.operators.image_face
    :noindex:

.. currentmodule:: pyflink.multimodal.operators

.. autosummary::
    :toctree: api/

    image_face_detect
    image_face_count
    image_face_blur


Quality
~~~~~~~

.. automodule:: pyflink.multimodal.operators.image_quality
    :noindex:

.. currentmodule:: pyflink.multimodal.operators

.. autosummary::
    :toctree: api/

    image_nsfw_score
    image_aesthetic_score
    image_quality_score
    image_watermark_score


Embedding
~~~~~~~~~

.. automodule:: pyflink.multimodal.operators.image_embed
    :noindex:

.. currentmodule:: pyflink.multimodal.operators

.. autosummary::
    :toctree: api/

    image_embedding
    image_text_similarity


Image Codec
-----------

.. automodule:: pyflink.multimodal.codec
    :noindex:

.. automodule:: pyflink.multimodal.codec.image
    :noindex:

.. currentmodule:: pyflink.multimodal.codec

.. autosummary::
    :toctree: api/

    image_mode_channels
    image_to_ndarray
    ndarray_to_image
    pil_to_image
    convert_image_array_to_mode
    image_array_to_pil
    image_array_to_pil_compatible
    normalize_image_format
    validate_image_quality
    detect_image_format
    image_array_to_jpeg_pil
    decode_image_input
    safe_decode_image_input
    decode_image
    encode_image_input
    safe_decode_batch
    decode_image_batch