sonic-widget 2.6.2 → 2.6.6

package/README.md

@@ -12,7 +12,7 @@
 Use this script tag to get access to the widget:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.6.2/dist/index.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.6.6/dist/index.min.js"></script>
 ```
 
 or 
@@ -39,7 +39,7 @@ and adding path in `angular.json`
 2. Use this script tag to get access to the widget at initial html page:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.6.2/dist/index.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.6.6/dist/index.min.js"></script>
 ```
 
 or 
@@ -99,6 +99,7 @@ ngOnInit(): void {
 		blinkThreshold: number, // used for blink threshold
 		objectPersonThreshold: number, // used for object Person score threshold
 		objectPhoneThreshold: number, // used for object Phone score threshold
+		grayscalePercentageThreshold: number, // used for black&white percentage score threshold
 		onMessage: function (data) {}, // callback function, when api response message or error or any other actions
 	};
 
@@ -233,7 +234,7 @@ it can be added in `angular.json` by installing the npm package
 4. Add a Script tag to the head tag or body tag. And use the latest version.
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.6.2/dist/index.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.6.6/dist/index.min.js"></script>
 ```
 
 5. Next, add the script tag at a necessary place. But add below the widget script.
@@ -266,6 +267,7 @@ it can be added in `angular.json` by installing the npm package
 		blinkThreshold: number, // threshold used to calculate the user blinked or not, with range limit 0-1(default value is 0.4)
 		objectPersonThreshold: number, // used for object Person score threshold with range limit 0-1(default value is 0.925)
 		objectPhoneThreshold: number, // used for object Phone score threshold with range limit 0-1(default value is 0.5)
+		grayscalePercentageThreshold: number, // used for black&white percentage score threshold with range limit 0-100(default value is 90)
 		onMessage: function (data) {}, // callback function, when api response message or error or any other actions
 	};
 	// get the element used in the action button 
@@ -318,7 +320,27 @@ Check with **`data.code`**_
 - _**`blinkThreshold`** is used to pass a numerical value. It is used to check the user blinks (range 0-1 and default 0.5)._
 - _**`objectPersonThreshold`** is used to pass a numerical value. It is used to check the image person as object found with required score as threshold (range 0-1 and default 0.925)._
 - _**`objectPhoneThreshold`** is used to pass a numerical value. It is used to check the image phone/laptop as object found with required score as threshold (range 0-1 and default 0.5)._
+- _**`grayscalePercentageThreshold`** is used to pass a numerical value for percentage. It is used to check the image color as black&white found with required percentage as threshold (range 0-100 and default 90)._
 - _**`onMessage`** is a callback function. It is getting called when the API gives a message or at any configuration error. Return data is an object with its API endpoint and result._
 
 
 <!-- use node 18 and install packages using yarn and do yarn dev -->
+
+
+<!-- GrayScale Suggestions
+
+1. RGB Difference Threshold for Grayscale Detection:
+
+Low Threshold: A low threshold (e.g., 5-10) is good if you want to consider any slight variation in color as an indication that the image is colored. This is more sensitive to minor color differences.
+
+Moderate Threshold: A threshold of around 10-20 is a more balanced approach. It allows for small variations due to noise or minor imperfections in grayscale images but still classifies them as black and white.
+
+High Threshold: A higher threshold (e.g., 20-50) will classify images as grayscale even if there are noticeable color variations, which might be acceptable for images that are predominantly black and white but have some color noise or artifacts.
+
+2. Percentage of Grayscale Pixels:
+
+After detecting grayscale pixels, you need to determine the percentage of grayscale pixels required to classify the image as black and white.
+
+80-90% Grayscale Pixels: This threshold means that if 80-90% of the pixels are grayscale, the image will be classified as black and white. This works well for documents and images that are mostly grayscale but may have some minor color elements (e.g., stamps, logos).
+
+90-100% Grayscale Pixels: This is a stricter threshold, ensuring that the image is classified as black and white only if nearly all pixels are grayscale. -->