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

/**
 * Define the type of parameter
 */
public enum ParameterType
{
	//@formatter:off
	SIGNAL("Signal"),
	SIGNAL_RANGE("Signal Range"),
	SNR("Signal-to-Noise Ratio","SNR"),
	SNR_RANGE("Signal-to-Noise Ratio Range","SNR Range"),
	MIN_WIDTH("Min Width"),
	MIN_WIDTH_RANGE("Min Width Range"),
	MAX_WIDTH("Max Width"),
	MAX_WIDTH_RANGE("Max Width Range"),
	SHIFT("Shift"),
	SHIFT_RANGE("Shift Range"),
	ESHIFT("Euclidian Shift","EShift"),
	PRECISION("Precision"),
	PRECISION_RANGE("Precision Range"),
	PRECISION2("Precision using local background","Precision2"),
	PRECISION2_RANGE("Precision Range using local background","Precision2 Range"),
	ANR("Amplitude-to-Noise Ratio","ANR"),
	SBR("Signal-to-Background Ratio","SBR"),
	DISTANCE_THRESHOLD("Distance Threshold","D-threshold"),
	DISTANCE_THRESHOLD_MODE("Distance Threshold Mode","D-threshold mode"),
	TIME_THRESHOLD("Time Threshold","T-threshold"),
	TIME_THRESHOLD_MODE("Time Threshold Mode","T-threshold mode"),
	MIN_X("Min X"),
	MAX_X("Max X"),
	MIN_Y("Min Y"),
	MAX_Y("Max Y");
	
	//@formatter:on

	public final String name;
	public final String shortName;

	private ParameterType(String name)
	{
		this(name, name);
	}

	private ParameterType(String name, String sname)
	{
		this.name = name;
		this.shortName = sname;
	}

	@Override
	public String toString()
	{
		return shortName;
	}
}