Package com.openinventor.imageviz.nodes.measures

Enum SoDataMeasure.UnitDimensions

  • All Implemented Interfaces:
    IntegerValuedEnum, java.io.Serializable, java.lang.Comparable<SoDataMeasure.UnitDimensions>
    Enclosing class:
    SoDataMeasure
    public static enum SoDataMeasure.UnitDimensions
extends java.lang.Enum<SoDataMeasure.UnitDimensions>
implements IntegerValuedEnum
    "Unit dimension" is used to categorize the resulting unit of a measure. This is not the exact resulting unit, which depends on the input data unit. ex: an area computation on a data in mm will result in a measure in mm² ; the unit dimension is the relation between the intput and output units, in this example the square of the length unit, ie "Area". If the input data length unit is cm, the result will be cm², the unit dimension is the same and only depends on the measure algorithm, not on data.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AREA
      Output unit is the square as the input data length unit.
      DEGREES
      Output is an angle in degrees (not radians).
      INTENSITY
      Output unit is the same as the input data value unit.
      NOUNIT
      for measure without units (count for ex.)
      PERIMETER
      Output unit is the same as the input length value unit.
      PIXELS
      Output is a pixel position or length (independent from the input length value unit).
      SQUAREINTENSITY
      Output unit is the square of the input data value unit.
      VOLUME
      Output unit is the cube as the input data length unit.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getValue()
      Returns the integer value of the enum constant.
      static SoDataMeasure.UnitDimensions valueOf​(int val)
      Returns the enum constant of this type with the specified integer value
      static SoDataMeasure.UnitDimensions valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SoDataMeasure.UnitDimensions[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

        public static SoDataMeasure.UnitDimensions[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (SoDataMeasure.UnitDimensions c : SoDataMeasure.UnitDimensions.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SoDataMeasure.UnitDimensions valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • valueOf

        public static SoDataMeasure.UnitDimensions valueOf​(int val)
        Returns the enum constant of this type with the specified integer value
        Returns:
        the enum constant of this type with the specified integer value.

      • getValue

        public int getValue()
        Description copied from interface: IntegerValuedEnum
        Returns the integer value of the enum constant.
        Specified by:
        getValue in interface IntegerValuedEnum
        Returns:
        the integer value of the enum constant.