Package elki.utilities.scaling

Class ClipScaling

  • All Implemented Interfaces:
    ScalingFunction, StaticScalingFunction
    public class ClipScaling
extends java.lang.Object
implements StaticScalingFunction
    Scale implementing a simple clipping. Values less than the specified minimum will be set to the minimum, values larger than the maximum will be set to the maximum.
    Since:
    0.3
    Author:
    Erich Schubert

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ClipScaling.Par
      Parameterization class.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.Double max
      Field storing the maximum to use
      static OptionID MAX_ID
      Parameter to specify the maximum value
      private java.lang.Double min
      Field storing the minimum to use
      static OptionID MIN_ID
      Parameter to specify a fixed minimum to use.

    • Constructor Summary

      Constructors 
      Constructor Description
      ClipScaling​(java.lang.Double min, java.lang.Double max)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      double getMax()
      Get maximum resulting value.
      double getMin()
      Get minimum resulting value.
      double getScaled​(double value)
      Transform a given value using the scaling function.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • MIN_ID

        public static final OptionID MIN_ID
        Parameter to specify a fixed minimum to use.

      • MAX_ID

        public static final OptionID MAX_ID
        Parameter to specify the maximum value

      • min

        private java.lang.Double min
        Field storing the minimum to use

      • max

        private java.lang.Double max
        Field storing the maximum to use

    • Constructor Detail

      • ClipScaling

        public ClipScaling​(java.lang.Double min,
                   java.lang.Double max)
        Constructor.
        Parameters:
        min - Minimum, may be null
        max - Maximum, may be null

    • Method Detail

      • getScaled

        public double getScaled​(double value)
        Description copied from interface: ScalingFunction
        Transform a given value using the scaling function.
        Specified by:
        getScaled in interface ScalingFunction
        Parameters:
        value - Original value
        Returns:
        Scaled value

      • getMin

        public double getMin()
        Description copied from interface: ScalingFunction
        Get minimum resulting value. May be Double.NaN or Double.NEGATIVE_INFINITY.
        Specified by:
        getMin in interface ScalingFunction
        Returns:
        Minimum resulting value.

      • getMax

        public double getMax()
        Description copied from interface: ScalingFunction
        Get maximum resulting value. May be Double.NaN or Double.POSITIVE_INFINITY.
        Specified by:
        getMax in interface ScalingFunction
        Returns:
        Maximum resulting value.