Skip to Main Content
Cognex Support Hub
Logo
Home Support

Deep Learning Filter Grammar - Built-in variables | Generic View-Level variables

The grammar components of filter expressiosn within VIDI Suite and VisionPro Deep Learning are comprised of the following : Literal Values, Built-in variables, Operators, Functions and Regular Expressions.
 

11/26/2024

Details

Filter Grammar -Built-in variables

Generic View-Level variables

The following table list the names and types of all the supported filter variables. They can be used with any view, regardless of the Deep Learning tool.

Generic View variablesTypeNotes
newBoolReturns all the view that were added since the last training
anomalousBoolReturns samples where the image plane characteristics do not match the tool configuration
allBoolReturns all the views in the database
processedBoolReturns views with markings that were generated since the last training
maskedBoolReturns all views that contain a mask
invalidBoolReturns all views containing invalid labels, such as empty Blue Locate tool feature, or overlapping regions in a Red Analyze tool
trainedBoolReturns all views that were included in the training set
labeledBoolReturns all views that contain a label
sample_nameStringThe name of sample, which may be different if multi-channel samples are being used
filenameStringReturns the view with that filename
addedStringReturns the date when the image was added to the workspace
durationFloating PointReturns the last processing time for the view
indexFloating PointReturns an index of views in the enumeration of all views, from 0 to N-1. This is useful when you want to select a specific range of views.
view_indexFloating Point 
randomFloating PointReturns a random value. This is useful to shuffle views (when used to sort views) or to select a random set of views. For example, 'random < 0.5' would select half of the views.
widthFloating PointReturns views that match the specified width value
heightFloating PointReturns views that match the specified height value
difficultyFloating PointReturns views that match a unit-less measure of the degree of difficulty to train a view
setsString[]

Returns all of the views that are included in the specified set. This variable is unique, in that a vector of strings are specified in order to return a result. The following grammar summarizes the semantics of the equality, inequality and contains operators ('~') when applied to the sets variable :

  • sets = '<set_name>' // This returns true and the associated views if at least one element of sets is indentical to set_name.
  • sets != '<set_name>' // This returns true and the associated views if none of the elements of sets is identical to set_name.
  • sets ~ '<set_name>' // Returns true and the associated views if at least one element of a sets contains the string set_name.

Note : You can use the contains operator ('~') to perform partial matching. For example, this syntax can be used : sets ~"Plant 17" // This returns true for views that are members of Plant17, such as "Plant17-LineA" or "Plant17-LineB", but not "Plant18-LineA". 

Related Resources