Class DrawHeatmapStep

  • All Implemented Interfaces:
    ai.konduit.serving.pipeline.api.step.PipelineStep, ai.konduit.serving.pipeline.api.TextConfig, java.io.Serializable

    public class DrawHeatmapStep
    extends java.lang.Object
    implements ai.konduit.serving.pipeline.api.step.PipelineStep
    Draw a heatmap using 2D points.
    Heat will accumulate over the lifecycle of this step.
    Configuration:
    • points: Names of the points to be used for the heatmap. Accepts both single points and lists of points.
    • radius: Size of area influenced by a point.
    • fadingFactor: Optional. Value between 0 and 1. 0: No Fade, 1: Instant fade; default: 0.9
    • image: Optional. Name of the image to be drawn on
    • opacity: Optional. Opacity of the heatmap. Between 0 and 1. 0: Fully transparent, 1: Fully opaque; default: 0.5
    • width: Must be provided when image isn't set. Used to resolve position of points with relative addressing (dimensions between 0 and 1)
    • height: Must be provided when image isn't set. Used to resolve position of points with relative addressing (dimensions between 0 and 1)
    • outputName: Name of the output image
    Author:
    Paul Dubs
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DEFAULT_OUTPUT_NAME  
    • Constructor Summary

      Constructors 
      Constructor Description
      DrawHeatmapStep()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      DrawHeatmapStep points​(java.lang.String... points)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface ai.konduit.serving.pipeline.api.step.PipelineStep

        name
      • Methods inherited from interface ai.konduit.serving.pipeline.api.TextConfig

        toJson, toYaml
    • Field Detail

      • DEFAULT_OUTPUT_NAME

        public static final java.lang.String DEFAULT_OUTPUT_NAME
        See Also:
        Constant Field Values
    • Constructor Detail

      • DrawHeatmapStep

        public DrawHeatmapStep()
    • Method Detail