/*******************************************************************************
* GenPlay, Einstein Genome Analyzer
* Copyright (C) 2009, 2014 Albert Einstein College of Medicine
*
* 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 <http://www.gnu.org/licenses/>.
* Authors: Julien Lajugie <julien.lajugie@einstein.yu.edu>
* Nicolas Fourel <nicolas.fourel@einstein.yu.edu>
* Eric Bouhassira <eric.bouhassira@einstein.yu.edu>
*
* Website: <http://genplay.einstein.yu.edu>
******************************************************************************/
package edu.yu.einstein.genplay.dataStructure.enums;
/**
* A type of saturation
* @author Julien Lajugie
* @version 0.1
*/
public enum SaturationType {
/**
* saturation that saturates a fixed number of values
*/
COUNT ("Count"),
/**
* saturation that saturates a percentage of extreme values
*/
PERCENTAGE ("Percentage"),
/**
* saturation that saturates values above or under a specified threshold
*/
THRESHOLD ("Threshold");
private final String name; // String representing the saturation
/**
* Private constructor. Creates an instance of {@link SaturationType}
* @param name
*/
private SaturationType(String name) {
this.name = name;
}
@Override
public String toString() {
return name;
}
}