Class ErrorBarPolicyRelative

    • Constructor Detail

      • ErrorBarPolicyRelative

        public ErrorBarPolicyRelative​(double relativeError)
                               throws java.lang.IllegalArgumentException
        Creates an instance with the given relative errors.

        The relative error is related to the absolut x and y values to render. It has to be between 0.0 and 1.0.

        Parameters:
        relativeError - the relative error value between 0.0 and 1.0 for x and y dimension.
        Throws:
        java.lang.IllegalArgumentException - if the argument is not between 0.0 and 1.0.
        See Also:
        ErrorBarPolicyRelative(double, double)
      • ErrorBarPolicyRelative

        public ErrorBarPolicyRelative​(double relativeXError,
                                      double relativeYError)
                               throws java.lang.IllegalArgumentException
        Creates an instance with the given relative errors.

        The relative error is related to the absolut x and y values to render. It has to be between 0.0 and 1.0.

        Parameters:
        relativeXError - the relative x error value between 0.0 and 1.0.
        relativeYError - the relative y error value between 0.0 and 1.0.
        Throws:
        java.lang.IllegalArgumentException - if the argument is not between 0.0 and 1.0.
    • Method Detail

      • getRelativeXError

        public final double getRelativeXError()
        Returns the relative x error between 0 and 1.

        Returns:
        the relative x error.
      • getRelativeYError

        public final double getRelativeYError()
        Returns the relative y error between 0 and 1.

        Returns:
        the relative y Error.
      • getXError

        public final double getXError​(double xValue)
        Description copied from interface: IErrorBarPolicy
        Returns the relative x error (value domain) that is added to / subtracted from the values to display.

        Parameters:
        xValue - the absolute x value (not pixel) to get the error for.
        Returns:
        the relative x error in value domain that is added to / subtracted from the values to display.
        See Also:
        IErrorBarPolicy.getXError(double)
      • getYError

        public final double getYError​(double yValue)
        Description copied from interface: IErrorBarPolicy
        Returns the relative y error (value domain) that is added to / subtracted from the values to display.

        Parameters:
        yValue - the absolute y value (not pixel) to get the error for.
        Returns:
        the relative y error in value domain that is added to / subtracted from the values to display.
        See Also:
        IErrorBarPolicy.getYError(double)
      • setRelativeXError

        public final void setRelativeXError​(double relativeXError)
                                     throws java.lang.IllegalArgumentException
        Sets the relative X error to add to each error bar.

        The relative error is related to the absolute x values to render. It has to be between 0.0 and 1.0.

        Parameters:
        relativeXError - a value between 0.0 and 1.0.
        Throws:
        java.lang.IllegalArgumentException - if the argument is not between 0.0 and 1.0.
      • setRelativeYError

        public final void setRelativeYError​(double relativeYError)
                                     throws java.lang.IllegalArgumentException
        Sets the relative Y error to add to each error bar.

        The relative error is related to the absolut y values to render. It has to be between 0.0 and 1.0.

        Parameters:
        relativeYError - a value between 0.0 and 1.0.
        Throws:
        java.lang.IllegalArgumentException - if the argument is not between 0.0 and 1.0.