pgb_liv\php_ms\Core\Spectra\IonInterface
Interface to ion properties of an object
- Author: Andrew Collins
Synopsis
interface IonInterface
{
- // constants
- const RETENTION_TIME_START = 0;
- const RETENTION_TIME_END = 1;
- // methods
- public void setMonoisotopicMass()
- public float getMonoisotopicMass()
- public void setMonoisotopicMassCharge()
- public float getAverageMassCharge()
- public void setAverageMass()
- public float getAverageMass()
- public void setAverageMassCharge()
- public float getMonoisotopicMassCharge()
- public int getCharge()
- public void setIntensity()
- public float getIntensity()
- public void setRetentionTime()
- public void setRetentionTimeWindow()
- public float getRetentionTime()
- public array getRetentionTimeWindow()
- public boolean hasRetentionTimeWindow()
Constants
| Name | Value |
|---|---|
| RETENTION_TIME_START | 0 |
| RETENTION_TIME_END | 1 |
Methods
public
- getAverageMass() — Gets the neutral mass value for this ion
- getAverageMassCharge() — Gets the mass-to-charge ratio for this ion
- getCharge() — Gets the charge value associated with this spectra
- getIntensity() — Gets the intensity value for this object
- getMonoisotopicMass() — Gets the neutral mass value for this ion
- getMonoisotopicMassCharge() — Gets the mass-to-charge ratio for this ion
- getRetentionTime() — Gets the retention time in seconds, or the average if a window has been set
- getRetentionTimeWindow() — Gets the retention time window in seconds
- hasRetentionTimeWindow() — Returns true if the retention time is a window
- setAverageMass() — Sets the neutral mass value for this ion
- setAverageMassCharge() — Sets the mass-to-charge ratio for this ion
- setIntensity() — Sets the intensity value for this ion
- setMonoisotopicMass() — Sets the neutral mass value for this ion
- setMonoisotopicMassCharge() — Sets the mass-to-charge ratio for this ion
- setRetentionTime() — Sets the spectra elements retention time
- setRetentionTimeWindow() — Sets the spectra elements retention time or retention time window