Check Object Size

Check Object Size calculates the percentage that the main object occupies relative to the total image area. Additionally, users have the option to set a threshold if they want the object to exceed a certain size requirement.

---

Params

Object threshold percent (i)

Returns a boolean value indicating whether or not the main object occupies more than a specified percentage of the total image area.

Original Image

URL

https://cdn.pixelbin.io/v2/dummy-cloudname/FIDrmb/original/images/transformation/cake.jpeg

React

<PixelBinImage
    url="https://cdn.pixelbin.io/v2/dummy-cloudname/FIDrmb/original/images/transformation/cake.jpeg"
/>

JavaScript

import Pixelbin from "@pixelbin/core";

const obj = {
    cloudName: "dummy-cloudname",
    zone: "FIDrmb",
    version: "v2",
    transformations: [],
    filePath: "images/transformation/cake.jpeg",
    baseUrl: "https://cdn.pixelbin.io",
};

const url = Pixelbin.default.utils.objToUrl(obj);

// url
// https://cdn.pixelbin.io/v2/dummy-cloudname/FIDrmb/original/images/transformation/cake.jpeg

Node.js

const Pixelbin = require("@pixelbin/admin");

const obj = {
    cloudName: "dummy-cloudname",
    zone: "FIDrmb",
    version: "v2",
    transformations: [],
    filePath: "images/transformation/cake.jpeg",
    baseUrl: "https://cdn.pixelbin.io",
};

const url = Pixelbin.url.objToUrl(obj);

// url
// https://cdn.pixelbin.io/v2/dummy-cloudname/FIDrmb/original/images/transformation/cake.jpeg

Python

from pixelbin.utils.url import obj_to_url

obj = {
    "cloudName": "dummy-cloudname",
    "zone": "FIDrmb",
    "version": "v2",
    "transformations": [],
    "filePath": "images/transformation/cake.jpeg",
    "baseUrl": "https://cdn.pixelbin.io",
}

url = obj_to_url(obj)

# url
# https://cdn.pixelbin.io/v2/dummy-cloudname/FIDrmb/original/images/transformation/cake.jpeg

Golang

package main

import (
 "fmt"
 "github.com/pixelbin-dev/pixelbin-go/v2/sdk/utils/url"
)

func main() {
    obj := map[string]interface{}{
        "cloudName": "dummy-cloudname",
        "zoneSlug": "FIDrmb",
        "version": "v2",
        "transformations": []map[string]interface{}{
            
        },
        "filePath": "images/transformation/cake.jpeg",
        "baseUrl": "https://cdn.pixelbin.io",
        "options": map[string]interface{}{},
    }

    urlstring, err := url.ObjToUrl(obj)

    if err != nil {
        fmt.Println(err)
    }
}

// url
// https://cdn.pixelbin.io/v2/dummy-cloudname/FIDrmb/original/images/transformation/cake.jpeg

Kotlin

import com.pixelbin.url.UrlObj
import com.pixelbin.Utils
import com.pixelbin.transformation.TransformationObj

fun main(){
    val obj = UrlObj(
        cloudName = "dummy-cloudname",
        zone = "FIDrmb",
        version = "v2",
        transformation = arrayListOf(
            
        ),
        filePath = "images/transformation/cake.jpeg",
        baseUrl = "https://cdn.pixelbin.io"
    )

    val url = Utils.objToUrl(obj)
}

// url
// https://cdn.pixelbin.io/v2/dummy-cloudname/FIDrmb/original/images/transformation/cake.jpeg

C#

using System;
using System.Collections.Generic;
using System.IO;
using Pixelbin.Utils;

namespace ExampleNamespace
{
    class ExampleClass
    {
        static void Main(string[] args)
        {
            UrlObj obj = new UrlObj(
                version: "v2",
                cloudName: "dummy-cloudname",
                filePath: "images/transformation/cake.jpeg",
                zone: "FIDrmb",
                baseUrl: "https://cdn.pixelbin.io",
                transformations: new List<UrlTransformation>() {
                    
                }
            );

            string url = Url.ObjToUrl(obj);
        }
    }
}

// url
// https://cdn.pixelbin.io/v2/dummy-cloudname/FIDrmb/original/images/transformation/cake.jpeg

PHP

<?php
require 'vendor/autoload.php';
use Pixelbin\Utils\Url;

$obj = [
    "cloudName" => "dummy-cloudname",
    "zone" => "FIDrmb",
    "version" => "v2",
    "options" => [],
    "transformations" => [
        
    ],
    "filePath" => "images/transformation/cake.jpeg",
    "baseUrl" => "https://cdn.pixelbin.io",
];

$url = Url::obj_to_url($obj);

// url
// https://cdn.pixelbin.io/v2/dummy-cloudname/FIDrmb/original/images/transformation/cake.jpeg
?>

Context API Response

{
    "params": {
      "obj_threshold_perc": 50
    },
    "data": {
      "output": {
        "object_area_above_threshold": false,
        "obj_percent": 29
      }
    } 
}