predict
Description
calculates the unnormalized anomaly scores predicted by an anomaly detector during inference
for a set of test images, scores
= predict(detector
,I
)I
. Use this function to get predictions from
the output layers of the detector during inference.
Note
This functionality requires Deep Learning Toolbox™ and the Computer Vision Toolbox™ Automated Visual Inspection Library. You can install the Computer Vision Toolbox Automated Visual Inspection Library from Add-On Explorer. For more information about installing add-ons, see Get and Manage Add-Ons.
specifies options using one or more name-value arguments. For example,
scores
= predict(detector
,I
,Name=Value
)predict(detector,I,MiniBatchSize=32)
limits the batch size to
32.
Examples
Calculate Optimal Anomaly Threshold
Load calibration images and corresponding labels, then create a datastore that reads the calibration data. The data set consists of grayscale images of handwritten digits 0–9.
[Xcal,gtLabels] = digitTest4DArrayData; dsCal = arrayDatastore(Xcal,IterationDimension=4);
Load a pretrained FCDD anomaly detector. This detector has been trained to classify the digit 8 as normal and all other digits as anomalies. Therefore, specify the set of anomaly labels as the set of digits between 0 and 9, excluding 8.
load("digit8AnomalyDetector.mat"); anomalyLabels = setdiff(string(0:9),"8");
Predict the anomaly score of each calibration image.
scores = predict(detector,dsCal);
Calculate the optimal threshold and corresponding ROC metrics from the anomaly scores and ground truth labels.
[T,roc] = anomalyThreshold(gtLabels,scores,anomalyLabels)
T = single
2.9632e-04
roc = rocmetrics with properties: Metrics: [4976x4 table] AUC: 0.9114
Set the Threshold
property of the FCDD anomaly detector as the optimal threshold.
net.Threshold = T;
Input Arguments
detector
— Anomaly detector
fcddAnomalyDetector
object | fastFlowAnomalyDetector
object (since R2023a) | patchCoreAnomalyDetector
object (since R2023a)
Anomaly detector, specified as an fcddAnomalyDetector
object, a fastFlowAnomalyDetector
object, or a patchCoreAnomalyDetector
object.
I
— Test image
numeric array | datastore | formatted dlarray
object
Test image, specified in one of these formats:
Format | Supported Detectors |
---|---|
M-by-N-by-3 numeric array representing a truecolor image. | FCDD, FastFlow, PatchCore |
M-by-N-by-3-by-B numeric array representing a batch of B truecolor images. | FCDD, FastFlow, PatchCore |
Datastore that reads and returns truecolor images. The images must all have the same size. | FCDD, FastFlow, PatchCore |
Formatted | FCDD, FastFlow |
FCDD anomaly detectors also support grayscale test images, with one color channel instead of three.
Name-Value Arguments
Specify optional pairs of arguments as
Name1=Value1,...,NameN=ValueN
, where Name
is
the argument name and Value
is the corresponding value.
Name-value arguments must appear after other arguments, but the order of the
pairs does not matter.
Example: MiniBatchSize=32
MiniBatchSize
— Size of batches
128
(default) | positive integer
Size of batches for calculating predictions, specified as a positive integer. Larger batch sizes lead to faster processing but take up more memory.
ScoreFunction
— Function for computing scalar score from anomaly map
function handle
Function for computing a scalar score from an anomaly map when detector
is an fcddAnomalyDetector
object or a fastFlowAnomalyDetector
object, specified as a function handle. The
function handle ScoreFunction
must represent a function that
accepts the input data I
and
returns an output in the form of a numeric scalar. I
must be
2-D numeric image data, dlarray
data with two spatial dimensions,
or a datastore. The default value of ScoreFunction
depends on the
type of detector specified:
Detector Specified in detector Argument | Default ScoreFunction Value |
---|---|
FastFlow |
|
FCDD |
|
PatchCore | Not supported |
ExecutionEnvironment
— Hardware resource
"auto"
(default) | "gpu"
| "cpu"
Hardware resource on which to run the detector, specified as
"auto"
, "gpu"
, or "cpu"
.
The table shows the valid hardware resource values.
Resource | Action |
---|---|
"auto" | Use a GPU if it is available. Otherwise, use the CPU. |
"gpu" | Use the GPU. To use a GPU, you must have Parallel Computing Toolbox™ and a CUDA® enabled NVIDIA® GPU. If a suitable GPU is not available, the function returns an error. For information about the supported compute capabilities, see GPU Computing Requirements (Parallel Computing Toolbox). |
"cpu" | Use the CPU. |
Output Arguments
Extended Capabilities
C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.
Usage notes and limitations:
The size of
I
must be fixed at code generation time.The only name-value argument supported for code generation is
MiniBatchSize
. The name-value argument must be a compile-time constant.
GPU Code Generation
Generate CUDA® code for NVIDIA® GPUs using GPU Coder™.
Usage notes and limitations:
The size of
I
must be fixed at code generation time.GPU code generation does not support
gpuArray
inputs.GPU code generation supports inputs that are defined as half-precision floating point data types. For more information, see
half
(GPU Coder).The only name-value argument supported for code generation is
MiniBatchSize
. The name-value argument must be a compile-time constant.
Version History
Introduced in R2022bR2024a: Option to specify custom anomaly score function for FastFlow and FCDD detectors
Specify a custom anomaly score function, which the predict
function
uses to compute a scalar score from the anomaly map, by using the ScoreFunction
name-value argument.
R2023a: Support for FastFlow and PatchCore anomaly detectors
You can now specify the detector
argument as a fastFlowAnomalyDetector
object or a patchCoreAnomalyDetector
object.
R2023a: Support for C and GPU code generation
predict
now supports the
generation of C code (requires MATLAB®
Coder™) and optimized CUDA code (requires GPU Coder™).
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)