Clipper
Public Member Functions
clipper::FFTmap_sparse_p1_hx Class Reference

FFTmap_sparse_p1_hx: low level sparse P1 map used for calculating FFTs. More...

#include <fftmap_sparse.h>

Inheritance diagram for clipper::FFTmap_sparse_p1_hx:
clipper::FFTmap_sparse_p1_base clipper::FFTmap_base

List of all members.

Public Member Functions

 FFTmap_sparse_p1_hx ()
 Null constuctor.
 FFTmap_sparse_p1_hx (const Grid_sampling &grid_sam, const FFTtype type=Default)
 Constructor: takes grid.
void init (const Grid_sampling &grid_sam, const FFTtype type=Default)
 initialiser: takes grid
const Grid_samplinggrid_real () const
 get real grid sampling
const Gridgrid_reci () const
 get reciprocal grid
void set_hkl (const HKL &hkl, const std::complex< ffttype > &f)
 set reciprocal space data by hkl
std::complex< ffttype > & cplx_data (const Coord_grid &uvw)
 set reciprocal space data (internal use)
void require_real_data (const Coord_grid &uvw)
 express need for real space data
const ffttype & real_data (const Coord_grid &uvw) const
 get real space data ( uvw must be in grid_real() )
void fft_h_to_x (const ftype &scale)
 Transform to real space.

Detailed Description

FFTmap_sparse_p1_hx: low level sparse P1 map used for calculating FFTs.

This version computes sparse Hermititan...real FFTs.

By specifying what parts of the map are needed in advance, it is possible to perform highly optimised FFTs, including some of the benefits of symmetry.


Constructor & Destructor Documentation

clipper::FFTmap_sparse_p1_hx::FFTmap_sparse_p1_hx ( )

Null constuctor.

For later initialisation: see init()

clipper::FFTmap_sparse_p1_hx::FFTmap_sparse_p1_hx ( const Grid_sampling grid_sam,
const FFTtype  type = Default 
)

Constructor: takes grid.

Construct an FFTmap_sparse_p1_hx for a given grid.

Parameters:
grid_samThe grid sampling of the unit cell.
typeCan be FFTmap_sparse_base::Measure, ::Estimate. Measure performs slow precalculation (first time only) to get faster FFT.

References init().


Member Function Documentation

void clipper::FFTmap_sparse_p1_hx::init ( const Grid_sampling grid_sam,
const FFTtype  type = Default 
)

initialiser: takes grid

Initialise an FFTmap_sparse_p1_base for a grid.

Parameters:
grid_samThe grid sampling of the unit cell.
typeCan be FFTmap_sparse_base::Measure, ::Estimate. Measure performs slow precalculation (first time only) to get faster FFT.

Reimplemented from clipper::FFTmap_sparse_p1_base.

Referenced by FFTmap_sparse_p1_hx().

void clipper::FFTmap_sparse_p1_hx::set_hkl ( const HKL hkl,
const std::complex< ffttype > &  f 
)

set reciprocal space data by hkl

Friedel opposites are handled correctly

Parameters:
hklThe HKL to set.
fThe complex value to set.

References cplx_data(), clipper::FFTmap_sparse_p1_base::grid_real_, clipper::FFTmap_sparse_p1_base::grid_reci_, clipper::Grid::nw(), clipper::Coord_grid::unit(), and clipper::Coord_grid::w().

Referenced by clipper::Xmap< T >::fft_from().

void clipper::FFTmap_sparse_p1_hx::require_real_data ( const Coord_grid uvw) [inline]

express need for real space data

The given Coord_grid will be required in the final map. ( uvw must be in grid_sampling() )

Parameters:
uvwThe coordinate to require.

References clipper::FFTmap_sparse_p1_base::map_uv(), clipper::Coord_grid::u(), and clipper::Coord_grid::v().

Referenced by clipper::Xmap< T >::fft_from().

const ffttype & clipper::FFTmap_sparse_p1_hx::real_data ( const Coord_grid uvw) const [inline]

get real space data ( uvw must be in grid_real() )

( uvw must be in grid_sampling(), and have been requested )

Parameters:
uvwThe coordinate to get.
Returns:
The real value at that coordinate.

References clipper::FFTmap_sparse_p1_base::row_uv, clipper::Coord_grid::u(), clipper::Coord_grid::v(), and clipper::Coord_grid::w().

Referenced by clipper::Xmap< T >::fft_from().

void clipper::FFTmap_sparse_p1_hx::fft_h_to_x ( const ftype scale)

The documentation for this class was generated from the following files: