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

import java.awt.Rectangle;

/**
 * An CCD camera model with all pixels treated equally.
 */
public class CcdCameraModel extends FixedPixelCameraModel {

  /**
   * Instantiates a new CCD camera model.
   *
   * @param bias the bias (in counts)
   * @param gain the total gain (count/photon)
   */
  public CcdCameraModel(float bias, float gain) {
    this(bias, gain, 0f);
  }

  /**
   * Instantiates a new CCD camera model.
   *
   * @param bias the bias (in counts)
   * @param gain the total gain (count/photon)
   */
  public CcdCameraModel(double bias, double gain) {
    this(bias, gain, 0d);
  }

  /**
   * Instantiates a new CCD camera model.
   *
   * @param bias the bias (in counts)
   * @param gain the total gain (count/photon)
   * @param variance the variance (in counts)
   */
  public CcdCameraModel(float bias, float gain, float variance) {
    super(bias, gain, variance);
  }

  /**
   * Instantiates a new CCD camera model.
   *
   * @param bias the bias (in counts)
   * @param gain the total gain (count/photon)
   * @param variance the variance (in counts)
   */
  public CcdCameraModel(double bias, double gain, double variance) {
    super(bias, gain, variance);
  }

  /**
   * Copy constructor.
   *
   * @param source the source
   */
  protected CcdCameraModel(CcdCameraModel source) {
    super(source);
  }

  /**
   * {@inheritDoc}
   *
   * Note: This is an CCD camera model. The normalised variance represents the effective read
   * noise in incident photons (i.e. before gain). This can be combined with the expected shot
   * variance of a Poisson distribution (mean) to obtain the total variance in photon units:
   *
   * 
   * Total variance (photons) = [Poisson mean] + [normalised variance]
   * 
   *
   * This value multiplied by the [gain]^2 is the variance in counts.
   */
  @Override
  public float[] getNormalisedVariance(Rectangle bounds) {
    return super.getNormalisedVariance(bounds);
  }

  /**
   * {@inheritDoc}
   *
   * 
Note: This is an CCD camera model. The normalised variance represents the effective read
   * noise in incident photons (i.e. before gain). This can be combined with the expected shot
   * variance of a Poisson distribution (mean) to obtain the total variance in photon units:
   *
   * 
   * Total variance (photons) = [Poisson mean] + [normalised variance]
   * 
   *
   * This value multiplied by the [gain]^2 is the variance in counts.
   */
  @Override
  public double getMeanNormalisedVariance(Rectangle bounds) {
    return super.getMeanNormalisedVariance(bounds);
  }

  @Override
  public CcdCameraModel copy() {
    return new CcdCameraModel(this);
  }
}