Skip to content

Image manipulation endpoints


Endpoints for performing image processing manipulations

trim_image(request) async

Crop (trim) background from the given image.

Parameters:

Name Type Description Default
request SingleImageModel

input image

required

Returns:

Name Type Description
response SingleImageModel

response image

Source code in src/app/routers/tools/tools.py
@router.post(path='/trim_image', response_model=schemas.SingleImageModel)
async def trim_image(request: schemas.TrimImageRequest) -> schemas.SingleImageModel:
    """
    Crop (trim) background from the given image.

    Parameters
    ----------
    request : schemas.SingleImageModel
        input image

    Returns
    -------
    response : schemas.SingleImageModel
        response image
    """
    trimmed_image = await services.trim_image(image=request.image, norm_thresh=request.norm_thresh,
                                              initial_thresh=request.initial_thresh)

    return schemas.SingleImageModel(id=request.id, image=trimmed_image)