org.jcamp.spectrum.IMasterSpectrum Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jcamp-dx Show documentation

The JCAMP-DX project is the reference implemention of the IUPAC JCAMP-DX spectroscopy data standard.

The newest version!

package org.jcamp.spectrum;

/**
 * interface for spectra that are composite types e.g. a chromatogram which 
 * has at each retention time a seperate mass spectrum.
 * 
 * @author Thomas Weber
 */
public interface IMasterSpectrum {
  
  /**
   * returns the 1D spectrum at the x index position ix
   * @return Spectrum1D
   * @param ix int
   */
  Spectrum1D getSlaveSpectrumFromXIndex(int ix);
  /**
   * returns the 1D spectrum nearest to the x position x
   * @return Spectrum1D
   * @param x double
   */
  Spectrum1D getSlaveSpectrumFromXPosition(double x);
  /**
   * returns the 1D spectrum at the y index position iy
   * @return Spectrum1D
   * @param iy int
   */
  Spectrum1D getSlaveSpectrumFromYIndex(int iy);
  /**
   * returns the 1D spectrum nearest to the y position y
   * @return Spectrum1D
   * @param y double
   */
  Spectrum1D getSlaveSpectrumFromYPosition(double y);
}