PeakResults.java

package gdsc.smlm.results;

import java.awt.Rectangle;
import java.util.Collection;

/*----------------------------------------------------------------------------- 
 * GDSC SMLM Software
 * 
 * Copyright (C) 2013 Alex Herbert
 * Genome Damage and Stability Centre
 * University of Sussex, UK
 * 
 * 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.
 *---------------------------------------------------------------------------*/

/**
 * Specifies the interface for saving peak fitting results
 */
public interface PeakResults
{
	/**
	 * Should be called at the start of fitting to prepare the output.
	 */
	public void begin();

	/**
	 * Add a fitted peak result
	 * 
	 * @param peak
	 *            The peak number
	 * @param origX
	 *            The original X value
	 * @param origY
	 *            The original Y value
	 * @param origValue
	 *            The original value
	 * @param error
	 *            The error of the fit
	 * @param noise
	 *            Estimate of the noise in the signal
	 * @param params
	 *            The peak parameters
	 * @param paramsStdDev
	 *            The peak parameters standard deviations
	 */
	public void add(int peak, int origX, int origY, float origValue, double error, float noise, float[] params,
			float[] paramsStdDev);

	/**
	 * Add a series of fitted peak results
	 * 
	 * @param results
	 */
	public void addAll(Collection<PeakResult> results);

	/**
	 * @return The number of results added since begin()
	 */
	public int size();

	/**
	 * Called at the end of fitting to finalise the output.
	 */
	public void end();

	/**
	 * @return True if still accepting results using the add methods
	 */
	public boolean isActive();

	/**
	 * @param source
	 *            The source used to create the results
	 */
	public void setSource(ImageSource source);

	/**
	 * @return The source used to create the results
	 */
	public ImageSource getSource();

	/**
	 * @param bounds
	 *            The bounds used from the source to create the results
	 */
	public void setBounds(Rectangle bounds);

	/**
	 * @return The Bounds used to create the results
	 */
	public Rectangle getBounds();

	/**
	 * @param calibration
	 *            The calibration used to obtain the results
	 */
	public void setCalibration(Calibration calibration);

	/**
	 * @return The calibration used to obtain the results
	 */
	public Calibration getCalibration();

	/**
	 * @param configuration
	 *            The configuration used to create the results
	 */
	public void setConfiguration(String configuration);

	/**
	 * @return The configuration used to create the results
	 */
	public String getConfiguration();

	/**
	 * @return The name of the results set
	 */
	public String getName();

	/**
	 * @param name
	 *            The name of the results set
	 */
	public void setName(String name);

	/**
	 * Copy the settings (source, bounds, configuration) from the given results
	 * 
	 * @param peakResults
	 */
	public void copySettings(PeakResults peakResults);
}