# API Deprecated Features

The following list of C and .NET functions are being deprecated, and will either be renamed or removed in the next major release.

Library | Obsolete Name | New Name
--- | --- | ---
.NET | ToolDatabase.GetOverlayImage() |
.NET | ViewKey.Filename | FrameKey.SampleName
.NET | LibraryAccess.SampleGetOverlayImage() |
.NET | IManualRegionOfInterest.External | IManualRegionOfInterest.Parameters.Mode
.NET | IManualRegionOfInterest.Mode | IManualRegionOfInterest.Parameters.Mode
.NET | IManualRegionOfInterest.Units | IManualRegionOfInterest.Parameters.Units
.NET | IManualRegionOfInterest.Offset | IManualRegionOfInterest.Parameters.Offset
.NET | IManualRegionOfInterest.Size | IManualRegionOfInterest.Parameters.Size
.NET | IManualRegionOfInterest.Angle | IManualRegionOfInterest.Parameters.Angle
.NET | IManualRegionOfInterest.SplittingGrid | IManualRegionOfInterest.Parameters.SplittingGrid
.NET | IBlueRegionOfInterest.Model | IBlueRegionOfInterest.Parameters.MatchFilter
.NET | IBlueRegionOfInterest.Models |
.NET | IBlueRegionOfInterest.TargetMode | IBlueRegionOfInterest.Parameters.TargetMode
.NET | IBlueRegionOfInterest.FeatureFilter | IBlueRegionOfInterest.Parameters.FeatureFilter
.NET | IBlueRegionOfInterest.MatchFilter | IBlueRegionOfInterest.Parameters.MatchFilter
.NET | IBlueRegionOfInterest.MatchItems | IBlueRegionOfInterest.Parameters.MatchItems
.NET | IBlueRegionOfInterest.MatchItemsMode | IBlueRegionOfInterest.Parameters.MatchItemsMode
.NET | IBlueRegionOfInterest.Centered | IBlueRegionOfInterest.Parameters.Centered
.NET | IBlueRegionOfInterest.Units | IBlueRegionOfInterest.Parameters.Units
.NET | IBlueRegionOfInterest.Offset | IBlueRegionOfInterest.Parameters.Offset
.NET | IBlueRegionOfInterest.Size | IBlueRegionOfInterest.Parameters.Size
.NET | IBlueRegionOfInterest.Angle | IBlueRegionOfInterest.Parameters.Angle
.NET | IBlueRegionOfInterest.Scaled | IBlueRegionOfInterest.Parameters.Scaled
.NET | IBlueRegionOfInterest.Scale | IBlueRegionOfInterest.Parameters.Scale
.NET | IRedRegionOfInterest.ExtractRegions | IRedRegionOfInterest.Parameters.ExtractRegions
.NET | IRedRegionOfInterest.RegionFilter | IRedRegionOfInterest.Parameters.RegionFilter
.NET | IRedRegionOfInterest.Units | IRedRegionOfInterest.Parameters.Units
.NET | IRedRegionOfInterest.Border | IRedRegionOfInterest.Parameters.Border
.NET | IRedRegionOfInterest.MaskRegions | IRedRegionOfInterest.Parameters.MaskRegions
.NET | IRedRegionOfInterest.FailOnFilter | IRedRegionOfInterest.Parameters.FailOnFilter
.NET | IRedRegionOfInterest.RecycleMask | IRedRegionOfInterest.Parameters.RecycleMask
.NET | IRedRegionOfInterest.InvertMask | IRedRegionOfInterest.Parameters.InvertMask
.NET | IRedRegionOfInterest.GrowShrinkMask | IRedRegionOfInterest.Parameters.GrowShrinkMask
.NET | IGreenRegionOfInterest.Filter | IGreenRegionOfInterest.Parameters.Filter
.NET | IMatch.FeatureString | IReadModelMatch.FeatureString
.NET | IMatch.PrettifiedString | IReadModelMatch.PrettifiedString
.NET | IMatch.Points | INodeModelMatch.NodePoints
.NET | IMatch.Pose | INodeModelMatch.Pose
.NET | IMatch.Position | IReadModelMatch.Position
.NET | IMatch.Scale | INodeModelMatch.Scale
.NET | IMatch.AspectRatio | INodeModelMatch.AspectRatio
.NET | IMatch.Shear | INodeModelMatch.Shear
.NET | IModel.Occurences | IModel.Occurrences
.NET | INode.Names | INode.Fielding
.NET | ITool.Parameters | ITool.ParameterBase
.NET | IFeature.Id | IFeature.Name
.NET | IRedView.Deviation | IRedView.Score
.NET | ITag.Key | ITag.Name
.NET | ITag.Value | ITag.Score
.NET | IWorkspace.Name | IWorkspace.UniqueName
.NET | IWorkspace.LastModification |
.NET | IToolDatabase.SetTrainFlag(string filter, string group) | IToolDatabase.SetTrainFlag(string filter, bool flag)
.NET | IToolDatabase.GetOverlayImage(ViewKey, string, uint) |
.NET | ILibraryAccess.ToolGetOverlay(WorkspaceName, StreamName, ToolName, string, uint, string, ILibraryAccessContext) |
.NET | IStream.AddImage(Image, string) IStream.AddImage(System.IO.Stream, string) GetImage(string, uint) |
.NET | ITool.Mask | ITool.RegionOfInterest.Mask
.NET | ITool.Parameters | ITool.ParametersBase
.NET | IToolParameters.TrainSelection |
.NET | IToolParameters.KeepTrainSelection |
.NET | BorderType.White BorderType.Reflect BorderType.Wrap |
.NET | Node.Names Node.IDs | Node.Fielding
.NET | ProductCode.OptimizedMemory | ProductCode.Standard ProductCode.Advanced
.NET | CalibratedRedView.Deviation |
.NET | TrainingFlagMode.Auto |
.NET | RedTool.IRedTool.Parameters | RedTool.IRedTool.BaseParameters
C | vidi_runtime_init_sample() | vidi_runtime_create_sample()
C | vidi_runtime_process() | vidi_runtime_sample_process()
C | vidi_runtime_process_sample() | vidi_runtime_sample_process()
C | vidi_runtime_get_image() | vidi_runtime_sample_get_image()
C | vidi_runtime_sample_get_overlay() | Use get_overlay for the specific tool.
C | vidi_training Training is the process that your tool, which is a neural network, is learning about the features (pixels) based on the labels you made. For example, a tool will learn the defect/normal pixels in each image based on the defect/normal labels you drew. The goal of the tool Training is learning enough to give the correct inspection results of whether an unseen image is defective or not. The key to training is to ensure that you include all possible variations within your training set, and that your images are accurately labeled. Training times vary by the application, tool setup and the GPU in the PC being used to train the network._tool_get_status() | vidi_training_stream_list_tools()
C | vidi_training_stream_process_sample() | vidi_training_sample_process()
C | vidi_training_blue_add_feature A feature is a visually distinguishable area in an image. Features typically represent something of interest for the application (a defect, an object, a particular component of an object).() | vidi_training_set_feature()
C | vidi_training_blue_add_model A specific spatial arrangement of a set of features (Blue Locate and Blue Read tools only.) During a post-processing step, the Blue Locate and Blue Read tools can fit all of the features detected in an image to the models defined for the tool. The overall pose and identity of the model is then returned.() | vidi_training_blue_create_model()
C | vidi_training_tool_set_mask() | vidi_training_roi_set_mask()
C | vidi_training_tool_get_mask() | vidi_training_roi_get_mask()
C | vidi_training_init_sample() | vidi_training_add_sample()
C | vidi_training_process_sample() | vidi_training_sample_process()
C | vidi_training_sample_get_overlay() |
C | vidi_training_tool_get_overlay() |
C | occurences | occurrences
C | names | fielding
C | red/mode | training/network_model
C | vidi_training_tool_train() | vidi_training_tool_train2()
C | vidi_initialize2() |
C++ | vidi_runtime_green_set_similarity_reference_views |
C++ | vidi_runtime_green_remove_similarity_reference_views |
C++ | vidi_runtime_green_list_similarity_reference_views |
C++ | vidi_runtime_green_train_similarity_model |
C++ | vidi_training_green_set_similarity_reference_views |
C++ | vidi_training_green_list_similarity_reference_views |
C++ | vidi_training_green_train_similarity_model |
C++ | vidi_training_tool_set_incremental_learning |
C++ | vidi_training_tool_unset_incremental_learning |
C++ | vidi_training_tool_adapt |
C++ | vidi_training_tool_set_pretrained_model |
C++ | vidi_training_tool_get_pretrained_model_info |
C++ | runtime_parameters/heat_map_on |
C++ | training_parameters/incremental |
C++ | runtime_parameters/process_with_trt (boolean) | runtime_parameters/trt_mode (string)
C++ | training_parameters/network_type |
C++ | training/red/exclusive |
C++ | gpu_hdm | gpu_standard
C++ | gpu_Hdm | gpu_Standard
C++ | visual_debugger_on |
C++ | visual_debugger_on | heat_map_on
C# | ViDi2.IGreenTool.SimilarityReferences |
C# | ViDi2.IGreenTool.TrainSimilarityModel |
C# | ViDi2.Training.SetIncrementalTrain |
C# | ViDi2.Training.UnsetIncrementalTrain |
C# | ViDi2.Training.ITool.Adapt |
C# | ViDi2.Training.ITool.SetPretrainedModel |
C# | ViDi2.Training.ITool.GetPretrainedModelInfo |
C# | ViDi2.Runtime.IGreenHighDetailParameters.HeatMapOn |
C# | ViDi2.Training.IToolParameters.Incremental |