Package cz.fidentis.analyst.engines.face.batch.registration

Record Class BatchFaceRegistrationConfig

java.lang.Object
java.lang.Record
cz.fidentis.analyst.engines.face.batch.registration.BatchFaceRegistrationConfig
Record Components:
regStrategy - Registration strategy. If NONE, then only the average face is computed. It can be useful if the faces are already registered.
avgFaceStrategy - Strategy of the average face metamorphose. If NONE, then the templateFace is not transformed into the average face.
scale - If true, then the registered faces can be scaled during the registration. Otherwise, they are only rotated and translated.
icpSubsampling - Subsampling strength (the number of samples). This parameter is used only for ICP registration.
icpError - Minimal error for ICP registration. This parameter is used only for ICP registration.
icpIterations - Maximum number of ICP iterations. This parameter is used only for ICP registration.
icpAutoCropSince - Use auto-crop feature since the given ICP iteration. Use zero to use it always. This parameter is used only for ICP registration.
glContext - OpenGl context. Must not be null for the PROJECTION_GPU average face strategy. Is ignored for other strategies.
public record BatchFaceRegistrationConfig(BatchFaceRegistrationServices.RegistrationStrategy regStrategy, BatchFaceRegistrationServices.AverageFaceStrategy avgFaceStrategy, boolean scale, int icpSubsampling, double icpError, int icpIterations, int icpAutoCropSince, com.jogamp.opengl.GLContext glContext) extends Record
Configuration object for the batch registration service.

  • Constructor Details

    • BatchFaceRegistrationConfig

      public BatchFaceRegistrationConfig(BatchFaceRegistrationServices.RegistrationStrategy regStrategy, BatchFaceRegistrationServices.AverageFaceStrategy avgFaceStrategy, boolean scale, int icpSubsampling, double icpError, int icpIterations, int icpAutoCropSince, com.jogamp.opengl.GLContext glContext)
      Constructor.
      Parameters:
      regStrategy - Registration strategy. If NONE, then only the average face is computed. It can be useful if the faces are already registered.
      avgFaceStrategy - Strategy of the average face metamorphose. If NONE, then the templateFace is not transformed into the average face.
      scale - If true, then the registered faces can be scaled during the registration. Otherwise, they are only rotated and translated.
      icpSubsampling - Subsampling strength (the number of samples). This parameter is used only for ICP registration.
      icpError - Minimal error for ICP registration. This parameter is used only for ICP registration.
      icpIterations - Maximum number of ICP iterations. This parameter is used only for ICP registration.
      icpAutoCropSince - Use auto-crop feature since the given ICP iteration. Use zero to use it always. This parameter is used only for ICP registration.
      glContext - OpenGl context. Must not be null for the PROJECTION_GPU average face strategy. Is ignored for other strategies.

    • BatchFaceRegistrationConfig

      public BatchFaceRegistrationConfig(BatchFaceRegistrationServices.AverageFaceStrategy avgFaceStrategy, boolean scale, com.jogamp.opengl.GLContext glContext)
      Simplified constructor for the GPA registration strategy.
      Parameters:
      avgFaceStrategy - Strategy of the average face metamorphose. If NONE, then the templateFace is not transformed into the average face.
      scale - If true, then the registered faces can be scaled during the registration. Otherwise, they are only rotated and translated.
      glContext - OpenGl context. Must not be null

    • BatchFaceRegistrationConfig

      public BatchFaceRegistrationConfig(BatchFaceRegistrationServices.AverageFaceStrategy avgFaceStrategy, boolean scale, int icpSubsampling, double icpError, int icpIterations, int icpAutoCropSince)
      Simplified constructor for the ICP registration strategy.
      Parameters:
      avgFaceStrategy - Strategy of the average face metamorphose. If NONE, then the templateFace is not transformed into the average face.
      scale - If true, then the registered faces can be scaled during the registration. Otherwise, they are only rotated and translated.
      icpSubsampling - Subsampling strength (the number of samples).
      icpError - Minimal error for ICP registration.
      icpIterations - Maximum number of ICP iterations.
      icpAutoCropSince - Use auto-crop feature since the given ICP iteration. Use zero to use it always.

    • BatchFaceRegistrationConfig

      public BatchFaceRegistrationConfig(BatchFaceRegistrationServices.AverageFaceStrategy avgFaceStrategy, boolean scale, int icpSubsampling)
      Simplified constructor for the ICP registration strategy with icpError set to 0.05, icpIterations set to 100, and icpAutoCropSince set to 1.
      Parameters:
      avgFaceStrategy - Strategy of the average face metamorphose. If NONE, then the templateFace is not transformed into the average face.
      scale - If true, then the registered faces can be scaled during the registration. Otherwise, they are only rotated and translated.
      icpSubsampling - Subsampling strength (the number of samples).

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • regStrategy

      public BatchFaceRegistrationServices.RegistrationStrategy regStrategy()
      Returns the value of the regStrategy record component.
      Returns:
      the value of the regStrategy record component

    • avgFaceStrategy

      public BatchFaceRegistrationServices.AverageFaceStrategy avgFaceStrategy()
      Returns the value of the avgFaceStrategy record component.
      Returns:
      the value of the avgFaceStrategy record component

    • scale

      public boolean scale()
      Returns the value of the scale record component.
      Returns:
      the value of the scale record component

    • icpSubsampling

      public int icpSubsampling()
      Returns the value of the icpSubsampling record component.
      Returns:
      the value of the icpSubsampling record component

    • icpError

      public double icpError()
      Returns the value of the icpError record component.
      Returns:
      the value of the icpError record component

    • icpIterations

      public int icpIterations()
      Returns the value of the icpIterations record component.
      Returns:
      the value of the icpIterations record component

    • icpAutoCropSince

      public int icpAutoCropSince()
      Returns the value of the icpAutoCropSince record component.
      Returns:
      the value of the icpAutoCropSince record component

    • glContext

      public com.jogamp.opengl.GLContext glContext()
      Returns the value of the glContext record component.
      Returns:
      the value of the glContext record component