Package elki.utilities.scaling
Class ClipScaling
- java.lang.Object
-
- elki.utilities.scaling.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 usestatic OptionID
MAX_ID
Parameter to specify the maximum valueprivate java.lang.Double
min
Field storing the minimum to usestatic 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.
-
-
-
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
-
-
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 interfaceScalingFunction
- Parameters:
value
- Original value- Returns:
- Scaled value
-
getMin
public double getMin()
Description copied from interface:ScalingFunction
Get minimum resulting value. May beDouble.NaN
orDouble.NEGATIVE_INFINITY
.- Specified by:
getMin
in interfaceScalingFunction
- Returns:
- Minimum resulting value.
-
getMax
public double getMax()
Description copied from interface:ScalingFunction
Get maximum resulting value. May beDouble.NaN
orDouble.POSITIVE_INFINITY
.- Specified by:
getMax
in interfaceScalingFunction
- Returns:
- Maximum resulting value.
-
-