nxmap_operator.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_NXMAP_OPERATOR
#define CLIPPER_NXMAP_OPERATOR

#include "xmap.h"
#include "nxmap.h"


namespace clipper
{


  class NX_operator
  {
  public:
    NX_operator();
    NX_operator( const Xmap_base& xmap, const NXmap_base& nxmap, const RTop_orth& rtop );
    NX_operator( const Cell& cell, const Grid_sampling& grid, const NXmap_base& nxmap, const RTop_orth& rtop  );
    void init( const Xmap_base& xmap, const NXmap_base& nxmap, const RTop_orth& rtop  );
    void init( const Cell& cell, const Grid_sampling& grid, const NXmap_base& nxmap, const RTop_orth& rtop  );

    inline Coord_map coord_map( const Coord_frac& c ) const
      { return Coord_map( xfrac_nxgrid * c ); }
    inline Coord_frac coord_frac( const Coord_map& c ) const
      { return Coord_frac( nxgrid_xfrac * c ); }
    template<class I, class T, class M> T nxmap_data( const M& nxmap, const Coord_grid& c ) const;
    template<class I, class T, class M> T xmap_data( const M& xmap, const Coord_grid& c ) const;

    bool is_null() const;

    void debug() const;

  protected:
    RTop<> xfrac_nxgrid;    
    RTop<> nxgrid_xfrac;    
    RTop<> xgrid_nxgrid;    
    RTop<> nxgrid_xgrid;    
    RTop<int> xgrid_nxgrid_int;  
    RTop<int> nxgrid_xgrid_int;  
    bool x_nx_is_int;      
    bool x_nx_is_trn;      
    bool nx_x_is_int;      
    bool nx_x_is_trn;      
  };



  template<class T> class NXmap_operator : public NX_operator
  {
  public:
    NXmap_operator() {}
    NXmap_operator( const Xmap_base& xmap, const NXmap<T>& nxmap, const RTop_orth& rtop ) { init( xmap, nxmap, rtop ); }
    NXmap_operator( const Cell& cell, const Grid_sampling& grid, const NXmap<T>& nxmap, const RTop_orth& rtop  ) { init( cell, grid, nxmap, rtop ); }
    void init( const Xmap_base& xmap, const NXmap<T>& nxmap, const RTop_orth& rtop  ) { init( xmap.cell(), xmap.grid_sampling(), nxmap, rtop ); }
    void init( const Cell& cell, const Grid_sampling& grid, const NXmap<T>& nxmap, const RTop_orth& rtop  ) { nxmap_ = &nxmap; NX_operator::init( cell, grid, nxmap, rtop ); }

    template<class I> T nxmap_data( const Coord_grid& c ) const
      { return NX_operator::nxmap_data<I,T>( *nxmap_, c ); }

    const NXmap<T>& nxmap() const { return *nxmap_; }

  private:
    const NXmap<T>* nxmap_;  
  };



  // template implementations

  template<class I, class T, class M> T NX_operator::nxmap_data( const M& nxmap, const Coord_grid& c ) const
  {
    if ( x_nx_is_trn ) {
      return T( nxmap.get_data( Coord_grid( c + xgrid_nxgrid_int.trn() ) ) );
    } else if ( x_nx_is_int ) {
      return T( nxmap.get_data( Coord_grid( xgrid_nxgrid_int * c ) ) );
    } else {
      T val;
      I::interp( nxmap, Coord_map( xgrid_nxgrid * c.coord_map() ), val );
      return val;
    }
  }


  template<class I, class T, class M> T NX_operator::xmap_data( const M& xmap, const Coord_grid& c ) const
  {
    if ( nx_x_is_trn ) {
      return T( xmap.get_data( Coord_grid( c + nxgrid_xgrid_int.trn() ) ) );
    } else if ( nx_x_is_int ) {
      return T( xmap.get_data( Coord_grid( nxgrid_xgrid_int * c ) ) );
    } else {
      T val;
      I::interp( xmap, Coord_map( nxgrid_xgrid * c.coord_map() ), val );
      return val;
    }
  }


} // namespace clipper

#endif