uk.ac.sussex.gdsc.smlm.results.procedures.BaseResultProcedure 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.results.procedures;

import java.util.Objects;
import uk.ac.sussex.gdsc.smlm.results.MemoryPeakResults;
import uk.ac.sussex.gdsc.smlm.results.PeakResult;

/**
 * Contains core functionality for result procedures.
 */
public class BaseResultProcedure {
  /** The results. */
  protected final MemoryPeakResults results;

  /** The counter for procedures. */
  protected int counter;

  /**
   * Instantiates a new abstract result procedure.
   *
   * @param results the results
   */
  protected BaseResultProcedure(MemoryPeakResults results) {
    this.results = Objects.requireNonNull(results, "results must not be null");
  }

  /**
   * Get the size of the results.
   *
   * @return the size
   */
  public int size() {
    return results.size();
  }

  /**
   * Allocate the array to store the data based on the current results size.
   *
   * @param data the data
   * @return the (new) data
   */
  protected int[] allocate(int[] data) {
    return (data == null || data.length < size()) ? new int[size()] : data;
  }

  /**
   * Allocate the array to store the data based on the current results size.
   *
   * @param data the data
   * @return the (new) data
   */
  protected float[] allocate(float[] data) {
    return (data == null || data.length < size()) ? new float[size()] : data;
  }

  /**
   * Allocate the array to store the data based on the current results size.
   *
   * @param data the data
   * @return the (new) data
   */
  protected double[] allocate(double[] data) {
    return (data == null || data.length < size()) ? new double[size()] : data;
  }

  /**
   * Allocate the array to store the data based on the current results size.
   *
   * @param data the data
   * @return the (new) data
   */
  protected PeakResult[] allocate(PeakResult[] data) {
    return (data == null || data.length < size()) ? new PeakResult[size()] : data;
  }
}