OrFilter.java

package gdsc.smlm.results.filter;

/*----------------------------------------------------------------------------- 
 * 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.
 *---------------------------------------------------------------------------*/

import gdsc.smlm.results.PeakResult;

/**
 * Filter results using the combination of two filters. Results can pass either filter
 */
public class OrFilter extends CombinedFilter
{
	public OrFilter(Filter filter1, Filter filter2)
	{
		super(filter1, filter2);
	}

	@Override
	protected String getOperator()
	{
		return "||";
	}

	@Override
	public boolean accept(PeakResult peak)
	{
		return accept1(peak) || accept2(peak);
	}

	@Override
	public int validate(final PreprocessedPeakResult peak)
	{
		if (accept1(peak) || accept2(peak))
			return 0;
		// We only get here when both filters failed so we can just combine the results
		return result1 | result2;
	}

	@Override
	public String getDescription()
	{
		return "Filter results using the combination of two filters. Results can pass either filter.";
	}

	@Override
	protected Filter createFilter(Filter f1, Filter f2)
	{
		return new OrFilter(f1, f2);
	}

	@Override
	public Filter clone()
	{
		return new OrFilter(filter1.clone(), filter2.clone());
	}
}