Class DetectAnomalyResult
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DetectAnomalyResult.Builder,
DetectAnomalyResult>
The prediction results from a call to DetectAnomalies. DetectAnomalyResult
includes
classification information for the prediction (IsAnomalous
and Confidence
). If the model
you use is an image segementation model, DetectAnomalyResult
also includes segmentation information (
Anomalies
and AnomalyMask
). Classification information is calculated separately from
segmentation information and you shouldn't assume a relationship between them.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionIf the model is an image segmentation model,Anomalies
contains a list of anomaly types found in the image.final SdkBytes
If the model is an image segmentation model,AnomalyMask
contains pixel masks that covers all anomaly types found on the image.static DetectAnomalyResult.Builder
builder()
final Float
The confidence that Lookout for Vision has in the accuracy of the classification inIsAnomalous
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Anomalies property.final int
hashCode()
final Boolean
True if Amazon Lookout for Vision classifies the image as containing an anomaly, otherwise false.static Class
<? extends DetectAnomalyResult.Builder> final ImageSource
source()
The source of the image that was analyzed.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
source
The source of the image that was analyzed.
direct
means that the images was supplied from the local computer. No other values are supported.- Returns:
- The source of the image that was analyzed.
direct
means that the images was supplied from the local computer. No other values are supported.
-
isAnomalous
True if Amazon Lookout for Vision classifies the image as containing an anomaly, otherwise false.
- Returns:
- True if Amazon Lookout for Vision classifies the image as containing an anomaly, otherwise false.
-
confidence
The confidence that Lookout for Vision has in the accuracy of the classification in
IsAnomalous
.- Returns:
- The confidence that Lookout for Vision has in the accuracy of the classification in
IsAnomalous
.
-
hasAnomalies
public final boolean hasAnomalies()For responses, this returns true if the service returned a value for the Anomalies property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
anomalies
If the model is an image segmentation model,
Anomalies
contains a list of anomaly types found in the image. There is one entry for each type of anomaly found (even if multiple instances of an anomaly type exist on the image). The first element in the list is always an anomaly type representing the image background ('background') and shouldn't be considered an anomaly. Amazon Lookout for Vision automatically add the background anomaly type to the response, and you don't need to declare a background anomaly type in your dataset.If the list has one entry ('background'), no anomalies were found on the image.
An image classification model doesn't return an
Anomalies
list.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAnomalies()
method.- Returns:
- If the model is an image segmentation model,
Anomalies
contains a list of anomaly types found in the image. There is one entry for each type of anomaly found (even if multiple instances of an anomaly type exist on the image). The first element in the list is always an anomaly type representing the image background ('background') and shouldn't be considered an anomaly. Amazon Lookout for Vision automatically add the background anomaly type to the response, and you don't need to declare a background anomaly type in your dataset.If the list has one entry ('background'), no anomalies were found on the image.
An image classification model doesn't return an
Anomalies
list.
-
anomalyMask
If the model is an image segmentation model,
AnomalyMask
contains pixel masks that covers all anomaly types found on the image. Each anomaly type has a different mask color. To map a color to an anomaly type, see thecolor
field of the PixelAnomaly object.An image classification model doesn't return an
Anomalies
list.- Returns:
- If the model is an image segmentation model,
AnomalyMask
contains pixel masks that covers all anomaly types found on the image. Each anomaly type has a different mask color. To map a color to an anomaly type, see thecolor
field of the PixelAnomaly object.An image classification model doesn't return an
Anomalies
list.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DetectAnomalyResult.Builder,
DetectAnomalyResult> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-