uk.ac.sussex.gdsc.smlm.model.SpatialIllumination 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.model;

/**
 * Contains methods for specifying the illumination photons of a spatial position.
 */
public interface SpatialIllumination {
  /**
   * Get the number of photons for the position.
   *
   * @param xyz the xyz
   * @return The photons
   */
  double getPhotons(double[] xyz);

  /**
   * Get the number of photons for the position at the specified time.
   *
   * The return value is an array containing the number of photons that occurred before the time
   * frame and then the number of photons during the time frame. This allows simulation of a pulsed
   * illumination source where the pulse is modelled as a zero time event.
   *
   * @param xyz the xyz
   * @param time the time
   * @return The photons [before,during]
   */
  double[] getPulsedPhotons(double[] xyz, int time);

  /**
   * Gets the average photons.
   *
   * @return An estimate of the average photons per time frame
   */
  double getAveragePhotons();
}