Annotation Type AdjustableParameter


  • @Documented
    @Retention(RUNTIME)
    @Target(FIELD)
    public @interface AdjustableParameter
    Annotation to define a parameter as adjustable by the UI. Currently must be a float or int.

    Can be used in classes which implement IDetector or IPostProcessor

    If another type is required please request it on https://github.com/DCS-Sherlock/Sherlock/issues

    Set the parameter declaration to the desired default value

    The engine will set this parameter to it's adjusted value when creating an instance of a supported object
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      float defaultValue
      default value the parameter takes
      float maxumumBound
      The maximum bound for the field
      float minimumBound
      Minimum bound for field
      java.lang.String name
      Name for the parameter to be displayed in the UI
      float step
      The step to increment or decrement the parameter by in the UI
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String description
      Optional, detailed description of what the parameter does
    • Element Detail

      • defaultValue

        float defaultValue
        default value the parameter takes
        Returns:
        the default value
      • maxumumBound

        float maxumumBound
        The maximum bound for the field
        Returns:
        the max bound
      • minimumBound

        float minimumBound
        Minimum bound for field
        Returns:
        the min bound
      • name

        java.lang.String name
        Name for the parameter to be displayed in the UI
        Returns:
        the parameter name
      • step

        float step
        The step to increment or decrement the parameter by in the UI
        Returns:
        the parameter step
      • description

        java.lang.String description
        Optional, detailed description of what the parameter does
        Returns:
        the description string
        Default:
        ""