Differences

This shows you the differences between two versions of the page.

Link to this comparison view

engine:7.3:admininterface [2018/02/01 18:15] (current)
Line 1: Line 1:
 +===== Introduction: ​ LTU engine Administrative Interface =====
 +
 +Both **LTU engine /server** and **LTU engine /ON demand** share the same Administrative Interface.
 +\\ 
 +\\ 
 +{{ :​engine:​7.0:​ltu-engine-user-guide-009.jpg?​nolink&​ |}}
 +
 +However, there are certain differences in
 +  *feature availability
 +  *API syntax
 +
 +In this document, these differences are noted by text marked with this symbol: ​ :!:
 +<​html>​
 +<​pagebreak>​
 +</​html>​
 +===== Administrative Interface: ​ LTU engine/​server =====
 +
 +Creating new and managing existing applications are possible via the Administrative Interface of LTU engine/​server. ​ However, application paramenters should be modified only as instructed by JASTEC France support.
 +
 +===== Administrative Interface: ​ LTU engine/ON demand =====
 +Monitoring the performance of applications and authorizing IP access have been the primary purpose of the LTU engine/ON demand administrative interface.
 +
 +The creation and configuration of applications remains the responsibility of JASTEC France support. ​
 +
 +New features were added to the Administrative Interface in July 2012:  These include the **Image Management** tab which is detailed in this document. ​
 +
 +Also, Visual Query Logs may be activated on individual applications (to activate Visual Query Logs, please contact JASTEC France support. ​
 +
 +===== Notable Features Common to Both =====
 +  *Image Management - Browse Images
 +  *Image Management - Bounce Search with Display of Matching Zones
 +  *Image Management - Batch Processes via the Administrative Interface
 +  *Statistics - Numeric and Graphical
 +  *Statistics - Visual Query Logs
 +\\ 
 +
 +<​html>​
 +<​pagebreak>​
 +</​html>​
 +
 +===== Applications =====
 +
 +==== Manage Applications - Applications Dashboard ====
 +{{ :​engine:​7.0:​ltu-engine-user-guide-003.jpg?​nolink&​ |}}
 +The Dashboard displays information about all applications (Active and Inactive)
 +
 +  ***Active Applications ** Includes graphic indicators of the status of each application.
 +
 +  ***Inactive Applications** Information on applications which are still present on the disk storage system but are not loaded into memory, thus not available for queries
 +
 +  ***Get Image ID's ** For creation and download of a .csv file containing the image ID's and keywords for all images in the application.\\ ​
 +\\ 
 +
 +
 +
 +==== Application Parameters - Display and Update ====
 +\\ 
 +\\ 
 +{{ :​engine:​7.0:​ltu-engine-user-guide-004.jpg?​nolink&​ |}}
 +
 +\\ 
 +**Reminder: ​ Application parameters should not be changed unless advised by JASTEC France support.**
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +  ***Name: ​ **Application Name may be changed here at any time without affecting operations. ​ Application names should contain no accents or special characters. ​ Spaces are permitted. ​ Maximum name length: ​ 256 charcters.
 +
 +  ***Status: ​ **Unchecking this box will make the application Inactive. ​ Image signatures are unloaded from system memory.
 +
 +  ***Application Search DNA:  **Different from the "​**Application DNA**",​ the "​**Application Search DNA**" is a parameter for certain types of **Image Matching** applications. It functions on __external images__, creating a larger, more detailed image signature, which is effective in applications where query images may be of varying quality, such as mobile applications.\\ ​
 +
 +For information on signatures, see section **Create Application**
 +
 + 
 +
 +  ***Color Weight ​ **Applicable only to "Image Similarity"​ applications."​Color Weight"​ is the default color weight used when not specified in the query (SearchImageByDna ​ or SearchImageByUpload). ​ Default: ​ "​50"​ (balance between Color and Shape). ​ Weighted for form:  "​0"​. ​ Weighted for color: ​ '​100"​.
 +
 +  ***Save query logs days** ​ This affects the Batch search reports as well as invididual queries.  ​
 +
 +  ***Number of Results: **  Default number of results when not specified in the query. ​ Applies to API queries as well as to queries via the Admin Interface (number of bouce results, displayed, for example).
 +
 +  ***Retrieval Threshold: ​ **  Threshold on retrieval results. Image with a score superior to this threshold will NOT be returned. -1 means no threshold.
 +
 +  ***Comments: ​ **Any comments describing specifics of the application.  ​
 +
 +==== Application Status ====
 +
 +  ***Last Add:  **Time elapsed since last AdImage, whether effected via the API or via the Admin Interface. ​
 +
 +  ***Last Search: ​ **Time elapsed since last SearchImage,​ whether effected via the API or via the Admin Interface. ​
 +
 +  ***Number of Kimas: ​ **  Number of kima processes associated with this application. ​ This number is automtically adjusted by the system may not be modified via the Admin Interface.  ​
 +
 +  ***Images: ​ ** Total number of images in the application.
 +
 +  ***Keywords: ​ **Since individual images may have multiple keywords, this number may be larger than the number of images.\\ Reminder - for images enrolled via the Admin Interface (Image Management, batch process, Add images) keywords are automatically generated if the submitted zip file is organized by subdirectories. ​ Keywords are generated for all levels of the file hierarchy.\\ \\ Also see the API Methods section (AddImage and SearchImage...) for additional information about **keywords**.
 +==== Advanced Management Status Information ====
 +
 +  ***Update messages and codes: ​ ** Values are:
 +  - the application has never been updated by the manager process
 +  - the application is currently queued for update
 +  - an update is currently running for the application
 +  - an update has already been run for this application (normal state)
 +  - an update failed
 +
 +
 +  ***Next update: ​ **  Applications are automatically when necessary
 +
 +  ***Last generation: ​ ** "​Generation"​ means update of the application.
 +==== Advanced Actions: ​ Update, Rebuild, Reload ====
 +
 +Unless instructed by JASTEC France support, it is generally unnecessary to perform these actions.
 +\\ 
 +\\ **__Note: None of the following actions deletes data from disk storage.__**\\ ​ \\ These actions concern the reloading of data elements into system memory. ​ An application is temporarily disabled during the execution of these functions.\\ ​
 +
 +  ***Update Application:​** ​ Adds new elements, such as new image signatures, to system memory. However, this is done automatically during standard update procedures, such as AddImage or addImageBatch. ​
 +
 +  ***Rebuild Application:​ ** Unload and Reload: ​ unloads the application from system memory, and completely reloads the application from the database.
 +
 +  ***Reload Configuration** ​ As distinguished from application **content** (which is updated or reloaded by Update and Rebuild Application),​ this action reloads application **parameters**. ​ However, this is done automatically "Apply Modifications"​ is selected after application parameters are modified.\\ ​
 +
 +
 +==== Application information (display only) ====
 +
 +  ***Creation Date: ** Date creation of the application.
 +  ***Application Key: **  The application key is generated at aplication creation and may not be changed.
 +
 +  ***Public Key:  ** While the Application Key is necessary for effecting API queries, the **Public Key** is necesary for accessing content elements stored on disk, such as images. ​ \\ For example: ​ http://​hostaddress:​8888/​image/​E3D57368JVu5qE6m/​4bb81872d60245474b97f50076fb4a80\\ "​E3D57368JVu5qE6m"​ is the public key;   "​4bb81872d60245474b97f50076fb4a80"​ is the image checksum (MD5).
 +
 +  ***Application DNA Type:  ** Displayed in long form:  70001000 = 70.1.1.\\ Application DNA type cannot be changed once an application is created. ​ To change a DNA type for a set of images, a new application must be created, and the images must be indexed in the new application.
 +
 +  ***Application Type:  ** The category (Image Matching, Image Similarity) of the Application Type selected at application creation.
 +
 +  ***Folder path:  ** This is the location of the images of an application.
 +
 +  ***Database Location: ​ ** For information only;  significant only for special configurations involving a database on a separate server. ​
 +
 +  ***Retrieval Threshold: ​ ** Retrieval threshold currently in effect. May be modified via the "​Application parameters"​ form, if so advised by JASTEC France support. ​
 +
 +
 +<​html>​
 +<​pagebreak>​
 +</​html>​
 +
 +==== Create Application ====
 +
 +:!:  LTU engine/​server only.  For LTU engine/ON demand, applications are created by JASTEC France support.
 +
 +  ***Name:** Application names should be limited to fewer than 256 characters, with no accents or special characters. ​ Spaces are permitted.
 +
 +  ***Application Type:** The choice of "Image matching"​ or "Image similarity"​ determines which signatures will be displayed as available options for the application.
 +
 +  ***Application DNA:** Explained here following:
 +
 +**Matching Signatures**
 +
 +|< 100% 10% 10% 10% - >|
 +^ Type              ^ Signature ID  ^       ​Options ​       ^  Signature Size (bytes)\\ In Memory ​ ^ Use and Characteristics ​                                                                       ^
 +| Media Monitoring ​ | 65.0.0 ​       | Flip - Text          | 2056                                 | Media Monitoring - high speed indexation and retrieval in large applications. **Recommended** ​ |
 +| Mobile Matching ​  | 71.2.0 ​       | Asymetric Retrieval ​ | 14000 (average) ​                     | Mobile without text - more robust to text                                                      |
 +| Mobile Matching ​  | 71.2.2 ​       | Asymetric Retrieval ​ | 14000 (average) ​                     | Mobile - sensitive to text                                                                     |
 +| Brand Monitoring ​ | 71.2.4 ​       | Asymetric Retrieval ​ | 14000 (average) ​                     | Brand Monitoring - sensitive to text                                                           |
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +\\ 
 +**Asymetric Retrieval**: ​ Asymetric Retrieval is automatically activated for applications whose signature includes the option. Asymetric Retrieval applies to external queries (SearchByUpload): ​ a large temporary signature (not stored in the application) is calculated for the external query image, which is then compared with the application images.
 +
 +
 +<​html>​
 +<​pagebreak>​
 +</​html>​
 +**Similarity Signatures**
 +
 +|< 100% 10% 10% 10% - >|
 +^ Type        ^ Signature ID  ^ Options ​                     ^ Signature Size (bytes)\\ In Memory ​ ^ Use and Characteristics ​ ^
 +| Similarity ​ | 4.1.0         ​| ​ query weighting Color/​Form ​ | 1340                                | Image similarity search ​ |
 +
 +
 +
 +
 +
 +
 +**Color Signatures**
 +
 +|< 100% 10% 10% 10% - >|
 +^ Type                              ^ Signature ID  ^ Options ​                    ^ Signature Size (bytes)\\ In Memory ​ ^ Use and Characteristics ​                         ^
 +| Color                             | 8.0.0         | query weighting Color/​Form ​ | 897                                 | Dominant colors signature ​                       |
 +| Color without uniform background ​ | 8.1.0         | query weighting Color/​Form ​ | 897                                 | Same as 8.0 but with uniform background removal ​ |
 +
 +
 +
 +
 +<​html>​
 +<​pagebreak>​
 +</​html>​
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +===== Image Management =====
 +
 +==== Browse Images ====
 +The Browse Images feature of Image Managment allows a display of all images present in an application.
 +
 +Images are arranged chronologically (images last added are displayed first).
 +
 +Page controls allow browsing the entire database
 +
 +==== Browse Images - Search Image ====
 +
 +Any image selected via the Browse Images page may be used as a search query:
 +\\ 
 +\\ 
 +{{ :​engine:​7.0:​ltu-engine-user-guide-005.jpg?​nolink&​ |}}
 +
 +\\ 
 +Clicking on a result image shows a display of the matching zone.     
 +\\ 
 +\\ 
 +{{ :​engine:​7.0:​ltu-engine-user-guide-006.jpg?​nolink&​ |}}
 +
 +<​html>​
 +<​pagebreak>​
 +</​html>​
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +==== Run Batch Process ====
 +
 +=== Add Images ===
 +
 +For the selected application,​ images may be added by uploading a zip file.  Filenames must be unique across the zip file, since the filename is used as the image id.
 +
 +**Keywords:​** Keywords may be associated with images added via this process. ​ Folder names are used as keywords for the images. ​  This may include multiple levels. ​ In the example below, during indexation, images are assigned keywords according to where the image files are found in the folder directory tree.
 +\\ 
 +\\ 
 +{{ :​engine:​7.0:​ltu-engine-user-guide-010.jpg?​nolink&​ |}}
 +
 +A batch add process may be designated by a Report Name.  The report is timestamped and  may be accessed later to know the number of images enrolled.  ​
 +<​html>​
 +<​pagebreak>​
 +</​html>​
 +=== Search Images ====
 +Batches of images may be submitted as queries. ​  The batch search may be designated by a Report Name.  The batch search report maybe accessed later, and includes displays of the query images and the results. ​
 +\\ 
 +\\ 
 +{{ :​engine:​7.0:​ltu-engine-user-guide-012.jpg?​nolink&​ |}}
 +==== Previous Batch Processes ====
 +
 +Batch processes described above are accessed via these links. ​
 +<​html>​
 +<​pagebreak>​
 +</​html>​
 +==== Advanced Usage: ​ Test API Queries ====
 +This page provides a simple way to understand the functioning of the principal queries. ​ For the selected application,​ query parameters may be entered via the screen interface. ​  The display then shows both the json response and,if applicable, the associated images. ​
 +\\ 
 +\\ 
 +{{ :​engine:​7.0:​ltu-engine-user-guide-011.jpg?​nolink&​ |}}
 +<​html>​
 +<​pagebreak>​
 +</​html>​
 +
 +===== Statistics =====
 +
 +The Statistics tab gives access to numeric and graphical measures of system utilization.
 +
 +It also provides access to **Visual Query Logs**, which permit the viewing of all search queries effected on the system. ​  The logs display the query image and the results, ranked according to proximity score.
 +
 +{{ :​engine:​7.0:​ltu-engine-user-guide-007.jpg?​nolink&​ |}}
 +
 +\\ 
 +For applications using one of the Matching signatures, the Query Logs view permits the viewing of teh "​Matching Zone"​. ​  ​Clicking on any one of the result images displays the Matching Zone for the query image and the result image:
 +\\ 
 +
 +\\ 
 +{{ :​engine:​7.0:​ltu-engine-user-guide-008.jpg?​nolink&​ |}}
 +
 +<​html>​
 +<​pagebreak>​
 +</​html>​
 +