Clipper
fftmap_sparse.h
1 
4 //C Copyright (C) 2000-2006 Kevin Cowtan and University of York
5 //L
6 //L This library is free software and is distributed under the terms
7 //L and conditions of version 2.1 of the GNU Lesser General Public
8 //L Licence (LGPL) with the following additional clause:
9 //L
10 //L `You may also combine or link a "work that uses the Library" to
11 //L produce a work containing portions of the Library, and distribute
12 //L that work under terms of your choice, provided that you give
13 //L prominent notice with each copy of the work that the specified
14 //L version of the Library is used in it, and that you include or
15 //L provide public access to the complete corresponding
16 //L machine-readable source code for the Library including whatever
17 //L changes were used in the work. (i.e. If you make changes to the
18 //L Library you must distribute those, but you do not need to
19 //L distribute source or object code to those portions of the work
20 //L not covered by this licence.)'
21 //L
22 //L Note that this clause grants an additional right and does not impose
23 //L any additional restriction, and so does not affect compatibility
24 //L with the GNU General Public Licence (GPL). If you wish to negotiate
25 //L other terms, please contact the maintainer.
26 //L
27 //L You can redistribute it and/or modify the library under the terms of
28 //L the GNU Lesser General Public License as published by the Free Software
29 //L Foundation; either version 2.1 of the License, or (at your option) any
30 //L later version.
31 //L
32 //L This library is distributed in the hope that it will be useful, but
33 //L WITHOUT ANY WARRANTY; without even the implied warranty of
34 //L MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
35 //L Lesser General Public License for more details.
36 //L
37 //L You should have received a copy of the CCP4 licence and/or GNU
38 //L Lesser General Public License along with this library; if not, write
39 //L to the CCP4 Secretary, Daresbury Laboratory, Warrington WA4 4AD, UK.
40 //L The GNU Lesser General Public can also be obtained by writing to the
41 //L Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
42 //L MA 02111-1307 USA
43 
44 
45 #ifndef CLIPPER_FFTMAP_SPARSE
46 #define CLIPPER_FFTMAP_SPARSE
47 
48 
49 #include "fftmap.h"
50 
51 
52 namespace clipper
53 {
54 
57  public:
59  void init( const Grid_sampling& grid_sam, const FFTtype type = Default );
63  const Grid_sampling& grid_real() const { return grid_real_; }
65  const Grid& grid_reci() const { return grid_reci_; }
66 
68  static FFTtype& default_type() { return default_type_; }
69  protected:
71  ffttype* map_uv( const int& u, const int& v );
73  std::complex<ffttype>* map_kl( const int& k, const int& l );
74 
77  FFTtype type_;
78 
81 
82  static FFTtype default_type_;
83  };
84 
86 
92  {
93  public:
97  FFTmap_sparse_p1_hx( const Grid_sampling& grid_sam, const FFTtype type = Default );
98  //-- void init( const Grid_sampling& grid_sam, const FFTtype type = Default );
99  //-- const Grid_sampling& grid_real() const;
100  //-- const Grid& grid_reci() const;
101 
103  void set_hkl( const HKL& hkl, const std::complex<ffttype>& f );
105  std::complex<ffttype>& cplx_data( const Coord_grid& uvw )
106  { return map_kl( uvw.v(), uvw.w() )[ uvw.u() ]; }
108  void require_real_data( const Coord_grid& uvw )
109  { map_uv( uvw.u(), uvw.v() ); }
111  const ffttype& real_data( const Coord_grid& uvw ) const
112  { return row_uv( uvw.u(), uvw.v() )[ uvw.w() ]; }
113 
115  void fft_h_to_x( const ftype& scale );
116  };
117 
119 
125  {
126  public:
130  FFTmap_sparse_p1_xh( const Grid_sampling& grid_sam, const FFTtype type = Default );
131  //-- void init( const Grid_sampling& grid_sam, const FFTtype type = Default );
132  //-- const Grid_sampling& grid_real() const;
133  //-- const Grid& grid_reci() const;
134 
136  ffttype& real_data( const Coord_grid& uvw )
137  { return map_uv( uvw.u(), uvw.v() )[ uvw.w() ]; }
139  void require_hkl( const HKL& hkl );
141  const std::complex<ffttype> get_hkl( const HKL& hkl ) const;
143  void require_cplx_data( const Coord_grid& hkl )
144  { map_kl( hkl.v(), hkl.w() ); }
146  const std::complex<ffttype>& cplx_data( const Coord_grid& hkl ) const
147  { return row_kl( hkl.v(), hkl.w() )[ hkl.u() ]; }
148 
150  void fft_x_to_h( const ftype& scale );
151  };
152 
153 
154 } // namespace clipper
155 
156 #endif
const int & u() const
get u
Definition: coords.h:248
void fft_x_to_h(const ftype &scale)
Transform to real space.
Definition: fftmap_sparse.cpp:294
Grid grid_reci_
reciprocal space grid
Definition: fftmap_sparse.h:76
Simple 2-d array class.
Definition: clipper_types.h:364
Grid coordinate.
Definition: coords.h:236
Definition: fftmap.h:65
FFTmap_sparse_p1_xh()
Null constuctor.
Definition: fftmap_sparse.cpp:243
void require_cplx_data(const Coord_grid &hkl)
express need for reciprocal space data (internal use)
Definition: fftmap_sparse.h:143
const std::complex< ffttype > get_hkl(const HKL &hkl) const
get reciprocal space data by hkl
Definition: fftmap_sparse.cpp:267
static FFTtype default_type_
default optimisation options
Definition: fftmap_sparse.h:82
void require_hkl(const HKL &hkl)
express need for reciprocal space data by hkl
Definition: fftmap_sparse.cpp:255
generic grid
Definition: coords.h:479
FFTmap_sparse_p1_xh: low level sparse P1 map used for calculating FFTs.
Definition: fftmap_sparse.h:124
ftype64 ftype
ftype definition for floating point representation
Definition: clipper_precision.h:58
Grid_sampling grid_real_
real space grid
Definition: fftmap_sparse.h:75
std::complex< ffttype > * map_kl(const int &k, const int &l)
return/create row
Definition: fftmap_sparse.cpp:107
const std::complex< ffttype > & cplx_data(const Coord_grid &hkl) const
get reciprocal space data (internal use)
Definition: fftmap_sparse.h:146
Array2d< std::complex< ffttype > * > row_kl
section map
Definition: fftmap_sparse.h:79
static FFTtype & default_type()
set/get default optimisation type
Definition: fftmap_sparse.h:68
FFTmap_sparse_p1_hx()
Null constuctor.
Definition: fftmap_sparse.cpp:120
Array2d< ffttype * > row_uv
section map
Definition: fftmap_sparse.h:80
const Grid_sampling & grid_real() const
get real grid sampling
Definition: fftmap_sparse.h:63
const Grid & grid_reci() const
get reciprocal grid
Definition: fftmap_sparse.h:65
const int & w() const
get w
Definition: coords.h:250
void fft_h_to_x(const ftype &scale)
Transform to real space.
Definition: fftmap_sparse.cpp:157
~FFTmap_sparse_p1_base()
Destructor.
Definition: fftmap_sparse.cpp:84
Grid sampling of a unit cell.
Definition: coords.h:515
const ffttype & real_data(const Coord_grid &uvw) const
get real space data ( uvw must be in grid_real() )
Definition: fftmap_sparse.h:111
void set_hkl(const HKL &hkl, const std::complex< ffttype > &f)
set reciprocal space data by hkl
Definition: fftmap_sparse.cpp:143
const int & v() const
get v
Definition: coords.h:249
FFTtype type_
optimisation options
Definition: fftmap_sparse.h:77
FFTmap_sparse_p1_hx: low level sparse P1 map used for calculating FFTs.
Definition: fftmap_sparse.h:91
base type for sparse P1 fft maps
Definition: fftmap_sparse.h:56
void init(const Grid_sampling &grid_sam, const FFTtype type=Default)
initialiser: takes grid
Definition: fftmap_sparse.cpp:68
ffttype & real_data(const Coord_grid &uvw)
set real space data ( uvw must be in grid_real() )
Definition: fftmap_sparse.h:136
reflection 'Miller' index
Definition: coords.h:145
ffttype * map_uv(const int &u, const int &v)
return/create row
Definition: fftmap_sparse.cpp:95
std::complex< ffttype > & cplx_data(const Coord_grid &uvw)
set reciprocal space data (internal use)
Definition: fftmap_sparse.h:105
void require_real_data(const Coord_grid &uvw)
express need for real space data
Definition: fftmap_sparse.h:108