Class LinearRegressionOverlayPaintlet

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<Paintlet>, SizeOfHandler, AntiAliasingSupporter, Paintlet, PaintletWithContainerIDMatching, XYSequencePaintlet, Serializable

    public class LinearRegressionOverlayPaintlet
    extends AbstractStrokePaintletWithContainerIDMatching
    implements XYSequencePaintlet, AntiAliasingSupporter
    Draws a straight line, using slope and intercept determine by linear regression using all the data points in the plot(s).

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
     
    -stroke-thickness <float> (property: strokeThickness)
        The thickness of the stroke.
        default: 1.0
        minimum: 0.01
     
    -color <java.awt.Color> (property: color)
        The color for the line.
        default: #000000
     
    -anti-aliasing-enabled <boolean> (property: antiAliasingEnabled)
        If enabled, uses anti-aliasing for drawing lines.
        default: true
     
    -output-slope-intercept <boolean> (property: outputSlopeIntercept)
        If enabled, slope and intercept are output on the plot as well.
        default: false
     
    -x <int> (property: X)
        The X position of the top-left corner of the text (1-based).
        default: 5
        minimum: 1
     
    -y <int> (property: Y)
        The Y position of the top-left corner of the text (1-based).
        default: 16
        minimum: 1
     
    -font <java.awt.Font> (property: font)
        The font to use for the text.
        default: monospaced-PLAIN-12
     
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_Color

        protected Color m_Color
        the color for the overlay.
      • m_AntiAliasingEnabled

        protected boolean m_AntiAliasingEnabled
        whether anti-aliasing is enabled.
      • m_OutputSlopeIntercept

        protected boolean m_OutputSlopeIntercept
        whether to output slope/intercept.
      • m_X

        protected int m_X
        the X position of the text (1-based).
      • m_Y

        protected int m_Y
        the Y position of the text (1-based).
      • m_Font

        protected Font m_Font
        the font to use.
    • Constructor Detail

      • LinearRegressionOverlayPaintlet

        public LinearRegressionOverlayPaintlet()
    • Method Detail

      • setColor

        public void setColor​(Color value)
        Set the stroke color for the paintlet.
        Parameters:
        value - color of the stroke
      • getColor

        public Color getColor()
        Get the stroke color for the paintlet.
        Returns:
        color of the stroke
      • colorTipText

        public String colorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setAntiAliasingEnabled

        public void setAntiAliasingEnabled​(boolean value)
        Sets whether to use anti-aliasing.
        Specified by:
        setAntiAliasingEnabled in interface AntiAliasingSupporter
        Parameters:
        value - if true then anti-aliasing is used
      • isAntiAliasingEnabled

        public boolean isAntiAliasingEnabled()
        Returns whether anti-aliasing is used.
        Specified by:
        isAntiAliasingEnabled in interface AntiAliasingSupporter
        Returns:
        true if anti-aliasing is used
      • antiAliasingEnabledTipText

        public String antiAliasingEnabledTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setOutputSlopeIntercept

        public void setOutputSlopeIntercept​(boolean value)
        Sets whether to output slope/intercept.
        Parameters:
        value - if true then slope/intercept are output
      • getOutputSlopeIntercept

        public boolean getOutputSlopeIntercept()
        Returns whether slope/intercept are output.
        Returns:
        true if slope/intercept are output
      • outputSlopeInterceptTipText

        public String outputSlopeInterceptTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setX

        public void setX​(int value)
        Sets the X position of the text (top-left corner).
        Parameters:
        value - the position, 1-based
      • getX

        public int getX()
        Returns the X position of the text (top-left corner).
        Returns:
        the position, 1-based
      • XTipText

        public String XTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setY

        public void setY​(int value)
        Sets the Y position of the text (top-left corner).
        Parameters:
        value - the position, 1-based
      • getY

        public int getY()
        Returns the Y position of the text (top-left corner).
        Returns:
        the position, 1-based
      • YTipText

        public String YTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setFont

        public void setFont​(Font value)
        Sets the font to use.
        Parameters:
        value - the font
      • getFont

        public Font getFont()
        Returns the font in use.
        Returns:
        the font
      • fontTipText

        public String fontTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.