FrequencyData.hpp

Go to the documentation of this file.

//
// $Id$
//
//
// Original author: Darren Kessner <darren@proteowizard.org>
//
// Copyright 2006 Louis Warschaw Prostate Cancer Center
//   Cedars Sinai Medical Center, Los Angeles, California  90048
//
// Licensed under the Apache License, Version 2.0 (the "License"); 
// you may not use this file except in compliance with the License. 
// You may obtain a copy of the License at 
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software 
// distributed under the License is distributed on an "AS IS" BASIS, 
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
// See the License for the specific language governing permissions and 
// limitations under the License.
//
 
 
#ifndef _FREQUENCYDATA_HPP_
#define _FREQUENCYDATA_HPP_
 
 
#include "pwiz/utility/misc/Export.hpp"
#include "SampleDatum.hpp"
#include "CalibrationParameters.hpp"
#include <vector>
#include <complex>
#include <memory>
 
 
namespace pwiz {
namespace data {
 
 
typedef SampleDatum< double, std::complex<double> > FrequencyDatum;
 
 
/// Class for binary storage of complex frequency data.
 
/// Stores raw frequency-domain data, as well as meta-data.  Also includes
/// basic access and analysis functions.
 
class PWIZ_API_DECL FrequencyData
{
    public:
 
    /// \name types
    //@{
        enum PWIZ_API_DECL IOMode {Binary, Text, Automatic};
        typedef std::vector<FrequencyDatum> container;
        typedef container::iterator iterator;
        typedef container::const_iterator const_iterator;
    //@}
 
    /// \name instantiation
    //@{
        FrequencyData();
        FrequencyData(const std::string& filename, IOMode mode=Automatic);
        FrequencyData(const FrequencyData& that, const_iterator begin, const_iterator end);