Skip to content

Commit

Permalink
Update file(s) "/." from "aspose-ocr/Aspose.OCR-API-References"
Browse files Browse the repository at this point in the history
  • Loading branch information
Annushka34 committed Oct 21, 2024
1 parent 350cbf9 commit 6934e47
Show file tree
Hide file tree
Showing 39 changed files with 137 additions and 74 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: InterpolationFilterType
second_title: Aspose.OCR for .NET API Reference
description: Interpolations used for scale images.
type: docs
weight: 410
weight: 420
url: /net/aspose.ocr.filters/interpolationfiltertype/
---
## InterpolationFilterType enumeration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: OcrPageRecognizeEventsArgs
second_title: Aspose.OCR for .NET API Reference
description: Class for OcrProgress event recognition arguments.
type: docs
weight: 400
weight: 410
url: /net/aspose.ocr.models.events/ocrpagerecognizeeventsargs/
---
## OcrPageRecognizeEventsArgs class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: PreprocessingFilter
second_title: Aspose.OCR for .NET API Reference
description: Base class for image processing commands.
type: docs
weight: 390
weight: 400
url: /net/aspose.ocr.models.preprocessingfilters/preprocessingfilter/
---
## PreprocessingFilter class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: SpellCheckError
second_title: Aspose.OCR for .NET API Reference
description: Representing misspelled word with additional data.
type: docs
weight: 360
weight: 370
url: /net/aspose.ocr.spellchecker/spellcheckerror/
---
## SpellCheckError structure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: SpellCheckLanguage
second_title: Aspose.OCR for .NET API Reference
description: Languages used for SpellCheck existing dictionaries.
type: docs
weight: 380
weight: 390
url: /net/aspose.ocr.spellchecker/spellchecklanguage/
---
## SpellCheckLanguage enumeration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: SuggestedWord
second_title: Aspose.OCR for .NET API Reference
description: Spelling suggestion returned from GetSpellCheckErrorList.
type: docs
weight: 370
weight: 380
url: /net/aspose.ocr.spellchecker/suggestedword/
---
## SuggestedWord structure
Expand Down
1 change: 1 addition & 0 deletions content/sites/aspose/ocr/english/net/aspose.ocr/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ url: /net/aspose.ocr/
| [InputType](./inputtype) | Types of image/ documents for processing / recognition. |
| [Language](./language) | Languages used for OCR. ISO 939-3 Code. |
| [LoggingLevel](./logginglevel) | Defines the type of logs to display. |
| [PdfOptimizationMode](./pdfoptimizationmode) | Significantly reduce the PDF file size at the expense of lower image quality. |
| [PixelType](./pixeltype) | Determines the type of the pixel data for image recognition. |
| [SaveFormat](./saveformat) | For recognition result saving |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,10 @@ public class AsposeOcr
| [RecognizePassport](../../aspose.ocr/asposeocr/recognizepassport#recognizepassport_1)(OcrInput, PassportRecognitionSettings) | Recognizes text on passport. |
| [RecognizeReceipt](../../aspose.ocr/asposeocr/recognizereceipt#recognizereceipt)(OcrInput) | Recognizes text on receipts. |
| [RecognizeReceipt](../../aspose.ocr/asposeocr/recognizereceipt#recognizereceipt_1)(OcrInput, ReceiptRecognitionSettings) | Recognizes text on receipts. |
| [RecognizeStreetPhoto](../../aspose.ocr/asposeocr/recognizestreetphoto)(OcrInput) | Recognizes text on street photos. |
| static [SaveMultipageDocument](../../aspose.ocr/asposeocr/savemultipagedocument#savemultipagedocument_1)(MemoryStream, SaveFormat, List<RecognitionResult>, string) | Allows to get multipage document from list of RecognitionResult objects |
| static [SaveMultipageDocument](../../aspose.ocr/asposeocr/savemultipagedocument#savemultipagedocument_3)(string, SaveFormat, List<RecognitionResult>, string) | Allows to get multipage document from list of RecognitionResult objects |
| static [SaveMultipageDocument](../../aspose.ocr/asposeocr/savemultipagedocument#savemultipagedocument)(MemoryStream, SaveFormat, List<RecognitionResult>, bool, SpellCheckLanguage, string, string) | Allows to get multipage document from list of RecognitionResult objects |
| static [SaveMultipageDocument](../../aspose.ocr/asposeocr/savemultipagedocument#savemultipagedocument_2)(string, SaveFormat, List<RecognitionResult>, bool, SpellCheckLanguage, string, string) | Allows to get multipage document from list of RecognitionResult objects |
| static [SaveMultipageDocument](../../aspose.ocr/asposeocr/savemultipagedocument#savemultipagedocument_1)(MemoryStream, SaveFormat, List<RecognitionResult>, string, PdfOptimizationMode) | Allows to get multipage document from list of RecognitionResult objects |
| static [SaveMultipageDocument](../../aspose.ocr/asposeocr/savemultipagedocument#savemultipagedocument_3)(string, SaveFormat, List<RecognitionResult>, string, PdfOptimizationMode) | Allows to get multipage document from list of RecognitionResult objects |
| static [SaveMultipageDocument](../../aspose.ocr/asposeocr/savemultipagedocument#savemultipagedocument)(MemoryStream, SaveFormat, List<RecognitionResult>, bool, SpellCheckLanguage, string, string, PdfOptimizationMode) | Allows to get multipage document from list of RecognitionResult objects |
| static [SaveMultipageDocument](../../aspose.ocr/asposeocr/savemultipagedocument#savemultipagedocument_2)(string, SaveFormat, List<RecognitionResult>, bool, SpellCheckLanguage, string, string, PdfOptimizationMode) | Allows to get multipage document from list of RecognitionResult objects |

### See Also

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ List of [`RecognitionResult`](../../recognitionresult) objects with image recogn

### Remarks

Recognizes invoice with the ability to specify [`InvoiceRecognitionSettings`](../../invoicerecognitionsettings). Supports GIF, PNG, JPEG, BMP, TIFF, JFIF, stream, directory, arrays, archives.
Recognizes invoice with the ability to specify [`InvoiceRecognitionSettings`](../../invoicerecognitionsettings). Supports GIF, PNG, JPEG, BMP, TIFF, JFIF, stream, directory, arrays, archives. Supports GIF, PNG, JPEG, BMP, TIFF, JFIF, stream, directory, arrays, archives.

### See Also

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,17 @@ title: SaveMultipageDocument
second_title: Aspose.OCR for .NET API Reference
description: Allows to get multipage document from list of RecognitionResult objects
type: docs
weight: 210
weight: 200
url: /net/aspose.ocr/asposeocr/savemultipagedocument/
---
## SaveMultipageDocument(string, SaveFormat, List<RecognitionResult>, string) {#savemultipagedocument_3}
## SaveMultipageDocument(string, SaveFormat, List<RecognitionResult>, string, PdfOptimizationMode) {#savemultipagedocument_3}

Allows to get multipage document from list of RecognitionResult objects

```csharp
public static void SaveMultipageDocument(string fullFileName, SaveFormat saveFormat,
List<RecognitionResult> results, string embeddedFontPath = null)
List<RecognitionResult> results, string embeddedFontPath = null,
PdfOptimizationMode optimizePdf = PdfOptimizationMode.MAXIMUM_QUALITY)
```

| Parameter | Type | Description |
Expand All @@ -21,84 +22,93 @@ public static void SaveMultipageDocument(string fullFileName, SaveFormat saveFor
| saveFormat | SaveFormat | Document format (Docx, Txt, Pdf, Xlsx, Rtf, Json, Xml). |
| results | List`1 | List of [`RecognitionResult`](../../recognitionresult) objects. |
| embeddedFontPath | String | Optionally. Full path to the user font. |
| optimizePdf | PdfOptimizationMode | Reduce the PDF file size by lowering the quality of background images. By default, the original image quality is preserved. |

### See Also

* enum [SaveFormat](../../saveformat)
* class [RecognitionResult](../../recognitionresult)
* enum [PdfOptimizationMode](../../pdfoptimizationmode)
* class [AsposeOcr](../../asposeocr)
* namespace [Aspose.OCR](../../asposeocr)
* assembly [Aspose.OCR](../../../)

---

## SaveMultipageDocument(MemoryStream, SaveFormat, List&lt;RecognitionResult&gt;, string) {#savemultipagedocument_1}
## SaveMultipageDocument(string, SaveFormat, List&lt;RecognitionResult&gt;bool, SpellCheckLanguage, string, string, PdfOptimizationMode) {#savemultipagedocument_2}

Allows to get multipage document from list of RecognitionResult objects

```csharp
public static void SaveMultipageDocument(MemoryStream stream, SaveFormat saveFormat,
List<RecognitionResult> results, string embeddedFontPath = null)
public static void SaveMultipageDocument(string fullFileName, SaveFormat saveFormat,
List<RecognitionResult> results, bool applySpellingCorrection,
SpellCheckLanguage language = SpellCheckLanguage.Eng, string dictionaryPath = null,
string embeddedFontPath = null,
PdfOptimizationMode optimizePdf = PdfOptimizationMode.MAXIMUM_QUALITY)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | MemoryStream | MemoryStream for saving recognition result in the selected format. |
| fullFileName | String | Filename with a path for saving recognition result in the selected format. |
| saveFormat | SaveFormat | Document format (Docx, Txt, Pdf, Xlsx, Rtf, Json, Xml). |
| results | List`1 | List of [`RecognitionResult`](../../recognitionresult) objects. |
| applySpellingCorrection | Boolean | Set true to correct misspelled words in case you have such in your recognition result. |
| language | SpellCheckLanguage | Dictionary for spell check (optional). |
| dictionaryPath | String | Optionally. Full path to the user dictionary in .txt format. Format is [word - space - frequence(number)]. Example: the 23135851162\nthat 3400031103\n |
| embeddedFontPath | String | Optionally. Full path to the user font. |
| optimizePdf | PdfOptimizationMode | Reduce the PDF file size by lowering the quality of background images. By default, the original image quality is preserved. |

### See Also

* enum [SaveFormat](../../saveformat)
* class [RecognitionResult](../../recognitionresult)
* enum [SpellCheckLanguage](../../../aspose.ocr.spellchecker/spellchecklanguage)
* enum [PdfOptimizationMode](../../pdfoptimizationmode)
* class [AsposeOcr](../../asposeocr)
* namespace [Aspose.OCR](../../asposeocr)
* assembly [Aspose.OCR](../../../)

---

## SaveMultipageDocument(string, SaveFormat, List&lt;RecognitionResult&gt;bool, SpellCheckLanguage, string, string) {#savemultipagedocument_2}
## SaveMultipageDocument(MemoryStream, SaveFormat, List&lt;RecognitionResult&gt;, string, PdfOptimizationMode) {#savemultipagedocument_1}

Allows to get multipage document from list of RecognitionResult objects

```csharp
public static void SaveMultipageDocument(string fullFileName, SaveFormat saveFormat,
List<RecognitionResult> results, bool applySpellingCorrection,
SpellCheckLanguage language = SpellCheckLanguage.Eng, string dictionaryPath = null,
string embeddedFontPath = null)
public static void SaveMultipageDocument(MemoryStream stream, SaveFormat saveFormat,
List<RecognitionResult> results, string embeddedFontPath = null,
PdfOptimizationMode optimizePdf = PdfOptimizationMode.MAXIMUM_QUALITY)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fullFileName | String | Filename with a path for saving recognition result in the selected format. |
| stream | MemoryStream | MemoryStream for saving recognition result in the selected format. |
| saveFormat | SaveFormat | Document format (Docx, Txt, Pdf, Xlsx, Rtf, Json, Xml). |
| results | List`1 | List of [`RecognitionResult`](../../recognitionresult) objects. |
| applySpellingCorrection | Boolean | Set true to correct misspelled words in case you have such in your recognition result. |
| language | SpellCheckLanguage | Dictionary for spell check (optional). |
| dictionaryPath | String | Optionally. Full path to the user dictionary in .txt format. Format is [word - space - frequence(number)]. Example: the 23135851162\nthat 3400031103\n |
| embeddedFontPath | String | Optionally. Full path to the user font. |
| optimizePdf | PdfOptimizationMode | Reduce the PDF file size by lowering the quality of background images. By default, the original image quality is preserved. |

### See Also

* enum [SaveFormat](../../saveformat)
* class [RecognitionResult](../../recognitionresult)
* enum [SpellCheckLanguage](../../../aspose.ocr.spellchecker/spellchecklanguage)
* enum [PdfOptimizationMode](../../pdfoptimizationmode)
* class [AsposeOcr](../../asposeocr)
* namespace [Aspose.OCR](../../asposeocr)
* assembly [Aspose.OCR](../../../)

---

## SaveMultipageDocument(MemoryStream, SaveFormat, List&lt;RecognitionResult&gt;, bool, SpellCheckLanguage, string, string) {#savemultipagedocument}
## SaveMultipageDocument(MemoryStream, SaveFormat, List&lt;RecognitionResult&gt;, bool, SpellCheckLanguage, string, string, PdfOptimizationMode) {#savemultipagedocument}

Allows to get multipage document from list of RecognitionResult objects

```csharp
public static void SaveMultipageDocument(MemoryStream stream, SaveFormat saveFormat,
List<RecognitionResult> results, bool applySpellingCorrection,
SpellCheckLanguage language = SpellCheckLanguage.Eng, string dictionaryPath = null,
string embeddedFontPath = null)
string embeddedFontPath = null,
PdfOptimizationMode optimizePdf = PdfOptimizationMode.MAXIMUM_QUALITY)
```

| Parameter | Type | Description |
Expand All @@ -110,12 +120,14 @@ public static void SaveMultipageDocument(MemoryStream stream, SaveFormat saveFor
| language | SpellCheckLanguage | Dictionary for spell check (optional). |
| dictionaryPath | String | Optionally. Full path to the user dictionary in .txt format. Format is [word - space - frequence(number)]. Example: the 23135851162\nthat 3400031103\n |
| embeddedFontPath | String | Optionally. Full path to the user font. |
| optimizePdf | PdfOptimizationMode | Reduce the PDF file size by lowering the quality of background images. By default, the original image quality is preserved. |

### See Also

* enum [SaveFormat](../../saveformat)
* class [RecognitionResult](../../recognitionresult)
* enum [SpellCheckLanguage](../../../aspose.ocr.spellchecker/spellchecklanguage)
* enum [PdfOptimizationMode](../../pdfoptimizationmode)
* class [AsposeOcr](../../asposeocr)
* namespace [Aspose.OCR](../../asposeocr)
* assembly [Aspose.OCR](../../../)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: BaseRecognitionSettings
second_title: Aspose.OCR for .NET API Reference
description: Settings for the image recognition. Contains elements that allow customizing the recognition process.
type: docs
weight: 140
weight: 150
url: /net/aspose.ocr/baserecognitionsettings/
---
## BaseRecognitionSettings class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: CarPlateRecognitionSettings
second_title: Aspose.OCR for .NET API Reference
description: Settings for the car number recognition. Contains elements that allow customizing the recognition process.
type: docs
weight: 150
weight: 160
url: /net/aspose.ocr/carplaterecognitionsettings/
---
## CarPlateRecognitionSettings class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Character
second_title: Aspose.OCR for .NET API Reference
description: Data about detected character.
type: docs
weight: 310
weight: 320
url: /net/aspose.ocr/character/
---
## Character class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: CharacterRecognitionResult
second_title: Aspose.OCR for .NET API Reference
description: Pages with detected characters data.
type: docs
weight: 320
weight: 330
url: /net/aspose.ocr/characterrecognitionresult/
---
## CharacterRecognitionResult class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Country
second_title: Aspose.OCR for .NET API Reference
description: For better passport recognition point the passport country.
type: docs
weight: 200
weight: 210
url: /net/aspose.ocr/country/
---
## Country enumeration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: DefectAreas
second_title: Aspose.OCR for .NET API Reference
description: Image areas containing a certain type of defect.
type: docs
weight: 290
weight: 300
url: /net/aspose.ocr/defectareas/
---
## DefectAreas class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: DefectOutput
second_title: Aspose.OCR for .NET API Reference
description: Areas containing defects identified in the image.
type: docs
weight: 280
weight: 290
url: /net/aspose.ocr/defectoutput/
---
## DefectOutput class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,16 @@ public enum DetectAreasMode

| Name | Value | Description |
| --- | --- | --- |
| NONE | `0` | Doesn't detect paragraphs. Better for a simple one-column document without pictures. |
| DOCUMENT | `1` | Detects paragraphs uses NN model for documents. Better for multicolumn document, document with pictures or with other not text objects. |
| PHOTO | `2` | Detects paragraphs uses NN model for photos. Better for image with a lot of pictures and other not text objects. |
| NONE | `7` | Doesn't detect paragraphs. Better for a simple one-column document without pictures. |
| DOCUMENT | `8` | Detects paragraphs uses NN model for documents. Better for multicolumn document, document with pictures or with other not text objects. |
| PHOTO | `9` | Detects paragraphs uses NN model for photos. Better for image with a lot of pictures and other not text objects. |
| COMBINE | `3` | Detects paragraphs with text and then uses other NN model to detect areas inside of paragraphs. Better for images with complex structure. |
| TABLE | `4` | Detects cells with text. Preferable mode for images with table structure. |
| CURVED_TEXT | `5` | Detects lines and recognizes text on curved images. Preferred mode for photos of book and magazine pages. |
| TABLE | `4` | Detects tabular structures in the image and extracts text from individual cells. Recommended for scanned spreadsheets, reports, and other table-based documents. |
| CURVED_TEXT | `5` | Automatically straightens curved lines of text in the image, improving recognition accuracy and allowing more text to be recovered and extracted. Requires significant processing power and RAM. |
| TEXT_IN_WILD | `6` | A super-powerful neural network specialized in extracting words from low-quality images such as street photos, license plates, passport photos, meter photos, and photos with noisy backgrounds. |
| LEAN | `0` | Prioritizes speed and reduces resource consumption by omitting support for complex layouts. Suitable only for simple images with a few lines of text without illustrations or formatting. |
| MULTICOLUMN | `1` | Detects large blocks of text formatted in columns. The best choice for multi-column layouts such as book pages, articles, or contracts. |
| UNIVERSAL | `2` | Detects all blocks of text in the image, including sparse and irregular text on photos. A versatile option for most images, except for tables and multi-column layouts. |

### Remarks

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IDCardRecognitionSettings
second_title: Aspose.OCR for .NET API Reference
description: Settings for the ID Card recognition. Contains elements that allow customizing the recognition process.
type: docs
weight: 160
weight: 170
url: /net/aspose.ocr/idcardrecognitionsettings/
---
## IDCardRecognitionSettings class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ImageData
second_title: Aspose.OCR for .NET API Reference
description: Information about processed / recognized image.
type: docs
weight: 240
weight: 250
url: /net/aspose.ocr/imagedata/
---
## ImageData class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ImageProcessing
second_title: Aspose.OCR for .NET API Reference
description: Helper class for Aspose OCR library. Allows to preprocess and save images.
type: docs
weight: 250
weight: 260
url: /net/aspose.ocr/imageprocessing/
---
## ImageProcessing class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: InputType
second_title: Aspose.OCR for .NET API Reference
description: Types of image/ documents for processing / recognition.
type: docs
weight: 260
weight: 270
url: /net/aspose.ocr/inputtype/
---
## InputType enumeration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: InvoiceRecognitionSettings
second_title: Aspose.OCR for .NET API Reference
description: Settings for the invoice recognition. Contains elements that allow customizing the recognition process.
type: docs
weight: 170
weight: 180
url: /net/aspose.ocr/invoicerecognitionsettings/
---
## InvoiceRecognitionSettings class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Logging
second_title: Aspose.OCR for .NET API Reference
description: Class to create log configurations.
type: docs
weight: 180
weight: 190
url: /net/aspose.ocr/logging/
---
## Logging class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: LoggingLevel
second_title: Aspose.OCR for .NET API Reference
description: Defines the type of logs to display.
type: docs
weight: 190
weight: 200
url: /net/aspose.ocr/logginglevel/
---
## LoggingLevel enumeration
Expand Down
Loading

0 comments on commit 6934e47

Please sign in to comment.