Search
Related topics are listed below.
Python API
Python API
Welcome to MIPAR Python API documentation. This documentation will describe the library capabilities and outline some example workflows. Topics Introduction Install and Activate System Requirements Library Release Notes
REST API
REST API
Welcome to MIPAR REST API documentation. This documentation will describe the library capabilities and outline some example workflows. !The REST API is still in Beta and under active development. Updates will be posted in the Release…
v3.4.0 API Release Notes
Python API » Release Notes » v3.4.0 API Release Notes
Functionality All engine changes have been brought over from: v3.4.0 exeRecipe now accepts a python numpy array as an input: exeRecipe added aboutAPI method which returns the API version, and license status: aboutAPI Hotfixes 3.4.0.2 Summary stats of some…
v3.4.1 API Release Notes
Python API » Release Notes » v3.4.1 API Release Notes
Functionality All engine changes have been brought over from: v3.4.1 Measurement keys no longer contain the units and the spelling was corrected.
v3.4.2 API Release Notes
Python API » Release Notes » v3.4.2 API Release Notes
Functionality All engine changes have been brought over from: v3.4.2
v3.4.4 API Release Notes
Python API » Release Notes » v3.4.4 API Release Notes
Functionality setPref: this method can now be used to update the GPU device selection by passing in the ‘gpuDeviceChoice’ key with an integer starting with 1 for the first GPU device on the system. All engine changes have been brought over from:…
v4.0.0 API Release Notes
Python API » Release Notes » v4.0.0 API Release Notes
Notes All engine changes have been brought over from: v4.0.0 Support for Windows 11 systems Support for Python 3.7, 3.8 and 3.9. Note API no longer supports Python 3.6
v4.0.1 API Release Notes
Python API » Release Notes » v4.0.1 API Release Notes
Notes All engine changes have been brought over from: v4.0.1
v3.3.1 API Release Notes
Python API » Release Notes » v3.3.1 API Release Notes
Functionality All engine changes have been brought over from: v3.3.0
v3.3.4 API Release Notes
Python API » Release Notes » v3.3.4 API Release Notes
Functionality All engine changes have been brought over from: v3.3.4, v3.3.3, and v3.3.2
v4.1.1 API Release Notes
Python API » Release Notes » v4.1.1 API Release Notes
Notes All engine changes have been brought over from: v4.1.1
v4.1.2 API Release Notes
Python API » Release Notes » v4.1.2 API Release Notes
Notes All engine changes have been brought over from: v4.1.2
v4.1.0 API Release Notes
Python API » Release Notes » v4.1.0 API Release Notes
Notes All engine changes have been brought over from: v4.1.0
v4.2.0 API Release Notes
Python API » Release Notes » v4.2.0 API Release Notes
Notes All engine changes have been brought over from: v4.2.0
v4.2.1 API Release Notes
Python API » Release Notes » v4.2.1 API Release Notes
Notes All engine changes have been brought over from: v4.2.1
v4.3.0 API Release Notes
Python API » Release Notes » v4.3.0 API Release Notes
Notes All engine changes have been brought over from: v4.3.0
v4.3.1 API Release Notes
Python API » Release Notes » v4.3.1 API Release Notes
Notes All engine changes have been brought over from: v4.3.1
v4.2.2 API Release Notes
Python API » Release Notes » v4.2.2 API Release Notes
Notes All engine changes have been brought over from: v4.2.2
v4.4.0 API Release Notes
Python API » Release Notes » v4.4.0 API Release Notes
Notes All engine changes have been brought over from: v4.4.0
Release Notes
Python API » Release Notes
v3.3.1 API Release Notes v3.3.4 API Release Notes v3.4.0 API Release Notes v3.4.1 API Release Notes v3.4.2 API Release Notes v3.4.4 API Release Notes
Introduction
REST API » Introduction
MIPAR REST API is a powerful tool that packages the MIPAR engine into a Docker Image Scope The MIPAR REST API was developed to meet the needs of customers who are already using MIPAR to do powerful image analysis, but would like to setup “headless”…
Introduction
Python API » Introduction
MIPAR API is a powerful tool that packages the MIPAR engine into a Python library. Scope The MIPAR API was developed to meet the needs of customers who are already using MIPAR to do powerful image analysis, but would like to setup “headless” workstations…
activatePK()
Python API » Library » activatePK()
!This function is available through version 3.2.2. In versions 3.2.3 and later, use activate() instead. The activatePK function is used to activate a MIPAR API license key using the command line. Arguments Args: productKey: MIPAR API product key formatted as raw…
GPU Support
Python API » System Requirements » GPU Support
Enable Only NVIDIA GPUs are supported for GPU computation at this time. Click here to learn more about the technical aspects and benefits of GPU computation. To enable GPU computation on the API Machine: Enable GPU computation on the recipe building workstation…
aboutAPI
Python API » Library » aboutAPI
The aboutAPI function is used get information about the API version and license status Arguments Args: no inputs Returns: aboutDictionary with the following keys: version: API version as a string active: returns 1 if the machine has an active license res: returns…
POST Method
REST API » POST Method
There are two commands that can be sent to the REST API using a POST call: process and activate Start the MIPAR REST API Docker image With docker hub running, execute the command docker run -it -p The can be set by the user, for example 8000:8000 and the is…
Error Code Troubleshooting
REST API » Error Code Troubleshooting
Error Cause Possible Solution STATUS 500 Docker container is not running Docker container is not reachable Check if the Docker container is running Check if the Docker is reachable by making a call on the host machine using a…
Install and Activate
Python API » Install and Activate
Standard Install Library Download the installation package provided to you by the MIPAR support team. Install python 3.7,3.8 or 3.9 Add python to Windows path Run MIPAR-API_v.x.x.x_InstallPack_Win.exe. Follow extraction and installation wizard instructions. The…
Getting Started
Getting Started
Welcome to the MIPAR User Manual! This manual is meant to complement the various tutorials and 1-on-1 training sessions available on the MIPAR website. It offers an overview of the each application, and provides a comprehensive description of the Image…
activate()
Python API » Library » activate()
!This function is available in versions 3.2.3 and later. In versions 3.2.2 and earlier, use activatePK() instead. The activate function is used to activate a MIPAR API license key using the command line. Arguments Args: productKey: MIPAR API product key or path to…
System Requirements
Python API » System Requirements
Supported Python Versions Only versions v3.7, 3.8, 3.9 Supported Operating Systems Windows (64-bit only) Windows 11 Windows 10 Windows 8.1 Windows 7 SP 1 Windows Server 2016 Windows Server 2012 R2 Windows Server 2012 Minimum System Requirements CPU:…
v1.1.0 Release Notes
REST API » Release Notes » v1.1.0 Release Notes
Bug Fixes Improved error handling when API failed to communicate with the license manager Improved warning handling when MIPAR recipe is out of sync with MIPAR version JSON output follows standard protocol for ‘NAN’ and ‘inf’…
Install and Activate
REST API » Install and Activate
Standard Image Install Docker is a prerequisite to install the REST API, you can download docker here: LINK MIPAR support team will request the workstation Windows Edition and Version to ensure the Docker Image is compatible Make sure Docker is running Run the…
Troubleshooting
Python API » Install and Activate » Troubleshooting
Error During Cause Possible Solution API is not able to find the MATLAB Runtime Startup MATLAB Runtime is not installed or is not added to the PATH Check if MATLAB Runtime is installed (default install directory:…
startLicenseMan()
Python API » Library » startLicenseMan()
The startLicenseMan method is used to initialize the license manager. You cannot execute recipes before initializing the licence manager, and it only needs to be executed once per instance of the application. *As of 3.2.3, it is not necessary to call this method…
Library
Python API » Library
This is the current list of methods in the MIPAR API Method Purpose Link initialize Initialize miparAPI library Link startLicenseMan Initialize license manager Link activatePK Activate product key…
Update Instructions
Python API » Update Instructions
Major Update (v _.x.x) Download the install pack from provided link Make sure the system is running a Python version that is compatible with the MIPAR Library Run MIPAR-API_vx.x.x_InstallPack.Win.exe and follow the wizard Minor Update (v x. _ . _) into Standard…
v3.3.4 Release Notes
Release Notes » v3.3.4 Release Notes
Improvements Translate Image now supports either black or white image padding API product will now appear in list after activation if on user’s license Bug Fixes Fixed bug which could cause Local Measurements to not launch properly Fixed bug where…
JSON Output
REST API » JSON Output
Process JSON Structure Output The process call returns a JSON structure that represents the recipe output. Field explanation: : any layers that were added to the recipe binary: the logical image that shows what was detected : statistic of any measurement that was…
v3.2.3 Release Notes
Release Notes » v3.2.3 Release Notes
New Functions Crop Image > Apply Last crops the image using the area defined in the last Crop Image step in the recipe. Bug Fixes Fixed bug with global measurement report printing Fixed bug with applying pre-loaded model from Deep Learning Trainer Fixed…
Installation Troubleshooting
Getting Started » Install and Activate » Installation Troubleshooting
Error Cause Possible Solution MIPAR crashes on starup or during launching of an app OR HASP API DLL dynamically unloaded with active logins MIPAR crashed on startup and thus did not properly log out of the license. This is a symptom…
Activation Troubleshooting
Getting Started » Install and Activate » Activation Troubleshooting
Error During Cause Possible Solution MIPAR crashes on starup or during launching of an app OR HASP API DLL dynamically unloaded with active logins Startup MIPAR crashed on startup and thus did not properly log out of the license.…