uk.ac.sussex.gdsc.smlm.fitting.nonlinear.gradient.WPoissonGradientProcedureUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gdsc-smlm Show documentation

Genome Damage and Stability Centre SMLM Package Software for single molecule localisation microscopy (SMLM)

The newest version!

/*-
 * #%L
 * Genome Damage and Stability Centre SMLM Package
 *
 * Software for single molecule localisation microscopy (SMLM)
 * %%
 * Copyright (C) 2011 - 2023 Alex Herbert
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

package uk.ac.sussex.gdsc.smlm.fitting.nonlinear.gradient;

import uk.ac.sussex.gdsc.smlm.function.Gradient1Function;

/**
 * Create a weighted Poisson gradient procedure.
 */
public final class WPoissonGradientProcedureUtils {
  /** No public constructor. */
  private WPoissonGradientProcedureUtils() {}

  /**
   * Create a new gradient procedure.
   *
   * @param y Data to fit
   * @param var the base variance of each observation (must be positive)
   * @param func Gradient function
   * @return the gradient procedure
   */
  public static WPoissonGradientProcedure create(final double[] y, final double[] var,
      final Gradient1Function func) {
    switch (func.getNumberOfGradients()) {
      case 5:
        return new WPoissonGradientProcedure5(y, var, func);
      case 4:
        return new WPoissonGradientProcedure4(y, var, func);
      case 6:
        return new WPoissonGradientProcedure6(y, var, func);

      default:
        return new WPoissonGradientProcedure(y, var, func);
    }
  }
}