public interface SpectrumFile extends Comparable
Modifier and Type | Method and Description |
---|---|
int |
getCharge()
This method reports on the charge of the precursor ion.
|
String |
getFilename()
This method reports on the filename for the file.
|
double |
getHighestIntensity()
This method returns the intensity of the highest intensity peak in
this spectrum.
|
double |
getIntensity()
This method reports on the intensity of the precursor ion.
|
HashMap |
getPeaks()
This method reports on the peaks in the spectrum, with the
Doubles for the masses as keys in the HashMap, and the intensities
for each peak as Double value for that mass key.
|
double |
getPrecursorMZ()
This method reports on the precursor M/Z
|
double |
getTotalIntensity()
This method returns the total intensity contributed by all the ions
in this spectrum.
|
void |
setCharge(int aCharge)
This method sets the charge of the precursor ion.
|
void |
setFilename(String aFilename)
This method sets the filename for the file.
|
void |
setIntensity(double aIntensity)
This method sets the intensity of the precursor ion.
|
void |
setPeaks(HashMap aPeaks)
This method sets the peaks on the spectrum.
|
void |
setPrecursorMZ(double aPrecursorMZ)
This method sets the precursor M/Z on the file.
|
void |
writeToFile(File aParentDir)
This method allows the caller to write the spectrum file to the specified folder
using its current filename.
|
void |
writeToStream(OutputStream aOut)
This method allows to write the spectrum file to the specified OutputStream.
|
compareTo
int getCharge()
void setCharge(int aCharge)
aCharge
- int with the charge of the precursor ion.String getFilename()
void setFilename(String aFilename)
aFilename
- String with the filename for the file.HashMap getPeaks()
void setPeaks(HashMap aPeaks)
aPeaks
- HashMap with Doubles as keys (the masses) and Doubles as values (the intensities).double getPrecursorMZ()
void setPrecursorMZ(double aPrecursorMZ)
aPrecursorMZ
- double with the precursor M/Zdouble getIntensity()
void setIntensity(double aIntensity)
aIntensity
- double with the intensity of the precursor ion.double getTotalIntensity()
double getHighestIntensity()
void writeToStream(OutputStream aOut) throws IOException
aOut
- OutputStream to write the file to. This Stream
will NOT be closed by this method.IOException
- when the write operation fails.void writeToFile(File aParentDir) throws IOException
aParentDir
- File with the parent directory to put the file in.IOException
- whenever the write process failed.Copyright © 2016. All rights reserved.