mcx_utils.h

Go to the documentation of this file.

/*******************************************************************************
**  Mesh-based Monte Carlo (MMC) -- this unit was ported from MCX
**
**  Monte Carlo eXtreme (MCX)  - GPU accelerated Monte Carlo 3D photon migration
**  Author: Qianqian Fang <fangq at nmr.mgh.harvard.edu>
**
**  Reference:
**  (Fang2010) Qianqian Fang, "Mesh-based Monte Carlo Method Using Fast Ray-Tracing 
**          in Plücker Coordinates," Biomed. Opt. Express, 1(1) 165-175 (2010)
**
**  (Fang2009) Qianqian Fang and David A. Boas, "Monte Carlo Simulation of Photon 
**          Migration in 3D Turbid Media Accelerated by Graphics Processing 
**          Units," Optics Express, 17(22) 20178-20190 (2009)
**
**  License: GPL v3, see LICENSE.txt for details
**
*******************************************************************************/

/***************************************************************************/
#ifndef _MMC_UTILITIES_H
#define _MMC_UTILITIES_H

#include <stdio.h>
#include <vector_types.h>

#define MAX_PROP            256
#define MAX_DETECTORS       256
#define MAX_PATH_LENGTH     1024
#define MAX_SESSION_LENGTH  256
#define MIN(a,b)            ((a)<(b)?(a):(b))

#define MMCDEBUG(cfg,debugflag,outputstr)  {\
                                if((cfg)->debuglevel & (debugflag)) {\
                                        fprintf outputstr ;\
                                        fflush((cfg)->flog);\
                                }\
                            }

enum TDebugLevel {dlMove=1,dlTracing=2,dlBary=4,dlWeight=8,dlDist=16,dlTracingEnter=32,
                  dlTracingExit=64,dlEdge=128,dlAccum=256,dlTime=512,dlReflect=1024,
                  dlProgress=2048};

/***************************************************************************/
typedef struct MMC_medium{
        float mua;        
        float mus;        
        float n;          
        float g;          
} medium;


/***************************************************************************/
typedef struct MMC_config{
        int nphoton;      
        //int totalmove;   /**< [depreciated] total move per photon*/
        int nblocksize;   
        int nthread;      
        int seed;         
        float3 srcpos;    
        float3 srcdir;    
        float tstart;     
        float tstep;      
        float tend;       
        float3 steps;     
        uint3 dim;        
        uint3 crop0;      
        uint3 crop1;      
        int medianum;     
        int detnum;       
        float detradius;  
        float sradius;    
        medium *prop;     
        float4 *detpos;   
        float  minstep;   
        int maxgate;        
        int respin;         
        int printnum;       
        unsigned char *vol; 
        char session[MAX_SESSION_LENGTH]; 
        char meshtag[MAX_PATH_LENGTH];   
        char isrowmajor;    
        char isreflect;     
        char isref3;        
        char isnormalized;  
        char issavedet;     
        char issave2pt;     
        char isgpuinfo;     
        char basisorder;    
        float roulettesize; 
        float minenergy;    
        float nout;         
        FILE *flog;         
        char rootpath[MAX_PATH_LENGTH]; 
        unsigned int debuglevel; 
        float unitinmm;     
} Config;

#ifdef  __cplusplus
extern "C" {
#endif
void mcx_savedata(float *dat,int len,Config *cfg);
void mcx_error(int id,char *msg);
void mcx_loadconfig(FILE *in, Config *cfg);
void mcx_saveconfig(FILE *in, Config *cfg);
void mcx_readconfig(char *fname, Config *cfg);
void mcx_writeconfig(char *fname, Config *cfg);
void mcx_initcfg(Config *cfg);
void mcx_clearcfg(Config *cfg);
void mcx_parsecmd(int argc, char* argv[], Config *cfg);
void mcx_usage(char *exename);
void mcx_loadvolume(char *filename,Config *cfg);
void mcx_normalize(float field[], float scale, int fieldlen);
int  mcx_readarg(int argc, char *argv[], int id, void *output,char *type);
void mcx_printlog(Config *cfg, char *str);
int  mcx_remap(char *opt);
int  mcx_parsedebugopt(char *debugopt);
void mcx_progressbar(unsigned int n, unsigned int ntotal, Config *cfg);

#ifdef  __cplusplus
}
#endif

#endif

---