MultiFilterVarianceComponent.java

package gdsc.smlm.results.filter;

/*----------------------------------------------------------------------------- 
 * GDSC SMLM Software
 * 
 * Copyright (C) 2016 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.
 *---------------------------------------------------------------------------*/

/**
 * Filter results using Precision with background from noise
 */
public class MultiFilterVarianceComponent extends MultiFilterComponent
{
	final double variance;

	public MultiFilterVarianceComponent(double precision)
	{
		this.variance = Filter.getDUpperSquaredLimit(precision);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see gdsc.smlm.results.filter.MultiFilterComponent#getType()
	 */
	public boolean fail(final PreprocessedPeakResult peak)
	{
		return (peak.getLocationVariance() > variance);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see gdsc.smlm.results.filter.MultiFilterComponent#getType()
	 */
	public int getType()
	{
		return IDirectFilter.V_LOCATION_VARIANCE;
	}
}