Module net.raumzeitfalle.registration.solver
Package net.raumzeitfalle.registration.solver.spi

Interface SolverAdapter

All Superinterfaces:
BiFunction<References,Deltas,Solution>
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface SolverAdapter extends BiFunction<References,Deltas,Solution>
As Image Registration does not provide the actual required linear algebra (LA) implementations, this interfaces serves as the adapter to connect utilize external LA libraries.

There is a number of example implementations available for some popular libraries.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Solution
    apply(References t, Deltas u)
    Default implementation so that this class is compatible with BiFunction interface.
    Solution
    solve(References t, Deltas u)
    Here the actual logic for image registration calculation shall be implemented.

    Methods inherited from interface java.util.function.BiFunction

    andThen

  • Method Details

    • solve

      Solution solve(References t, Deltas u)
      Here the actual logic for image registration calculation shall be implemented. As the Image Registration library is supposed to run all checks and to ensure that a result can be calculated, there is no exception handling expected here. All data passed into this method call is expected to represent solvable systems of equations.
      Parameters:
      t - References = design locations
      u - Deltas = deviations of actual positions to the expected design positions
      Returns:
      Solution as a vector with the coefficients of the model, where the length of the vector depends on the size of the given design and deviation matrices.

    • apply

      default Solution apply(References t, Deltas u)
      Default implementation so that this class is compatible with BiFunction interface. Internally the solve(..,..) method is called.
      Specified by:
      apply in interface BiFunction<References,Deltas,Solution>
      Parameters:
      t - References = design locations
      u - Deltas = deviations of actual positions to the expected design positions
      Returns:
      Solution as a vector with the coefficients of the model, where the length of the vector depends on the size of the given design and deviation matrices.