unify analyze commands and fix imports for analyze_multi_page snippet

yurii-scanbot · yurii-scanbot · commit de83c397cca0 · 2025-09-22T15:59:57.000+02:00
diff --git a/examples/c/README.md b/examples/c/README.md
@@ -67,7 +67,7 @@ The example supports four modes: **scan**, **analyze**, **classify**, and **pars
 ## Example
 ```bash
 ./scanbotsdk_example scan barcode --file images/example.jpg --license <KEY>
-./scanbotsdk_example analyze analyse_multi_page --file files/doc.pdf --license <KEY>
+./scanbotsdk_example analyze analyze_multi_page --file files/doc.pdf --license <KEY>
 ./scanbotsdk_example analyze crop_analyze --file images/doc.jpg --save out/crop.jpg --license <KEY>
 ./scanbotsdk_example parse mrz --text "P<UTOERIKSSON<<ANNA<MARIA<<<<<<" --license <KEY>
 ```
diff --git a/examples/c/include/snippets/document/analyse_multi_page.h b/examples/c/include/snippets/document/analyse_multi_page.h
diff --git a/examples/c/include/snippets/document/analyze_multi_page.h b/examples/c/include/snippets/document/analyze_multi_page.h
@@ -0,0 +1,8 @@
+#ifndef ANALYZE_MULTI_PAGE_H
+#define ANALYZE_MULTI_PAGE_H
+
+#include <ScanbotSDK.h>
+
+scanbotsdk_error_code_t analyze_multi_page(char* path);
+
+#endif
diff --git a/examples/c/include/snippets/document/crop_and_analyze.h b/examples/c/include/snippets/document/crop_and_analyze.h
@@ -3,6 +3,6 @@
 
 #include <ScanbotSDK.h>
 
-scanbotsdk_error_code_t crop_and_analyse(scanbotsdk_image_t *image, char* save_path);
+scanbotsdk_error_code_t crop_and_analyze(scanbotsdk_image_t *image, char* save_path);
 
 #endif
diff --git a/examples/c/src/main.c b/examples/c/src/main.c
@@ -19,8 +19,8 @@
 #include <snippets/datacapture/mrz_parser.h>
 
 #include <snippets/document/detect_document.h>    
-#include <snippets/document/analyse_multi_page.h>
-#include <snippets/document/crop_and_analyse.h>
+#include <snippets/document/analyze_multi_page.h>
+#include <snippets/document/crop_and_analyze.h>
 #include <snippets/document/document_classifier.h>
 
 static const int SCANBOTSDK_LICENSE_CHECK_TIMEOUT_MS = 15000;
@@ -86,17 +86,17 @@ int main(int argc, char *argv[]) {
         if      (strcmp(command, "document") == 0) ec = classify_document(image);
         else { print_usage(argv[0]); ec = SCANBOTSDK_ERROR_INVALID_ARGUMENT; }
     }
-    else if (strcmp(category, "analyse") == 0) {
+    else if (strcmp(category, "analyze") == 0) {
         if (!file_path) { print_usage(argv[0]); ec = SCANBOTSDK_ERROR_INVALID_ARGUMENT; goto cleanup; }
 
-        if (strcmp(command, "analyse_multi_page") == 0) {
-            ec = analyse_multi_page(file_path);
+        if (strcmp(command, "analyze_multi_page") == 0) {
+            ec = analyze_multi_page(file_path);
         }
         else if (strcmp(command, "crop_analyze") == 0) {
             ec = load_image_from_path(file_path, &image);
             if (ec != SCANBOTSDK_OK) goto cleanup;
 
-            ec = crop_and_analyse(image, save_path);
+            ec = crop_and_analyze(image, save_path);
         }
         else { print_usage(argv[0]); ec = SCANBOTSDK_ERROR_INVALID_ARGUMENT; }
     }
diff --git a/examples/c/src/snippets/document/analyze_multi_page.c b/examples/c/src/snippets/document/analyze_multi_page.c
@@ -42,15 +42,15 @@ static scanbotsdk_error_code_t process_page(scanbotsdk_extracted_page_t *page, s
 
     for (size_t j = 0; j < page_images_count; j++) {
         scanbotsdk_image_t *image = NULL;
-        scanbotsdk_document_quality_analyzer_result_t *analyse_result = NULL;
+        scanbotsdk_document_quality_analyzer_result_t *analyze_result = NULL;
 
         ec = scanbotsdk_extracted_image_get_image(images[j], &image);
         if (ec != SCANBOTSDK_OK) { fprintf(stderr, "extracted_image_get_image: %d: %s\n", ec, error_message(ec)); goto inner_cleanup; }
 
-        ec = scanbotsdk_document_quality_analyzer_run(analyzer, image, &analyse_result);
+        ec = scanbotsdk_document_quality_analyzer_run(analyzer, image, &analyze_result);
         if (ec != SCANBOTSDK_OK) { fprintf(stderr, "analyzer_run: %d: %s\n", ec, error_message(ec)); goto inner_cleanup; }
 
-        print_analyzer_result(analyse_result);
+        print_analyzer_result(analyze_result);
 
     inner_cleanup:
         if (ec != SCANBOTSDK_OK) { goto cleanup; }
@@ -61,7 +61,7 @@ static scanbotsdk_error_code_t process_page(scanbotsdk_extracted_page_t *page, s
     return ec;
 }
 
-scanbotsdk_error_code_t analyse_multi_page(char* path) {
+scanbotsdk_error_code_t analyze_multi_page(char* path) {
     scanbotsdk_error_code_t ec = SCANBOTSDK_OK;
 
     scanbotsdk_random_access_source_t* access_source = NULL;
diff --git a/examples/c/src/snippets/document/crop_and_analyze.c b/examples/c/src/snippets/document/crop_and_analyze.c
@@ -1,5 +1,5 @@
 #include <stdio.h>
-#include <snippets/document/crop_and_analyse.h>
+#include <snippets/document/crop_and_analyze.h>
 #include <utils/utils.h>
 
 scanbotsdk_error_code_t detect_document_cropped(
@@ -105,37 +105,37 @@ void print_result(scanbotsdk_document_quality_analyzer_result_t *result) {
     }
 }
 
-static scanbotsdk_error_code_t analyse_document_quality(
+static scanbotsdk_error_code_t analyze_document_quality(
     scanbotsdk_image_t *cropped_image
 ) {
     scanbotsdk_error_code_t ec = SCANBOTSDK_OK;
-    scanbotsdk_document_quality_analyzer_configuration_t *analyse_config = NULL;
+    scanbotsdk_document_quality_analyzer_configuration_t *analyze_config = NULL;
     scanbotsdk_document_quality_analyzer_t *analyzer = NULL;
-    scanbotsdk_document_quality_analyzer_result_t *analyse_result = NULL;
+    scanbotsdk_document_quality_analyzer_result_t *analyze_result = NULL;
 
     // region Setup analyzer
-    ec = scanbotsdk_document_quality_analyzer_configuration_create_with_defaults(&analyse_config);
+    ec = scanbotsdk_document_quality_analyzer_configuration_create_with_defaults(&analyze_config);
     // Configure other parameters as needed.
 
-    ec = scanbotsdk_document_quality_analyzer_create(analyse_config, &analyzer);
+    ec = scanbotsdk_document_quality_analyzer_create(analyze_config, &analyzer);
     if (ec != SCANBOTSDK_OK) { fprintf(stderr, "analyzer_create: %d: %s\n", ec, error_message(ec)); goto cleanup; }
     // endregion
 
-    // region Analyse quality
-    ec = scanbotsdk_document_quality_analyzer_run(analyzer, cropped_image, &analyse_result);
+    // region Analyze quality
+    ec = scanbotsdk_document_quality_analyzer_run(analyzer, cropped_image, &analyze_result);
     if (ec != SCANBOTSDK_OK) { fprintf(stderr, "analyzer_run: %d: %s\n", ec, error_message(ec)); goto cleanup; }
 
-    print_result(analyse_result);
+    print_result(analyze_result);
     // endregion
 
 cleanup:
-    scanbotsdk_document_quality_analyzer_result_free(analyse_result);
+    scanbotsdk_document_quality_analyzer_result_free(analyze_result);
     scanbotsdk_document_quality_analyzer_free(analyzer);
-    scanbotsdk_document_quality_analyzer_configuration_free(analyse_config);
+    scanbotsdk_document_quality_analyzer_configuration_free(analyze_config);
     return ec;
 }
 
-scanbotsdk_error_code_t crop_and_analyse(
+scanbotsdk_error_code_t crop_and_analyze(
     scanbotsdk_image_t *image,
     char *save_path
 ) {
@@ -151,7 +151,7 @@ scanbotsdk_error_code_t crop_and_analyse(
         if (ec != SCANBOTSDK_OK) goto cleanup;
     }
 
-    ec = analyse_document_quality(cropped_image);
+    ec = analyze_document_quality(cropped_image);
     if (ec != SCANBOTSDK_OK) goto cleanup;
 
 cleanup:
diff --git a/examples/c/src/utils/utils.c b/examples/c/src/utils/utils.c
@@ -75,7 +75,7 @@ void print_usage(const char *prog) {
     printf("or\n");
     printf("  %s classify <command> --file <path/to/file.jpg> [--license <KEY>]\n", prog);
     printf("or\n");
-    printf("  %s analyse <command> --file <path/to/file.jpg> --save <path/to/save.jpg> [--license <KEY>]\n", prog);
+    printf("  %s analyze <command> --file <path/to/file.jpg> --save <path/to/save.jpg> [--license <KEY>]\n", prog);
     printf("or\n");
     printf("  %s parse <command> --text \"<input>\" [--license <KEY>]\n\n", prog);
 
@@ -86,21 +86,21 @@ void print_usage(const char *prog) {
     printf("Available classify commands:\n");
     printf("  document \n\n");
 
-    printf("Available analyse commands:\n");
-    printf("  analyse_multi_page | crop_analyze\n\n");
+    printf("Available analyze commands:\n");
+    printf("  analyze_multi_page | crop_analyze\n\n");
 
     printf("Available parse commands:\n");
     printf("  mrz | barcode_doc\n\n");
 
     printf("Note:\n");
-    printf("  The --save argument is optional and only used with analyse/crop_analyze.\n");
+    printf("  The --save argument is optional and only used with analyze/crop_analyze.\n");
     printf("  The --license argument is optional. If not provided, the program will\n");
     printf("  \tcheck the placeholder <SCANBOTSDK-LICENSE> in main.c\n");
 
     printf("Examples:\n");
     printf("  %s scan barcode --file images/example.jpg --license <KEY>\n", prog);
-    printf("  %s analyse analyse_multi_page --file files/doc.pdf --license <KEY>\n", prog);
-    printf("  %s analyse crop_analyze --file images/doc.jpg --save out/crop.jpg --license <KEY>\n", prog);
+    printf("  %s analyze analyze_multi_page --file files/doc.pdf --license <KEY>\n", prog);
+    printf("  %s analyze crop_analyze --file images/doc.jpg --save out/crop.jpg --license <KEY>\n", prog);
     printf("  %s parse mrz --text \"P<UTOERIKSSON<<ANNA<MARIA<<<<<<\" --license <KEY>\n", prog);
     printf("\n");
 }
diff --git a/examples/java/README.md b/examples/java/README.md
@@ -22,7 +22,7 @@ The example supports four commands: **scan**, **analyze**, **classify**, and **p
 ## Example
 ```bash
 ./gradlew run --args='scan barcode --file images/example.jpg --license <KEY>'
-./gradlew run --args='analyze analyse_multi_page --resource files/doc.pdf --license <KEY>'
+./gradlew run --args='analyze analyze_multi_page --resource files/doc.pdf --license <KEY>'
 ./gradlew run --args='analyze crop_analyze --file images/doc.jpg --save out/crop.jpg --license <KEY>'
 ./gradlew run --args='parse mrz --text "P<UTOERIKSSON<<ANNA<MARIA<<<<<<" --license <KEY>'
 ```
diff --git a/examples/java/src/main/java/io/scanbot/sdk/ScanbotSDKExample.java b/examples/java/src/main/java/io/scanbot/sdk/ScanbotSDKExample.java
@@ -72,10 +72,10 @@ public static void main(String[] args) throws Exception {
                     }
                     break;
                 }
-                case "analyse": {
+                case "analyze": {
                     if (file == null && resource == null) { ExampleUsage.print(); return; }
                     switch (subcommand) {
-                        case "analyse_multi_page":   AnalyzeMultiPageSnippet.run(file, resource); break;
+                        case "analyze_multi_page":   AnalyzeMultiPageSnippet.run(file, resource); break;
                         case "crop_analyze":        CropAndAnalyzeSnippet.run(file, resource, save); break;
                         default: ExampleUsage.print();
                     }
diff --git a/examples/java/src/main/java/io/scanbot/sdk/snippets/document/AnalyzeMultiPageSnippet.java b/examples/java/src/main/java/io/scanbot/sdk/snippets/document/AnalyzeMultiPageSnippet.java
@@ -13,15 +13,15 @@
 
 public class AnalyzeMultiPageSnippet {
     public static void run(String filePath, String resourcePath) throws Exception {
-        DocumentQualityAnalyzerConfiguration analyse_config = new DocumentQualityAnalyzerConfiguration();
-        analyse_config.setTileSize(300);
-        analyse_config.setDetectOrientation(true);
-        analyse_config.setMinEstimatedNumberOfSymbolsForDocument(20);
+        DocumentQualityAnalyzerConfiguration analyze_config = new DocumentQualityAnalyzerConfiguration();
+        analyze_config.setTileSize(300);
+        analyze_config.setDetectOrientation(true);
+        analyze_config.setMinEstimatedNumberOfSymbolsForDocument(20);
         // Configure other parameters as needed.
 
         try (
             PageExtractionResult extractionResult = Utils.extractImages(filePath, resourcePath);
-            DocumentQualityAnalyzer analyzer = new DocumentQualityAnalyzer(analyse_config)
+            DocumentQualityAnalyzer analyzer = new DocumentQualityAnalyzer(analyze_config)
         ) {
             List<ExtractedPage> pages = extractionResult.getPages();
             System.out.println("Pages in document: " + pages.size());
diff --git a/examples/java/src/main/java/io/scanbot/sdk/snippets/document/CropAndAnalyzeSnippet.java b/examples/java/src/main/java/io/scanbot/sdk/snippets/document/CropAndAnalyzeSnippet.java
@@ -21,15 +21,15 @@ public static void run(String filePath, String resourcePath, String savePath) th
         DocumentScannerConfiguration config = new DocumentScannerConfiguration();
         config.setParameters(scanner_params);
 
-        DocumentQualityAnalyzerConfiguration analyse_config = new DocumentQualityAnalyzerConfiguration();
-        analyse_config.setTileSize(300);
-        analyse_config.setMinEstimatedNumberOfSymbolsForDocument(20);
+        DocumentQualityAnalyzerConfiguration analyze_config = new DocumentQualityAnalyzerConfiguration();
+        analyze_config.setTileSize(300);
+        analyze_config.setMinEstimatedNumberOfSymbolsForDocument(20);
         // Configure other parameters as needed.
 
         try (
             ImageRef image = Utils.createImageRef(filePath, resourcePath);
             DocumentScanner scanner = new DocumentScanner(config);
-            DocumentQualityAnalyzer analyzer = new DocumentQualityAnalyzer(analyse_config);
+            DocumentQualityAnalyzer analyzer = new DocumentQualityAnalyzer(analyze_config);
             DocumentScanningResult scanResult = scanner.scan(image);
         ) {
             DocumentDetectionResult detection = scanResult.getDetectionResult();
diff --git a/examples/java/src/main/java/io/scanbot/sdk/utils/ExampleUsage.java b/examples/java/src/main/java/io/scanbot/sdk/utils/ExampleUsage.java
@@ -21,7 +21,7 @@ public static void print() {
         System.out.println("  barcode | document | check | credit_card | document_extractor | medical_certificate | mrz | ocr | text_pattern | vin");
         System.out.println();
         System.out.println("Available analyze commands:");
-        System.out.println("  analyse_multi_page | crop_analyze");
+        System.out.println("  analyze_multi_page | crop_analyze");
         System.out.println();
         System.out.println("Available classify commands:");
         System.out.println("  document");
@@ -35,7 +35,7 @@ public static void print() {
         System.out.println();
         System.out.println("Examples:");
         System.out.println("  ./gradlew run --args='scan barcode --file images/example.jpg --license <KEY>'");
-        System.out.println("  ./gradlew run --args='analyze analyse_multi_page --resource files/doc.pdf --license <KEY>'");
+        System.out.println("  ./gradlew run --args='analyze analyze_multi_page --resource files/doc.pdf --license <KEY>'");
         System.out.println("  ./gradlew run --args='analyze crop_analyze --file images/doc.jpg --save out/crop.jpg --license <KEY>'");
         System.out.println("  ./gradlew run --args='parse mrz --text \"P<UTOERIKSSON<<ANNA<MARIA<<<<<<\" --license <KEY>'");
         System.out.println();
diff --git a/examples/nodejs/README.md b/examples/nodejs/README.md
@@ -29,7 +29,7 @@ npx ts-node src/index.ts parse <subcommand> --text "<input>" [--license <KEY>]
 ## Example
 ```bash
 npx ts-node src/index.ts scan barcode --file images/example.jpg --license <KEY>
-npx ts-node src/index.ts analyze analyse_multi_page --file files/doc.pdf --license <KEY>
+npx ts-node src/index.ts analyze analyze_multi_page --file files/doc.pdf --license <KEY>
 npx ts-node src/index.ts analyze crop_analyze --file images/doc.jpg --save out/crop.jpg --license <KEY>
 npx ts-node src/index.ts parse mrz --text "P<UTOERIKSSON<<ANNA<MARIA<<<<<<" --license <KEY>
 ```
diff --git a/examples/nodejs/src/index.ts b/examples/nodejs/src/index.ts
@@ -15,8 +15,8 @@ import { VinScannerSnippet } from "./snippets/datacapture/vin-scanner";
 import { DocumentClassifierSnippet } from "./snippets/document/document-classifier";
 import { MrzParserSnippet } from "./snippets/datacapture/mrz-parser";
 import { ParseBarcodeDocumentSnippet } from "./snippets/barcode/parse-barcode-document";
-import { AnalyzeMultiPageSnippet } from "./snippets/document/analyse-multipage";
-import { CropAndAnalyzeSnippet } from "./snippets/document/crop-analyse";
+import { AnalyzeMultiPageSnippet } from "./snippets/document/analyze-multipage";
+import { CropAndAnalyzeSnippet } from "./snippets/document/crop-analyze";
 
 async function awaitPromise(promise: Promise<void>, maxAwaitTimeMs: number = 60 * 1000): Promise<void> {
   const timer = setTimeout(() => {
@@ -92,11 +92,11 @@ async function main(): Promise<void> {
         break;
       }
 
-      case "analyse": {
+      case "analyze": {
         if (!file) { printUsage(); return; }
 
         switch (subcommand) {
-          case "analyse_multi_page":  await AnalyzeMultiPageSnippet.run(file); break;
+          case "analyze_multi_page":  await AnalyzeMultiPageSnippet.run(file); break;
           case "crop_analyze":        await CropAndAnalyzeSnippet.run(file, save); break;
           default: printUsage();
         }
diff --git a/examples/nodejs/src/snippets/document/analyze-multipage.ts b/examples/nodejs/src/snippets/document/analyze-multipage.ts
diff --git a/examples/nodejs/src/snippets/document/crop-analyze.ts b/examples/nodejs/src/snippets/document/crop-analyze.ts
diff --git a/examples/nodejs/src/snippets/utils/example-usage.ts b/examples/nodejs/src/snippets/utils/example-usage.ts
@@ -5,7 +5,7 @@ Usage:
 
 Categories & subcommands:
   scan <barcode | document  | check | credit_card | document_extractor  | medical_certificate | mrz | ocr | text_pattern  | vin>
-  analyse <analyse_multi_page | crop_analyze>
+  analyze <analyze_multi_page | crop_analyze>
   classify <document>
   parse <mrz  | barcode_doc>
 
@@ -18,8 +18,8 @@ Flags:
 
 Examples:
   npx ts-node src/index.ts scan barcode --file images/example.jpg --license <KEY>
-  npx ts-node src/index.ts analyse analyse_multi_page --file files/doc.pdf --license <KEY>
-  npx ts-node src/index.ts analyse crop_analyze --file images/doc.jpg --save out/crop.jpg --license <KEY>
+  npx ts-node src/index.ts analyze analyze_multi_page --file files/doc.pdf --license <KEY>
+  npx ts-node src/index.ts analyze crop_analyze --file images/doc.jpg --save out/crop.jpg --license <KEY>
   npx ts-node src/index.ts parse mrz --text "P<UTOERIKSSON<<ANNA<MARIA<<<<<<" --license <KEY>
 `);
 }
diff --git a/examples/python/README.md b/examples/python/README.md
@@ -107,7 +107,7 @@ python main.py live <subcommand> --device "<device-input>" [--license <KEY>] [--
 ## Example
 ```bash
 python main.py scan barcode --file images/example.jpg --license <KEY>
-python main.py analyze analyse_multi_page --file files/doc.pdf --license <KEY>
+python main.py analyze analyze_multi_page --file files/doc.pdf --license <KEY>
 python main.py analyze crop_analyze --file images/doc.jpg --save out/crop.jpg --license <KEY>
 python main.py parse mrz --text "P<UTOERIKSSON<<ANNA<MARIA<<<<<<" --license <KEY>
 python main.py live barcode --device "0" --license <KEY>
diff --git a/examples/python/main.py b/examples/python/main.py
@@ -2,8 +2,8 @@
 import scanbotsdk
 
 from snippets.document.document_classifier import classify_document
-from snippets.document import analyse_multi_page
-from snippets.document import crop_and_analyse
+from snippets.document.analyze_multi_page import analyze_multi_page
+from snippets.document.crop_and_analyze import crop_and_analyze
 from snippets.barcode.barcode_document_parser import parse_barcode_document
 from snippets.datacapture.mrz_parser import parse_mrz
 from snippets.datacapture.vin import scan_vin
@@ -88,10 +88,10 @@ def main():
                 if   subcommand == "document":            classify_document(image)
                 else: print_usage()
                 
-        elif category == "analyse":
+        elif category == "analyze":
             if not file_path: print_usage(); return
-            if   subcommand == "analyse_multi_page":      analyse_multi_page(file_path)
-            elif subcommand == "crop_analyze":            crop_and_analyse(file_path, save_path)
+            if   subcommand == "analyze_multi_page":      analyze_multi_page(file_path)
+            elif subcommand == "crop_analyze":            crop_and_analyze(file_path, save_path)
             else: print_usage()
             
         elif category == "parse":
diff --git a/examples/python/snippets/document/analyze_multi_page.py b/examples/python/snippets/document/analyze_multi_page.py
@@ -1,6 +1,6 @@
 from scanbotsdk import *
 
-def analyse_multi_page(file_path: str):
+def analyze_multi_page(file_path: str):
     configuration = DocumentQualityAnalyzerConfiguration(
         tile_size=300,
         detect_orientation=True,
@@ -20,7 +20,7 @@ def analyse_multi_page(file_path: str):
             # This ensures that memory is released immediately after processing
             # instead of keeping all uncompressed images alive until the
             # entire extraction_result is garbage-collected.
-            with extracted_image:
+            with extracted_image.image:
                 analysis_result = analyser.run(image=extracted_image.image)
                 print(
                     f"Page {page_index + 1}, Image {image_index + 1} "
diff --git a/examples/python/snippets/document/crop_and_analyze.py b/examples/python/snippets/document/crop_and_analyze.py
diff --git a/examples/python/utils.py b/examples/python/utils.py

Original file line number	Diff line number	Diff line change
`@@ -72,10 +72,10 @@ public static void main(String[] args) throws Exception {`
`72`	`72`	`}`
`73`	`73`	`break;`
`74`	`74`	`}`
`75`		`- case "analyse": {`
	`75`	`+ case "analyze": {`
`76`	`76`	`if (file == null && resource == null) { ExampleUsage.print(); return; }`
`77`	`77`	`switch (subcommand) {`
`78`		`- case "analyse_multi_page": AnalyzeMultiPageSnippet.run(file, resource); break;`
	`78`	`+ case "analyze_multi_page": AnalyzeMultiPageSnippet.run(file, resource); break;`
`79`	`79`	`case "crop_analyze": CropAndAnalyzeSnippet.run(file, resource, save); break;`
`80`	`80`	`default: ExampleUsage.print();`
`81`	`81`	`}`