uk.ac.sussex.gdsc.smlm.results.data.PeakResultDataParameterConverter 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.data;

import uk.ac.sussex.gdsc.core.data.utils.Converter;
import uk.ac.sussex.gdsc.smlm.results.PeakResult;

/**
 * Gets a parameter data value from a result.
 */
public class PeakResultDataParameterConverter extends PeakResultDataFloatConverter {
  /** The parameter index. */
  public final int index;

  /**
   * Instantiates a new peak result parameter value.
   *
   * @param converter the converter
   * @param index the index
   */
  public PeakResultDataParameterConverter(Converter converter, int index) {
    super(converter);
    this.index = index;
  }

  @Override
  public Float getValue(PeakResult result) {
    return converter.convert(result.getParameter(index));
  }

  @Override
  public String getValueName() {
    return PeakResult.getParameterName(index);
  }
}