| Name | Description | |
|---|---|---|
 | GdPictureSegmenter Constructor | Creates a new instance of the GdPictureSegmenter class. This instance represents a wrapper, that you will need to perform the image segmentation process. At the same it enables you to find out all required results in one place. |
GdPictureSegmenter Class Members
In This Topic
The following tables list the members exposed by GdPictureSegmenter.
Public Constructors
Public Properties
| Name | Description | |
|---|---|---|
 | InputValue | Specifies the input value that is required to segment a word. Expected value is a string containing the text/word/character you wish to segment. |
| SegmentationMode | Defines the segmentation mode to be used during subsequent segmentation processes. |
Public Methods
| Name | Description | |
|---|---|---|
 | Dispose | Disposes of the GdPictureSegmenter object completely. All related resources used by this object are released. All used segmentation results within the current GdPictureSegmenter object are released too. |
| GetBlockBottom | Returns the bottom y-coordinate of the bounding box of the specified block, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetBlockCount | Returns the number of blocks within the segmentation result specified by its index. |
| GetBlockFirstParagraphIndex | Returns the index of the first paragraph in the specified block, that is a part of the segmentation result specified by its index. |
| GetBlockLeft | Returns the left x-coordinate of the bounding box of the specified block, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetBlockParagraphCount | Returns the number of paragraphs within the specified block, that is a part of the segmentation result specified by its index. |
| GetBlockRight | Returns the right x-coordinate of the bounding box of the specified block, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetBlockTop | Returns the top y-coordinate of the bounding box of the specified block, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetBlockType | Returns the type of the specified block, that is a part of the segmentation result specified by its index. |
| GetCharacterBottom | Returns the bottom y-coordinate of the bounding box of the specified character, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetCharacterCount | Returns the number of characters within the segmentation result specified by its index. |
| GetCharacterLeft | Returns the left x-coordinate of the bounding box of the specified character, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetCharacterRight | Returns the right x-coordinate of the bounding box of the specified character, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetCharacterTop | Returns the top y-coordinate of the bounding box of the specified character, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetParagraphBottom | Returns the bottom y-coordinate of the bounding box of the specified paragraph, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetParagraphCount | Returns the number of paragraphs within the segmentation result specified by its index. |
| GetParagraphFirstTextLineIndex | Returns the index of the first text line in the specified paragraph, that is a part of the segmentation result specified by its index. |
| GetParagraphLeft | Returns the left x-coordinate of the bounding box of the specified paragraph, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetParagraphRight | Returns the right x-coordinate of the bounding box of the specified paragraph, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetParagraphTextLineCount | Returns the number of text lines within the specified paragraph, that is a part of the segmentation result specified by its index. |
| GetParagraphTop | Returns the top y-coordinate of the bounding box of the specified paragraph, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetStat | Returns the status of the last executed operation with the current GdPictureSegmenter object. |
| GetTextLineBottom | Returns the bottom y-coordinate of the bounding box of the specified text line, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetTextLineCount | Returns the number of text lines within the segmentation result specified by its index. The resulting value doesn't contain any empty lines, as they are not provided in the segmentation result. |
| GetTextLineFirstWordIndex | Returns the index of the first word in the specified text line, that is a part of the segmentation result specified by its index. |
| GetTextLineLeft | Returns the left x-coordinate of the bounding box of the specified text line, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetTextLineRight | Returns the right x-coordinate of the bounding box of the specified text line, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetTextLineTop | Returns the top y-coordinate of the bounding box of the specified line, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetTextLineWordCount | Returns the number of words within the specified text line, that is a part of the segmentation result specified by its index. |
| GetWordBottom | Returns the bottom y-coordinate of the bounding box of the specified word, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetWordCharacterCount | Returns the number of characters within the specified word, that is a part of the segmentation result specified by its index. |
| GetWordCount | Returns the number of words within the segmentation result specified by its index. |
| GetWordFirstCharacterIndex | Returns the index of the first character in the specified word, that is a part of the segmentation result specified by its index. |
| GetWordLeft | Returns the left x-coordinate of the bounding box of the specified word, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetWordRight | Returns the right x-coordinate of the bounding box of the specified word, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| GetWordTop | Returns the top y-coordinate of the bounding box of the specified word, that is a part of the segmentation result specified by its index.
This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels. |
| ReleaseSegmentationResult | Releases a segmentation result specified by its unique identifier. Each segmentation result, identifiable by its unique ID, is internally attached to that GdPictureSegmenter object, which has executed the segmentation process. By disposing of the current GdPictureSegmenter object you also release all attached segmentation results. |
| ReleaseSegmentationResults | Releases all results of all previously executed segmentation processes within the current GdPictureSegmenter object. Each segmentation result is internally attached to that GdPictureSegmenter object, which has executed the segmentation process. By disposing of the current GdPictureSegmenter object you also release all attached segmentation results. |
| ResetROI | Resets the previously specified region of interest to default (whole image area). |
| RunSegmentation | Overloaded. Executes the image segmentation using the available parameters you have specified within the current GdPictureSegmenter object. |
| SetImage | Sets up the specified image object, so that it is subsequently used when you start the next segmentation process. This step is mandatory before running any segmentation.
This aproach permits you to highly improve performance when running multiple subsequent segmentation processes on the same image. |
| SetROI | Sets up the new region of interest (ROI) of an image, that is subsequently processed using the segmenter. Only the specified region is included into the next segmentation process. |
See Also