Layout Data (Concept) - Revision history

Dgreenwood: /* How components use layout data */

2025-08-08T19:00:59Z

How components use layout data

@@ Line 68: / Line 68: @@
 * '''Separation and classification:''' Layout Data enables event-based separation and classification by detecting the presence of visual triggers.
 * '''Diagnostics and visualization:''' Layout Data is used to generate overlays and visual cues in review and troubleshooting tools.
 == Where is layout data stored? ==

Dgreenwood: /* Components that leverage layout data */

2025-08-08T19:00:47Z

Components that leverage layout data

@@ Line 60: / Line 60: @@
 : The [[Shape Detection]] command identifies graphical shapes or stamps, such as logos or custom marks, and records their position, name, and confidence. Shape Detection locates shapes similar to examples supplied by a Grooper designer when the command is configured.
 : The [[Shape Removal]] command also identifies shapes and stores layout data. In addition, it will digitally remove them from the image, which can help improve OCR results when applied by an OCR Profile.
 == How components use layout data ==

Dgreenwood: /* What is layout data? */

2025-08-08T17:55:19Z

What is layout data?

← Older revision		Revision as of 12:55, 8 August 2025
Line 23:		Line 23:
	* '''Barcodes''' - The location, type and encoded value of barcodes		* '''Barcodes''' - The location, type and encoded value of barcodes
	* '''OMR boxes''' - The presence and state of checkboxes and boxes		* '''OMR boxes''' - The presence and state of checkboxes and boxes
	* '''Shapes''' The identification of shapes, stamps, or other graphical marks that match examples supplied by a Grooper designer.		* '''Shapes''' - The identification of shapes, stamps, or other graphical marks that match examples supplied by a Grooper designer.

	Layout Data is typically generated during image processing and recognition activities, and is used by downstream components to anchor extraction, validate results, and drive automation.		Layout Data is typically generated during image processing and recognition activities, and is used by downstream components to anchor extraction, validate results, and drive automation.

Dgreenwood: /* What is layout data? */

2025-08-08T17:55:10Z

What is layout data?

← Older revision		Revision as of 12:55, 8 August 2025
Line 23:		Line 23:
	* '''Barcodes''' - The location, type and encoded value of barcodes		* '''Barcodes''' - The location, type and encoded value of barcodes
	* '''OMR boxes''' - The presence and state of checkboxes and boxes		* '''OMR boxes''' - The presence and state of checkboxes and boxes
	* ''Shapes''' The identification of shapes, stamps, or other graphical marks that match examples supplied by a Grooper designer.		* '''Shapes''' The identification of shapes, stamps, or other graphical marks that match examples supplied by a Grooper designer.

	Layout Data is typically generated during image processing and recognition activities, and is used by downstream components to anchor extraction, validate results, and drive automation.		Layout Data is typically generated during image processing and recognition activities, and is used by downstream components to anchor extraction, validate results, and drive automation.

Dgreenwood: /* Overview */

2025-08-07T20:34:48Z

Overview

← Older revision		Revision as of 15:34, 7 August 2025
Line 4:		Line 4:

	'''Layout Data''' is a foundational concept in Grooper, representing the structural and spatial information extracted from document images. It describes the physical arrangement of graphical features on a page, such as lines, barcodes, checkboxes, custom detected shapes. Layout Data enables Grooper to understand not just what content is present, but where and how it appears, supporting computer vision based data extraction and processing scenarios.		'''Layout Data''' is a foundational concept in Grooper, representing the structural and spatial information extracted from document images. It describes the physical arrangement of graphical features on a page, such as lines, barcodes, checkboxes, custom detected shapes. Layout Data enables Grooper to understand not just what content is present, but where and how it appears, supporting computer vision based data extraction and processing scenarios.

			{\|class="attn-box"
			\|
			⚠
			\|
			Layout data is nearly always saved at the {{BatchPageIcon}} [[Batch Page]] level '''not''' the {{BatchFolderIcon}} [[Batch Folder]] level.

			While it is '''technically possible''' for layout data to be saved to Batch Folders, this article assumes layout data is saved at the Batch Page level.

			It is also '''best practice''' to execute activities that save layout data ([[Image Processing]] and [[Recognize]]) at the Batch Page level.
			\|}

	== What is layout data? ==		== What is layout data? ==

Dgreenwood: /* Where is layout data stored? */

2025-08-07T20:31:05Z

Where is layout data stored?

← Older revision		Revision as of 15:31, 7 August 2025
Line 91:		Line 91:
	== Where is layout data stored? ==		== Where is layout data stored? ==

	Layout Data is stored at the [[Batch Page]] level in a file named "''Grooper.Layout.json''". Each ~~page in a~~ [[Batch ~~Folder~~]] maintains its own Layout Data, which is updated as [[Image Processing]] and [[Recognize]] steps are performed. This data is accessible to extractors, separation events, and other components that need to reference the page's structure.		Layout Data is stored at the [[Batch Page]] level in its Grooper file store location. It is saved in a file named "''Grooper.Layout.json''".

			Each [[Batch Page]] maintains its own Layout Data, which is updated as [[Image Processing]] and [[Recognize]] steps are performed. This data is accessible to extractors, separation events, and other components that need to reference the page's structure.

	The ''Grooper.Layout.json'' file can be viewed by navigating to the Batch Page in the node tree. Go to the "Advanced" tab and you will see it in the "Files" panel. You can open this file by double clicking it.		The ''Grooper.Layout.json'' file can be viewed by navigating to the Batch Page in the node tree. Go to the "Advanced" tab and you will see it in the "Files" panel. You can open this file by double clicking it.

Dgreenwood: /* Components that leverage layout data */

2025-08-07T17:50:58Z

Components that leverage layout data

← Older revision		Revision as of 12:50, 7 August 2025
Line 62:		Line 62:
	; '''OMR extractors'''		; '''OMR extractors'''
	: [[Labeled OMR]], [[Ordered OMR]], and [[Zonal OMR]] use Layout Data to locate and interpret checkboxes and other rectangular mark regions.		: [[Labeled OMR]], [[Ordered OMR]], and [[Zonal OMR]] use Layout Data to locate and interpret checkboxes and other rectangular mark regions.

			; '''Barcode extractors'''
			: [[Find Barcode]] returns encoded barcode values located in the Layout Data.

	; '''Separation Events'''		; '''Separation Events'''

Dgreenwood: /* Components that leverage layout data */

2025-08-07T17:49:59Z

Components that leverage layout data

← Older revision		Revision as of 12:49, 7 August 2025
Line 58:		Line 58:

	; '''Table Extract Methods'''		; '''Table Extract Methods'''
	: [[Tabular Layout]] and [[Grid Layout]] ~~rely on~~ Layout Data to identify rows, columns, and cell boundaries, enabling robust extraction from ~~structured and semi-structured~~ tables.		: [[Tabular Layout]] and [[Grid Layout]] can use line locations in the Layout Data to better identify rows, columns, and cell boundaries, enabling robust extraction from tables (often with less setup required on the Grooper designers part too).

	; '''OMR extractors'''		; '''OMR extractors'''
	: [[Labeled OMR]], [[Ordered OMR]], and [[Zonal OMR]] use Layout Data to locate and interpret checkboxes and other mark regions.		: [[Labeled OMR]], [[Ordered OMR]], and [[Zonal OMR]] use Layout Data to locate and interpret checkboxes and other rectangular mark regions.

	; '''Separation Events'''		; '''Separation Events'''

Dgreenwood: /* Components that leverage layout data */

2025-08-07T17:48:04Z

Components that leverage layout data

← Older revision		Revision as of 12:48, 7 August 2025
Line 64:		Line 64:

	; '''Separation Events'''		; '''Separation Events'''
	: ~~Events like~~ [[Shape Detected]] and [[Barcode Detected]] trigger document separation based on the presence of specific shapes or barcodes, as indicated by Layout Data.		: [[Event-Based Separation]] events like "Shape Detected" and "Barcode Detected" trigger document separation based on the presence of specific shapes or barcodes, as indicated by Layout Data.

	; '''Paragraph and region segmentation'''		; '''Paragraph and region segmentation'''

Dgreenwood at 17:40, 7 August 2025

2025-08-07T17:40:43Z

← Older revision		Revision as of 12:40, 7 August 2025
Line 1:		Line 1:
	~~{{stubs}}~~

	<blockquote>{{#lst:Glossary\|Layout Data}}</blockquote>		<blockquote>{{#lst:Glossary\|Layout Data}}</blockquote>


	== Overview ==		== Overview ==
Line 91:		Line 88:
	== Where is layout data stored? ==		== Where is layout data stored? ==

	Layout Data is stored at the [[Batch Page]] level in a file named "Grooper.Layout.json". Each page in a [[Batch Folder]] maintains its own Layout Data, which is updated as [[Image Processing]] and [[Recognize]] steps are performed. This data is accessible to extractors, separation events, and other components that need to reference the page's structure.		Layout Data is stored at the [[Batch Page]] level in a file named "''Grooper.Layout.json''". Each page in a [[Batch Folder]] maintains its own Layout Data, which is updated as [[Image Processing]] and [[Recognize]] steps are performed. This data is accessible to extractors, separation events, and other components that need to reference the page's structure.

	The Grooper.Layout.json file can be viewed by navigating to the Batch Page in the node tree. Go to the "Advanced" tab and you will see it in the "Files" panel. You can open this file by double clicking it.		The ''Grooper.Layout.json'' file can be viewed by navigating to the Batch Page in the node tree. Go to the "Advanced" tab and you will see it in the "Files" panel. You can open this file by double clicking it.
	:*<li class="fyi-bullet">Note: The Grooper.Layout.json file will only exist if an IP Profile has been run on the Batch Page (by Image Processing or Recognize) ''and'' layout data was collected.		:*<li class="fyi-bullet">Note: The ''Grooper.Layout.json'' file will only exist if an IP Profile has been run on the Batch Page (by Image Processing or Recognize) ''and'' layout data was collected.

	=== Lines ===		=== Lines ===

	Lines listed in the ~~LayoutData~~.json file are broken out into Horizontal Lines and Vertical lines. For each line, X/Y coordinates will be listed for the start and stop points. Each line is a separate object in <code>{}</code> brackets. (X1,Y1) is the start position of the line. (X2, Y2) is the end position of the line.		Lines listed in the ''Grooper.Layout.json'' file are broken out into Horizontal Lines and Vertical lines. For each line, X/Y coordinates will be listed for the start and stop points. Each line is a separate object in <code>{}</code> brackets. (X1,Y1) is the start position of the line. (X2, Y2) is the end position of the line.

	Below is an example of lines in the ~~LayoutData~~.json file. This example comes from a small table with four columns and four rows:		Below is an example of lines in the ''Grooper.Layout.json'' file. This example comes from a small table with four columns and four rows:

	<pre>		<pre>
Line 171:		Line 168:
	=== OMR Checkboxes ===		=== OMR Checkboxes ===

	Each OMR checkbox identified will be stored in the Grooper.Layout.json file with X/Y coordinates for the bounding rectangle and an IsChecked boolean flag.		Each OMR checkbox identified will be stored in the ''Grooper.Layout.json'' file with X/Y coordinates for the bounding rectangle and an IsChecked boolean flag.
	* The "Bounds" are the checkbox's coordinates, expressed as a bounding rectangle. (X1, Y1) is the top left corner of the rectangle. (X2, Y2) is the bottom right corner of the rectangle.		* The "Bounds" are the checkbox's coordinates, expressed as a bounding rectangle. (X1, Y1) is the top left corner of the rectangle. (X2, Y2) is the bottom right corner of the rectangle.
	* The "IsChecked" flag indicates whether the corresponding OMR checkbox is filled in (checked).		* The "IsChecked" flag indicates whether the corresponding OMR checkbox is filled in (checked).

	Below is an example of an OMR checkbox in the Grooper.Layout.json file:		Below is an example of an OMR checkbox in the ''Grooper.Layout.json'' file:

	<pre>		<pre>
Line 193:		Line 190:
	=== Barcodes ===		=== Barcodes ===

	Each barcode identified will be stored in the Grooper.Layout.json file with information regarding the barcode type (symbology), X/Y coordinates for the bounding rectangle, confidence score, orientation, and value.		Each barcode identified will be stored in the ''Grooper.Layout.json'' file with information regarding the barcode type (symbology), X/Y coordinates for the bounding rectangle, confidence score, orientation, and value.
	* The "Bounds" are the barcodes coordinates, expressed as a bounding rectangle. (X1, Y1) is the top left corner of the rectangle. (X2, Y2) is the bottom right corner of the rectangle.		* The "Bounds" are the barcodes coordinates, expressed as a bounding rectangle. (X1, Y1) is the top left corner of the rectangle. (X2, Y2) is the bottom right corner of the rectangle.
	* The "BarcodeType" is an integer which represents a corresponding barcode symbology. As an example, a BarcodeType of 8 indicates that this Barcode uses the Code 128 symbology.		* The "BarcodeType" is an integer which represents a corresponding barcode symbology. As an example, a BarcodeType of 8 indicates that this Barcode uses the Code 128 symbology.
Line 199:		Line 196:
	* The "Value" is the decoded value from the barcode.		* The "Value" is the decoded value from the barcode.

	Below is an example of a barcode in the Grooper.Layout.json file:		Below is an example of a barcode in the ''Grooper.Layout.json'' file:
	<pre>		<pre>
	"Barcodes": [		"Barcodes": [
Line 218:		Line 215:
	=== Shapes ===		=== Shapes ===

	Each barcode identified will be stored in the Grooper.Layout.json file with information about it's X/Y location and, importantly to how this information is used in Grooper, the shape's name.		Each barcode identified will be stored in the ''Grooper.Layout.json'' file with information about it's X/Y location and, importantly to how this information is used in Grooper, the shape's name.
	* The "Bounds" are the shapes coordinates, expressed as a bounding rectangle. (X1, Y1) is the top left corner of the rectangle. (X2, Y2) is the bottom right corner of the rectangle.		* The "Bounds" are the shapes coordinates, expressed as a bounding rectangle. (X1, Y1) is the top left corner of the rectangle. (X2, Y2) is the bottom right corner of the rectangle.
	* The "ShapeName" is the detected shapes name (as given in the Shape Detection/Shape Removal's "Shape Name" property).		* The "ShapeName" is the detected shapes name (as given in the Shape Detection/Shape Removal's "Shape Name" property).
Line 225:		Line 222:
	* The "Scale" is the scale to the sample image. A value of "1" indicates it is the same size as the sample.		* The "Scale" is the scale to the sample image. A value of "1" indicates it is the same size as the sample.

	Below is an example of a shape in the Grooper.Layout.json file:		Below is an example of a shape in the ''Grooper.Layout.json'' file:
	<pre>		<pre>
	"Shapes": [		"Shapes": [