fftmap_sparse.h

//C Copyright (C) 2000-2006 Kevin Cowtan and University of York
//L
//L  This library is free software and is distributed under the terms
//L  and conditions of version 2.1 of the GNU Lesser General Public
//L  Licence (LGPL) with the following additional clause:
//L
//L     `You may also combine or link a "work that uses the Library" to
//L     produce a work containing portions of the Library, and distribute
//L     that work under terms of your choice, provided that you give
//L     prominent notice with each copy of the work that the specified
//L     version of the Library is used in it, and that you include or
//L     provide public access to the complete corresponding
//L     machine-readable source code for the Library including whatever
//L     changes were used in the work. (i.e. If you make changes to the
//L     Library you must distribute those, but you do not need to
//L     distribute source or object code to those portions of the work
//L     not covered by this licence.)'
//L
//L  Note that this clause grants an additional right and does not impose
//L  any additional restriction, and so does not affect compatibility
//L  with the GNU General Public Licence (GPL). If you wish to negotiate
//L  other terms, please contact the maintainer.
//L
//L  You can redistribute it and/or modify the library under the terms of
//L  the GNU Lesser General Public License as published by the Free Software
//L  Foundation; either version 2.1 of the License, or (at your option) any
//L  later version.
//L
//L  This library is distributed in the hope that it will be useful, but
//L  WITHOUT ANY WARRANTY; without even the implied warranty of
//L  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//L  Lesser General Public License for more details.
//L
//L  You should have received a copy of the CCP4 licence and/or GNU
//L  Lesser General Public License along with this library; if not, write
//L  to the CCP4 Secretary, Daresbury Laboratory, Warrington WA4 4AD, UK.
//L  The GNU Lesser General Public can also be obtained by writing to the
//L  Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
//L  MA 02111-1307 USA


#ifndef CLIPPER_FFTMAP_SPARSE
#define CLIPPER_FFTMAP_SPARSE


#include "fftmap.h"


namespace clipper
{

  class FFTmap_sparse_p1_base : public FFTmap_base {
  public:
    void init( const Grid_sampling& grid_sam, const FFTtype type = Default );
    ~FFTmap_sparse_p1_base();
    const Grid_sampling& grid_real() const { return grid_real_; }
    const Grid& grid_reci() const { return grid_reci_; }

    static FFTtype& default_type() { return default_type_; }
  protected:
    ffttype* map_uv( const int& u, const int& v );
    std::complex<ffttype>* map_kl( const int& k, const int& l );

    Grid_sampling grid_real_;           
    Grid grid_reci_;                    
    FFTtype type_;                      

    Array2d<std::complex<ffttype>*> row_kl; 
    Array2d<ffttype*> row_uv;               

    static FFTtype default_type_;       
  };


  class FFTmap_sparse_p1_hx : public FFTmap_sparse_p1_base
  {
  public:
    FFTmap_sparse_p1_hx();
    FFTmap_sparse_p1_hx( const Grid_sampling& grid_sam, const FFTtype type = Default );
    //-- void init( const Grid_sampling& grid_sam, const FFTtype type = Default );
    //-- const Grid_sampling& grid_real() const;
    //-- const Grid& grid_reci() const;

    void set_hkl( const HKL& hkl, const std::complex<ffttype>& f );
    std::complex<ffttype>& cplx_data( const Coord_grid& uvw )
      { return map_kl( uvw.v(), uvw.w() )[ uvw.u() ]; }
    void require_real_data( const Coord_grid& uvw )
      { map_uv( uvw.u(), uvw.v() ); }
    const ffttype& real_data( const Coord_grid& uvw ) const
      { return row_uv( uvw.u(), uvw.v() )[ uvw.w() ]; }

    void fft_h_to_x( const ftype& scale );
  };


  class FFTmap_sparse_p1_xh : public FFTmap_sparse_p1_base
  {
  public:
    FFTmap_sparse_p1_xh();
    FFTmap_sparse_p1_xh( const Grid_sampling& grid_sam, const FFTtype type = Default );
    //-- void init( const Grid_sampling& grid_sam, const FFTtype type = Default );
    //-- const Grid_sampling& grid_real() const;
    //-- const Grid& grid_reci() const;

    ffttype& real_data( const Coord_grid& uvw )
      { return map_uv( uvw.u(), uvw.v() )[ uvw.w() ]; }
    void require_hkl( const HKL& hkl );
    const std::complex<ffttype> get_hkl( const HKL& hkl ) const;
    void require_cplx_data( const Coord_grid& hkl )
      { map_kl( hkl.v(), hkl.w() ); }
    const std::complex<ffttype>& cplx_data( const Coord_grid& hkl ) const
      { return row_kl( hkl.v(), hkl.w() )[ hkl.u() ]; }

    void fft_x_to_h( const ftype& scale );
  };


} // namespace clipper

#endif