Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
eVision 26.10.0-beta.2.dev documentation
Light Logo Dark Logo
eVision 26.10.0-beta.2.dev documentation
  • What’s New
    • Release Notes
      • eVision 26.10
    • Changelog
  • Getting Started with eVision
    • Installing eVision
    • Managing your Licenses
    • First Steps with eVision
    • eVision Studio
      • Navigating the Interface
      • Running Tools on Images
      • Displaying Images
      • Working with a Region
  • Using eVision
    • Basic Operations
      • Image Operations
        • Pixel Containers and Files
        • Loading a Pixel Container File
        • Saving a Pixel Container File
        • Memory Allocation
        • Drawing in Images
        • 3D Rendering of 2D Images
      • Regions and ROIs
        • Regions Of Interest (ROI)
        • Arbitrarily Shaped ROI (ERegion)
        • Flexible Masks
      • Frames and Alignment
      • Common Data Types
        • Vectors
        • Geometrical Shapes
      • Error Reporting
      • Utility Functions
        • Timing
        • Locating Installation Folders
    • General Purpose Libraries
      • EasyImage - Pre-Processing Images
        • Intensity Transformation
        • Thresholding
        • Profile
        • Arithmetic and Logic
        • Linear Filtering
        • Non-Linear Filtering
        • Geometric Transforms
        • Noise Reduction and Estimation
        • Scalar Gradient
        • Vector Operations
        • Canny Edge Detector
        • Harris Corner Detector
        • Overlay
        • Operations on Interlaced Video Frames
        • Computing and Using Image Statistics
        • Fourier Transform
        • Gabor Filter
        • HDR Fusion
        • Image Stitching
      • EasyColor - Pre-Processing Color Images
        • Bayer Conversion
        • Lookup Table Operations
    • Matching and Measurement
      • EasyObject - Analyzing Blobs
        • Encoding an Image
        • Objects, Holes and their Features
        • Selecting and Sorting Blobs
        • Object Template Matcher
        • EChecker - Validating Golden Templates
      • EasyGauge - Measuring down to Sub-Pixel
        • Differences with the Legacy API
        • Legacy EasyGauge
          • Workflow
          • Gauge Definitions
          • Find Transition Points Using Peak Analysis
          • Find Shapes Using Geometric Models
          • Gauge Manipulation: Draw, Drag, Plot, Group
          • Calibration and Transformation
          • Calibration Using EWorldShape
          • The Calibration Model
          • Unwarp an Image
      • EasyFind - Matching Geometric Patterns
        • Purpose and Principles
        • Learn a Pattern from Image(s)
        • Learn a Pattern from Vectors
        • Find Matches
      • EasyMatch - Matching Area Patterns
        • Learn a Pattern
        • Find Matches
    • Text and Code Reading
      • EasyBarCode - Reading Bar Codes
        • Using EasyBarCode
        • EasyMailBarCode - Reading Mail Bar Codes
        • EasyBarCode1 - Reading Bar Codes (deprecated)
      • EasyDeepOCR - Reading Texts with Deep Learning
        • Detailed Usage
        • Retraining a Model
        • Setting the Parameters
      • EasyOCR - Reading Texts
      • EasyOCR2 - Reading Complex Texts
        • Using EasyOCR2
        • Advanced Parameters
      • EasyMatrixCode - Reading Matrix Codes
        • Specifications and Supported Symbols
        • Using EasyMatrixCode
        • EasyMatrixCode1 - Reading Matrix Codes (deprecated)
          • Specifications
          • Supported Symbols
          • Workflow
          • Learning a Matrix Code
          • Computing the Print Quality
          • Using GS1 Data Matrix Codes
      • EasyQRCode - Reading QR Codes
        • Specifications
        • Using EasyQRCode
      • ECodeReader - Unified Interface
      • List of Supported Codes
      • Code Grading
        • ISO/IEC 15416 for 1D Bar Codes
        • ISO/IEC 15415 for Data Matrix and QR Codes
        • ISO/IEC 29158 for Data Matrix and QR Codes
        • SEMI T10-0701 for Data Matrix Codes
      • Comparison of OCR methods
    • Deep Learning Inspection
      • Deep Learning Studio
      • Workflow
        • Choose Your Tool
        • Managing the Dataset and the Annotations
        • Managing the Dataset Splits
        • Using Data Augmentation
        • Training a Deep Learning Tool
        • Using a Deep Learning Tool
        • Benchmarking a Deep Learning Tool
      • Execution Settings and Hardware Support (CPU/GPU)
      • EasyClassify - Multi-label Image Classification
      • EasySegment - Detecting and Segmenting Defects
        • EasySegment Unsupervised
        • EasySegment Supervised
      • EasyLocate - Locating Objects and Defects
    • 3D Processing
      • Easy3D - Tools for 3D Object Processing
        • Depth Map
        • Point Cloud
        • Mesh
        • ZMap
        • 3D Filters and Statistics
        • 3D Viewer
        • Photometric Stereo
      • Easy3DLaserLine - Laser Line Extraction and Calibration
      • Easy3DObject - Extracting 3D Objects
      • Easy3DMatch - 3D Alignment and Comparison
    • Applicative Processing
      • Easy Spot Detector - Detecting Spots with Deep Learning
    • Live Image Acquisition
      • EGrabberBridge - Using Images from eGrabber Sources
      • VimbaXBridge - Using Images from VimbaX Sources
    • Advanced Operations
      • Camera Calibration
        • Calibration Modes and Models
        • Computing the Calibration Model
        • Unwarping an Image
      • Multicore Processing
  • Resources
    • Code Snippets
      • Base Classes
        • Basic Types
          • Calibration
            • Dot Grid-Based Calibration
            • Landmark-Based Calibration
            • Calibration by Guesswork
            • Coordinates Transform
            • Image Unwarping
          • Loading and Saving Images
          • Interfacing Third-Party Images
          • Retrieving Pixel Values
          • Importing Bitmap from the Resources
          • ROI Placement
          • Vector Management
          • Exception Management
        • ERegion
          • Basic Usage
          • Prepare Once, Use Multiple Times
          • Combine Regions
          • Tool Chain
      • General Purpose
        • EasyImage
          • Thresholding
            • Single Thresholding
            • Double Thresholding
            • Histogram-Based Single Thresholding
            • Histogram-Based Double Thresholding
          • Arithmetic and Logic Operations
          • Convolution
            • Pre-Defined Kernel Filtering
            • User-Defined Kernel Filtering
          • Non-Linear Filtering
            • Morphological Filtering
            • Hit-and-Miss Transform
          • Vector Operations
            • Path Sampling
            • Profile Sampling
          • Statistics
            • Image Statistics
            • Sliding Windows Statistics
            • Histogram-Based Statistics
          • Noise Reduction by Integration
            • Temporal Noise Reduction
            • Recursive Average
          • Feature Point Detectors
            • Harris Corner Detector
            • Canny Edge Detector
          • Using an ERegion
          • Warping
            • Performing a Ring Warping
            • Performing an Inverse Warping
          • Fourier Transform
            • Performing a Direct Fourier Transform
            • Performing an Inverse Fourier Transform
          • HDR Fusion
            • Performing a HDR Fusion Using the Default Algorithm
            • Performing a HDR Fusion Using Specific Algorithms
            • Changing the HDR Fusion Algorithm or its Parameters
          • Performing a Resize Operation
          • Image Stitching
            • Image Stitching
            • Image Stitching with a Reference Image
            • Incremental Image Stitching
            • Image Stitching with Learning
          • Gabor filter
          • Scalar Gradient
          • Overlay
          • Intensity Transformation
            • Normalization
            • Normalization
        • EasyColor
          • Colorimetric Systems Conversion
          • Color Components
          • White Balance
          • Pseudo-Coloring
          • Bayer Pattern Decoding
      • Matching and Measurement
        • EasyObject
          • Image Segmenter
          • Continuous Mode
          • Holes Extraction
          • Computing Blobs Features
          • Looping over the runs of an object
          • Selecting and Sorting Blobs
          • Using the Object Template Matcher
          • EChecker
            • EChecker with a Single Image
            • EChecker with Multiple Images
        • EasyMatch
          • Pattern Learning
          • Setting Search Parameters
          • Pattern Matching and Retrieving Results
          • Pattern Learning with ERegion
        • EasyFind
          • Pattern Learning
          • Setting Search Parameters
          • Pattern Finding and Retrieving Results
          • Learning Using a DXF File
          • Legacy
            • Learning Using an EPolygonShape (Legacy)
        • EasyGauge
          • Point Location
          • Line Fitting
          • Circle Fitting
          • Rectangle Fitting
          • Wedge Fitting
          • Gauge Grouping
            • Complex Measurement
            • Legacy
              • Complex Measurement (Legacy)
              • Gauge Hierarchy (Legacy)
          • Calibration using EWorldShape (Legacy)
            • Calibration by Guesswork (Legacy)
            • Landmark-Based Calibration (Legacy)
            • Dot Grid-Based Calibration (Legacy)
            • Coordinates Transform (Legacy)
            • Image Unwarping (Legacy)
          • Legacy
            • Point Location (Legacy)
            • Line Fitting (Legacy)
            • Circle Fitting (Legacy)
            • Wedge Fitting (Legacy)
            • Rectangle Fitting (Legacy)
      • Text and Code Reading
        • EasyBarCode
          • Reading a Bar Code
          • Reading a Bar Code Following a Given Symbology
          • Reading a Grid of Bar Codes
          • Learning a Bar Code
          • Grading a Bar Code
          • Reading a Mail Bar Code
          • Reading a Bar Code
          • Reading a Bar Code Following a Given Symbology
          • Reading a Bar Code of Known Location
        • EasyDeepOCR
          • Reading a Text
          • Get Score
          • Specifying a Topology
          • Building a Sample List
          • Performing an Optimization
          • Splitting the Pipeline
          • Training and Using a Custom Model
        • EasyOCR
          • Learning Characters
          • Recognizing Characters
        • EasyOCR2
          • Detecting Characters
          • Learning Characters
          • Reading Characters
            • Reading Using TrueType Fonts
            • Reading Using EOCR2 Character Database
            • Reading Using EOCR2 Model File
          • View Bitmap
        • EasyMatrixCode
          • Reading Data Matrix Codes
          • Learning a Data Matrix Code
          • Reading a Grid of Matrix Codes
          • Grading a Data Matrix Code
          • Asynchronous Processing
          • Reading a Data Matrix Code
          • Learning a Data Matrix Code
          • Tuning the Search Parameters
          • Grading a Data Matrix Code
        • EasyQRCode
          • Reading QR Codes
          • Grading a QR Code
          • Reading a Grid of QR Codes
          • Retrieving Information of a QR Code
          • Tuning the Search Parameters
          • Retrieving the Decoded String (Simple)
          • Retrieving the Decoded String (Safe)
          • Retrieving the Decoded Data (Advanced)
        • ECodeReader
          • Reading a set of Code
      • Deep Learning
        • EasyClassify
          • Creating a Dataset and Training a Classifier
          • Learning Out Of Distribution parameters in a previously trained classifier
          • Loading a Classifier and Classifying a New Image
          • Using Multithreading for Classification
          • Using Out Of Distribution scores during classification
        • EasySegment
          • Creating a Dataset and Training a Supervised Segmenter
          • Creating a Dataset and Training an Unsupervised Segmenter
          • Loading a Supervised Segmenter and Segmenting an Image
          • Loading an Unsupervised Segmenter and Segmenting an Image
        • EasyLocate
          • Creating a Dataset and Training a Locator
          • Loading a Locator and Locating Objects on a New Image
      • 3D Processing
        • Easy3D
          • Using EFilters to Remove the Noise on a ZMap Based on the Standard Deviation
          • Using EFilters to Remove the Noise on a ZMap Based on the Derivation from Neighborhood
          • Aligning Point Clouds
          • Reducing the Size of a Cloud with Random Decimation
          • Reducing the Size of a Cloud with Grid Decimation
          • Using Photometric Stereo
          • Using Flat Images to Improve Photometric Stereo
          • Performing Plane Leveling on Point Clouds
          • Performing ZMap Leveling
          • Using an ERegion to Crop a ZMap
          • Add an Attribute to an EPointCloud with Initial Data
          • Add an Attribute to an EPointCloud without Initial Data
          • Retrieve an Attribute from an EPointCloud
        • Easy3DLaserLine
          • Object-Based Calibration
          • Load Object-Based Calibration Model
        • Easy3DMatch
          • E3DAligner Minimal Code
          • E3DAligner Reprojection Plane
          • E3DAlignment Align Sample
          • E3DComparer Minimal Sample
          • E3DComparer Advanced Sample
          • E3DMatcher Minimal Sample
          • E3DMatcher Advanced Sample
          • EPointCloudMerger Sample
        • Easy3DObject
          • Extracting 3D Objects with a Selection Criterion
          • Inspecting a Feature from the List of E3DObjects
          • Drawing 2D Features from a List of E3DObjects
          • Drawing 3D Features from a List of E3DObjects
      • Applicative Processing
        • EasySpotDetector
          • Detect Spots
          • Detect Scratches
          • Detect and Classify Spots
      • Live Image Acquisition
        • EGrabberBridge
          • Using EGrabberBridge
          • Using EGrabberBridge with Format Conversion
          • Managing EGrabber Parameters
          • Using EGrabber Discovery
        • VimbaX Bridge
          • Using VimbaXBridge
    • Application Examples
      • Inspecting Fuses
      • Inspecting Pads Using Regions
      • Checking Lot Codes and Mixing with OCR
      • Measuring a Remote Controller
      • Inspecting a PCB
      • Measuring the Warpage of a PCB
    • Sample Programs
      • Image Processing
        • Basic
        • BasicWPF
        • ConsoleBasic
        • Region
        • RegionFreeHand
        • EasyImageFilter
        • FourierFiltering
        • EasyColorComponent
        • EasyHDRFusion
        • EGrabberBridge
        • SharedLibraryConsole
      • 3D Processing
        • Easy3DViewer
        • Easy3DViewerWPF
        • Easy3DPhotometricStereo
        • Easy3DPointCloudToMesh
        • Easy3DZMapGenerator
        • Easy3DProcessing2D
        • Easy3DMultiViews
        • Easy3DPCBWarpage
        • Easy3DCoaxlinkLLE
        • Easy3DLaserLineCalibration
        • Easy3DLaserLineExtract
        • Easy3DObjectExtract
        • Easy3DMatchMatch
        • Easy3DMatchAlign
        • Easy3DMatchPointCloudMerger
      • Matching and Measurement
        • EasyGaugeBasic
        • EasyGaugeRegion
        • EasyGaugePolygon
        • EasyFindLearn
        • EasyFindVectorLearn
        • EasyMatchLearn
        • EasyObjectEChecker2
        • EasyObjectInertia
      • Deep Learning Inspection
        • EasyClassifyTrain
        • EasyClassifyInference
        • EasyClassifyMultiThreadInference
        • EasySegmentSupervisedTrain
        • EasySegmentSupervisedInference
        • EasySegmentSupervisedMultiThreadInference
        • EasySegmentUnsupervisedTrain
        • EasySegmentUnsupervisedInference
        • EasyLocateTrain
        • EasyLocateInference
        • EasyLocateMultiThreadInference
      • Text and Code Reading
        • EasyCodeReading
        • EasyBarCodeRead
        • EasyBarCodeReadMail
        • EasyMatrixCodeRead
        • EasyQRCodeRead
        • EasyOcrRead
        • EasyOcr2Read
        • EasyDeepOCRRead
        • EasyDeepOCRReadConsole
      • Applicative Processing Tools
        • EasySpotDetector
      • Python Specific
        • egrabber_acquisition
        • openCV_acquisition (OpenCV Camera Acquisition)
        • easy3d_viewer
        • easy_find_learn
        • easy_gauge_basic
        • vimbax_acquisition
        • Base Web
        • Basic Tkinter
  • Download eVision

Api Documentation

  • C++ Api Documentation
  • .NET Api Documentation
  • Python API Documentation
  • Library API Guide
    • Base Classes API Guide
      • Easy Class
      • Image and ROI Classes
      • Region Classes
    • General Purpose API Guide
      • EasyImage Library
      • EasyColor Library
    • Matching and Measurement API Guide
      • EasyObject Library
        • EasyObject Library (Legacy)
      • EasyMatch Library
      • EasyFind Library
      • EasyGauge Library
        • EasyGauge Library (Legacy)
    • Text and Code Reading API Guide
      • EasyBarCode API Guide
      • EasyDeepOCR Library
      • EasyOCR Library
      • EasyOCR2 Library
      • EasyMatrixCode Library
      • EasyQRCode Library
    • Deep Learning API Guide
      • EasyClassify Library
      • EasySegment Library
      • EasyLocate Library
    • 3D Processing API Guide
      • Easy3D Library
      • Easy3DLaserLine Library
      • Easy3DMatch Library
      • Easy3DObject Library
    • Applicative Processing API Guide
      • EasySpotDetector Library
  • Deprecation table

About

  • Conventions
    • Image and Depth Map Buffer
    • Image Coordinate Systems
    • Conventions for Strings
    • eVision Version Numbering
  • Glossary
  • About Documentation
  • Third Party Licenses
Back to top

Base Classes API Guide¶

This section details the main API functionalities for common eVision classes.

../../_images/easyimage.webp

Easy
../../_images/easyimage.webp

Image and ROI Classes
../../_images/regions_epolygonregion_example.webp

Region Classes
Next
Easy Class
Previous
Library API Guide
Copyright © 2026, Euresys
Made with Sphinx and @pradyunsg's Furo