eu.id3.face

## Enum PoolingMethod

- java.lang.Object
- - java.lang.Enum<PoolingMethod>
  - - eu.id3.face.PoolingMethod

- All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PoolingMethod>

      public enum PoolingMethod
      extends java.lang.Enum<PoolingMethod>

  Enumerates the possible pooling methods for template agregration in the FaceTracker module.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `AVERAGE` Average pooling method.
    `MAXIMUM` Maximum pooling method.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static PoolingMethod` | `fromValue(int value)` Creates an enumeration value from int.
    `int` | `getValue()` Gets the enumeration value as int.
    `static PoolingMethod` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
    `static PoolingMethod[]` | `values()` Returns an array containing the constants of this enum type, in the order they are declared.

    - ### Methods inherited from class java.lang.Enum

      `clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

    - ### Methods inherited from class java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Enum Constant Detail

    - #### AVERAGE

          public static final PoolingMethod AVERAGE

      Average pooling method. Merges instances (scores, templates, etc) into one.

    - #### MAXIMUM

          public static final PoolingMethod MAXIMUM

      Maximum pooling method. Selects best instance according to a given metric.

  - ### Method Detail

    - #### values

          public static PoolingMethod[] 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 (PoolingMethod c : PoolingMethod.values())
              System.out.println(c);

      Returns:
        an array containing the constants of this enum type, in the order they are declared

    - #### valueOf

          public static PoolingMethod 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

    - #### getValue

          public int getValue()

      Gets the enumeration value as int.
      Returns:
        The value.

    - #### fromValue

          public static PoolingMethod fromValue(int value)

      Creates an enumeration value from int.
      Parameters:
        `value` - The int value.
      Returns:
        The created PoolingMethod.

Copyright © id3 Technologies. All rights reserved. eu.id3.face