Class PoErrorCurve

  • All Implemented Interfaces:
    SafeDisposable

    public class PoErrorCurve
    extends PoGraphMaster
    Class to build an error curve represention. Class to build an error curve in the plane XY. An error curve is a curve (defined by a point list) with a low curve and a high curve which represent the error.

    File format/default:

    PoErrorCurve {

      point 0 0
      lowY 0
      highY 0
      variationType REL_VARIATION
      errorCurveRep HIGH_LOW_CLOSE
    }

    <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> <html> <head> <link REL="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> <title></title> </head> <BODY> <h1></h1> <h4> <A NAME="Heading373">CATALOG PARTS</A></h4> <ul>The catalog part interpretation depends on <i>errorCurveRep</i> field.<br> <br> - HIGH_LOW_CLOSE representation (the groups errorCurve3, errorCurve4 and errorCurve 4 are set to NULL): <br> </ul> <ul><b>PoErrorCurve</b> {</ul> <ul><ul><b>Separator</b> <tt>alternateRep</tt> (from PoBase) {<br> </ul></ul> <ul><ul><ul><b>AppearanceKit</b> <tt>appearance</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.</i></ul></ul></ul> <ul><ul><ul><b>MatrixTransform</b> <tt>domainTransform</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Corresponds to the domain transformation.</i></ul></ul></ul> <ul><ul><ul><ul></ul></ul></ul></ul> <ul><ul><ul><b>Separator</b> <tt>errorCurve1Sep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw the close bars.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>errorCurve1App</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of the close bars.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>errorCurve1</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw the close bars.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>errorCurve2Sep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw vertical lines.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>errorCurve2App</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of vertical lines.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>errorCurve2</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw vertical lines.</i></ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul></ul></ul> <ul>- LINE_BAR representation (the groups errorCurve5 is set to NULL): <br> </ul> <ul><b>PoErrorCurve</b> {</ul> <ul><ul><b>Separator</b> <tt>alternateRep</tt> (from PoBase) {<br> </ul></ul> <ul><ul><ul><b>AppearanceKit</b> <tt>appearance</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.</i></ul></ul></ul> <ul><ul><ul><b>MatrixTransform</b> <tt>domainTransform</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Corresponds to the domain transformation.</i></ul></ul></ul> <ul><ul><ul><b>Separator</b> <tt>errorCurve1Sep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw points.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>errorCurve1App</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of points.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>errorCurve1</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw points.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>errorCurve2Sep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw horizontal lower lines.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>errorCurve2App</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of horizontal lower lines.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>errorCurve2</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw horizontal lower lines.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>errorCurve3Sep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw horizontal upper lines.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>errorCurve3App</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of horizontal upper lines.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>errorCurve3</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw horizontal upper lines.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>errorCurve4Sep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw vertical lines.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>errorCurve4App</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of vertical lines.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>errorCurve4</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw vertical lines.</i></ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul></ul></ul> <ul>- FILLED representation: <br> </ul> <ul><b>PoErrorCurve</b> {</ul> <ul><ul><b>Separator</b> <tt>alternateRep</tt> (from PoBase) {<br> </ul></ul> <ul><ul><ul><b>AppearanceKit</b> <tt>appearance</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.</i></ul></ul></ul> <ul><ul><ul><b>MatrixTransform</b> <tt>domainTransform</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Corresponds to the domain transformation.</i></ul></ul></ul> <ul><ul><ul><b>Separator</b> <tt>errorCurve1Sep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw lower part.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>errorCurve1App</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of lower part.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>errorCurve1</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoFaceSet shape to draw lower part.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>errorCurve2Sep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw upper part.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>errorCurve2App</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of upper part.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>errorCurve2</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoFaceSet shape to draw upper part.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>errorCurve3Sep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw lower curve.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>errorCurve3App</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of lower curve.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>errorCurve3</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw lower curve.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>errorCurve4Sep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw middle curve.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>errorCurve4App</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of middle curve.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>errorCurve4</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw middle curve.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>errorCurve5Sep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw upper curve.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>errorCurve5App</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of upper curve.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>errorCurve5</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw upper curve.</i></ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <p> </body> </html>

    • Field Detail

      • point

        public final SoMFVec2f point
        List of coordinates of the error curve.
      • lowY

        public final SoMFFloat lowY
        List of the low ordinates for the low curve. The number of low ordinates must be equal to the number of points of point.
      • highY

        public final SoMFFloat highY
        List of the high ordinates for the high curve. The number of high ordinates must be equal to the number of points of point.
      • variationType

        public final SoSFEnum<PoErrorCurve.VariationTypes> variationType
        Defines the interpretation of the values lowY and highY. The ordinate yl of the i-th point of the low curve depends on the value of this field:
        • FIXED_VARIATION: yl = lowY[i]
        • REL_VARIATION: yl = point[i][1] - lowY[i]
        • PERCENT_FIXED_VARIATION: yl = point[i][1] * lowY[i]
        • PERCENT_REL_VARIATION: yl = point[i][1] - (lowY[i] * point[i][1])

        The same method is used to compute yh, the ordinate of the i-th point of the high curve.

      • errorCurveRep

        public final SoSFEnum<PoErrorCurve.ErrorCurveReps> errorCurveRep
        Defines the error curve representation. There are three types of representations: high low close representation (HIGH_LOW_CLOSE), line bar representation (LINE_BAR) and filling representation (FILLED).
    • Constructor Detail

      • PoErrorCurve

        public PoErrorCurve​(SbVec2f[] _point,
                            float[] _lowY,
                            float[] _highY)
        Calls PoErrorCurve(_point, _lowY, _highY, PoErrorCurve.VariationTypes.valueOf( PoErrorCurve.VariationTypes.REL_VARIATION.getValue() ), PoErrorCurve.ErrorCurveReps.valueOf( PoErrorCurve.ErrorCurveReps.HIGH_LOW_CLOSE.getValue() )).
      • PoErrorCurve

        public PoErrorCurve​(SbVec2f[] _point,
                            float[] _lowY,
                            float[] _highY,
                            PoErrorCurve.VariationTypes type)
        Calls PoErrorCurve(_point, _lowY, _highY, type, PoErrorCurve.ErrorCurveReps.valueOf( PoErrorCurve.ErrorCurveReps.HIGH_LOW_CLOSE.getValue() )).
      • PoErrorCurve

        public PoErrorCurve()
        Default constructor.