uk.ac.sussex.gdsc.smlm.results.FileFormat Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gdsc-smlm Show documentation

Genome Damage and Stability Centre SMLM Package Software for single molecule localisation microscopy (SMLM)

The newest version!

/*-
 * #%L
 * Genome Damage and Stability Centre SMLM Package
 *
 * Software for single molecule localisation microscopy (SMLM)
 * %%
 * Copyright (C) 2011 - 2023 Alex Herbert
 * %%
 * 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
 * .
 * #L%
 */

package uk.ac.sussex.gdsc.smlm.results;

/**
 * Specify the file format when reading results from file.
 */
public enum FileFormat {
  //@formatter:off
    /** SMLM Text. */
    SMLM_TEXT {
      @Override public String getName() { return "SMLM Text"; }
      @Override public boolean isSmlm(){return true;}},
    /** SMLM Binary. */
    SMLM_BINARY {
      @Override public String getName() { return "SMLM Binary"; }
      @Override public boolean isSmlm(){return true;}},
    /** RapidSTORM. */
    RAPID_STORM { @Override public String getName() { return "RapidSTORM"; }},
    /** NSTORM. */
    NSTORM { @Override public String getName() { return "NSTORM"; }},
    /** SMLM Table. */
    SMLM_TABLE { @Override public String getName() { return "SMLM Table"; }},
    /** MALK (Molecular Accuracy Localisation Keep). */
    MALK { @Override public String getName() { return "MALK"; }},
    /** TSF Binary. */
    TSF_BINARY { @Override public String getName() { return "TSF Binary"; }},
    /** Unknown. */
    UNKNOWN { @Override public String getName() { return "Unknown"; }};
  //@formatter:on

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

  /**
   * Gets the name.
   *
   * @return the name
   */
  public abstract String getName();

  /**
   * Checks if is a GDSC SMLM format.
   *
   * @return true, if is a GDSC SMLM format
   */
  public boolean isSmlm() {
    return false;
  }
}