jdxfunction.h

/***************************************************************************
                          jdxfunction.h  -  description
                             -------------------
    begin                : Mon Jun 24 2002
    copyright            : (C) 2000-2014 by Thies H. Jochimsen
    email                : thies@jochimsen.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef JDXFUNCTION_H
#define JDXFUNCTION_H

#include <odinpara/jdxblock.h>

enum funcType {shapeFunc=0, trajFunc, filterFunc};

enum funcMode {zeroDeeMode=0,oneDeeMode,twoDeeMode,n_dimModes};


class OdinPulse; // forward declaration


struct kspace_coord {

  kspace_coord() : index(-1), traj_s(0.0), kx(0), ky(0), kz(0), Gx(0), Gy(0), Gz(0), denscomp(1.0) {}

  mutable int index;

  float traj_s;

  float kx;

  float ky;

  float kz;

  float Gx;

  float Gy;

  float Gz;

  float denscomp;
};



struct shape_info {

  shape_info() : ref_x_pos(0), ref_y_pos(0), ref_z_pos(0), adiabatic(false), fixed_size(-1), spatial_extent(0.0) {}

  float ref_x_pos; // Reference position to adjust flip angle
  float ref_y_pos;
  float ref_z_pos;
  bool adiabatic; // Whether pulse is adiabatic
  int fixed_size; // Pulse has fixed size (for imported pulses)
  float spatial_extent;
};


struct traj_info {

  traj_info() : rel_center(0), max_kspace_step(0) {}

  float rel_center;
  float max_kspace_step;

};


class JDXfunctionPlugIn : public JcampDxBlock {

 public:
  JDXfunctionPlugIn(const STD_string& funclabel) : JcampDxBlock(funclabel) {}

  JDXfunctionPlugIn(const JDXfunctionPlugIn& jfp) : JcampDxBlock(jfp) {}

  virtual ~JDXfunctionPlugIn() {}

  JDXfunctionPlugIn& operator = (const JDXfunctionPlugIn& jfp) {JcampDxBlock::operator = (jfp); return *this;}

  JDXfunctionPlugIn& register_function(funcType type, funcMode mode);

  // virtual functions for pulse shapes
  virtual void init_shape() {}
  virtual STD_complex calculate_shape(const kspace_coord& coord ) const {return STD_complex(0.0);}
  virtual STD_complex calculate_shape(float s, float Tp) const {return STD_complex(0.0);}
  virtual const shape_info& get_shape_properties() const {return shape_info_retval;}


  // virtual functions for pulse trajectories
  virtual void init_trajectory(OdinPulse* pls) {}
  virtual const kspace_coord& calculate_traj(float s) const {return coord_retval;}
  virtual const traj_info& get_traj_properties() const {return traj_info_retval;}

  // virtual functions for filters
  virtual float calculate_filter(float rel_kradius) const {return 0;}



  // virtual constructor
  virtual JDXfunctionPlugIn* clone() const = 0;

  // local statics do not work on IDEA
  static kspace_coord coord_retval;
//  static shape_vals   shape_retval;
  static shape_info   shape_info_retval;
  static traj_info    traj_info_retval;

};



// Wrapper to bundle JDXfunctionPlugIn and funcType/funcMode together so it can be inserted into lists
// multiple times with different funcTypes and funcModes
struct JDXfunctionEntry {

  JDXfunctionEntry(JDXfunctionPlugIn* func_plugin, funcType func_type, funcMode func_mode)
    : plugin(func_plugin), type(func_type),  mode(func_mode) {}

  JDXfunctionPlugIn* plugin;

  const funcType type;
  const funcMode mode;

  bool operator == (const JDXfunctionEntry& jfe) const;
  bool operator <  (const JDXfunctionEntry& jfe) const;

};



class JDXfunction : public JcampDxClass, public StaticHandler<JDXfunction> {

 public:

  ~JDXfunction() {new_plugin(0);}

  JDXfunction& set_function_mode(funcMode newmode);
  funcMode get_function_mode() const {return mode;}

  const STD_string& get_function_label(unsigned int index) const;
  JDXfunction& set_function(const STD_string& funclabel);
  JDXfunction& set_function(unsigned int index);
  unsigned int get_function_index() const;

  JcampDxBlock* get_funcpars_block();

  JDXfunction& set_funcpars(const svector& funcpars);
  JDXfunction& set_funcpars(const STD_string& funcpars) {STD_string tt(funcpars); parsevalstring(tt); return *this;}
  svector get_funcpars() const;

  bool set_parameter(const STD_string& parameter_label, const STD_string& value);
  STD_string get_parameter(const STD_string& parameter_label) const;

  STD_string get_function_name() const;

  const STD_string& get_funcdescription() const;


  // overwriting virtual functions from JcampDxClass
  JDXfunction* cast(JDXfunction*) {return this;}
  bool parsevalstring (const STD_string& parstring);
  STD_string printvalstring() const;
  svector get_alternatives() const;
  const char* get_typeInfo() const {return "function";}
  JcampDxClass* create_copy() const {return new JDXfunction(*this);}


  // stuff for StaticHandler
  static void init_static();
  static void destroy_static();


 protected:

  // Make it impossible to create/use instance of JDXfunction directly
  JDXfunction(funcType function_type, const STD_string& jdxlabel);
  JDXfunction(const JDXfunction& jf);
  JDXfunction& operator = (const JDXfunction& jf);

  funcMode mode;
  JDXfunctionPlugIn* allocated_function;

 private:
  friend class JDXfunctionPlugIn;




  void new_plugin(JDXfunctionPlugIn* pi);

  const funcType type;


  static STD_list<JDXfunctionEntry>* registered_functions;

};


#endif