Class DetectAnomalyResult

java.lang.Object
software.amazon.awssdk.services.lookoutvision.model.DetectAnomalyResult
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DetectAnomalyResult.Builder,DetectAnomalyResult>
@Generated("software.amazon.awssdk:codegen") public final class DetectAnomalyResult extends Object implements SdkPojo, Serializable, 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:

  • Method Details

    • source

      public final ImageSource 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

      public final Boolean 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

      public final Float 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 the isEmpty() 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

      public final List<Anomaly> 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

      public final SdkBytes 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 the color 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 the color field of the PixelAnomaly object.

      An image classification model doesn't return an Anomalies list.

    • toBuilder

      public DetectAnomalyResult.Builder 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 interface ToCopyableBuilder<DetectAnomalyResult.Builder,DetectAnomalyResult>
      Returns:
      a builder for type T

    • builder

      public static DetectAnomalyResult.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DetectAnomalyResult.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.