ReassignedSpectrum.h

#ifndef INCLUDE_REASSIGNEDSPECTRUM_H
#define INCLUDE_REASSIGNEDSPECTRUM_H
/*
 * This is the Loris C++ Class Library, implementing analysis, 
 * manipulation, and synthesis of digitized sounds using the Reassigned 
 * Bandwidth-Enhanced Additive Sound Model.
 *
 * Loris is Copyright (c) 1999-2007 by Kelly Fitz and Lippold Haken
 *
 * 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 2 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *
 * ReassignedSpectrum.h
 *
 * Definition of class Loris::ReassignedSpectrum.
 *
 * Kelly Fitz, 7 Dec 1999
 * loris@cerlsoundgroup.org
 *
 * http://www.cerlsoundgroup.org/Loris/
 *
 */

#include "FourierTransform.h"
#include <vector>

//  begin namespace
namespace Loris {

// ---------------------------------------------------------------------------
//  class ReassignedSpectrum
//
//  
class ReassignedSpectrum
{
//  -- public interface --
public:
    typedef FourierTransform::size_type size_type;

//  --- lifecycle ---

    ReassignedSpectrum( const std::vector< double > & window );

    // compiler-generated copy, assign, and destroy are sufficient

//  --- operations ---

    void transform( const double * sampsBegin, const double * pos, const double * sampsEnd );
    
//  --- inquiry ---

    size_type size( void ) const;   

    const std::vector< double > & window( void ) const;
    

//  --- reassigned transform access ---
        
    double convergence( long idx ) const;

    double reassignedFrequency( long idx ) const;

    double reassignedMagnitude( long idx ) const;

    double reassignedPhase( long idx ) const;   

    double reassignedTime( long idx ) const;

//  --- reassignment operations ---
    
    double frequencyCorrection( long sample ) const;

    double timeCorrection( long sample ) const;

//  --- legacy support ---

    //  These members are deprecated, and included only
    //  to support old code. New code should use the
    //  corresponding documented members.
    //  All of these members are deprecated.
    
    double reassignedPhase( long idx, double, double ) const
        { return reassignedPhase( idx ); }
    double reassignedMagnitude( double, long intBinNumber ) const
        { return reassignedMagnitude( intBinNumber ); }
    
    //  subscript operator
    //  The signature has changed, can no longer return a reference,
    //  but since the reference returned was const, this version should 
    //  keep most old code working, if not all.
    std::complex< double > operator[]( unsigned long idx ) const;
    
private:
//  -- instance variables --

    FourierTransform mMagnitudeTransform;
    
    FourierTransform mCorrectionTransform;
    
    std::vector< double > mWindow;
    
    std::vector< std::complex< double > > mMagnitudeTransformWindow;

    std::vector< std::complex< double > > mCorrectionTransformWindow;
        
};  //  end of class ReassignedSpectrum

}   //  end of namespace Loris

#endif /* ndef INCLUDE_REASSIGNEDSPECTRUM_H */

---