saf_sh_internal.h

Go to the documentation of this file.

/*
 * Copyright 2016-2018 Leo McCormack
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */
 
#ifndef __SAF_SH_INTERNAL_H_INCLUDED__
#define __SAF_SH_INTERNAL_H_INCLUDED__
 
#include "saf_sh.h" 
#include "../saf_utilities/saf_utilities.h" /* for linear algebra speed-ups */
#include "saf_externals.h" 
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef struct _sphPWD_data {
    int order, nSH, nDirs;
    float_complex* grid_svecs;
    float_complex* A_Cx; 
    float* grid_dirs_xyz; 
    float* pSpec;
    float* P_minus_peak;
    float* P_tmp;
    float* VM_mask;
 
}sphPWD_data;
 
typedef struct _sphMUSIC_data {
    int order, nSH, nDirs;
    float_complex* grid_svecs;
    float_complex* VnA;
    float* grid_dirs_xyz;
    float* abs_VnA;
    float* pSpec;
    float* pSpecInv;
    float* P_minus_peak;
    float* P_tmp;
    float* VM_mask;
 
}sphMUSIC_data;
 
typedef struct _sphESPRIT_data {
    int N, NN, maxK;
 
    /* matrices and indices to be pre-computed */
    double* rWVnimu[6];             /* [6] x FLAT: N^2 x N^2 */
    double_complex* WVnimu[6];      /* [6] x FLAT: N^2 x N^2 */
    int* idx_from_Ynm2Ynimu[12];    /* [12] x nIdx[i] x 1 */
    int nIdx[12];                   /* number of indices in each "idx_from_Ynm2Ynimu" vector */
 
    /* matrices for run-time */
    void* hZpinv, *hZeigmp, *hZglslv;
    double_complex* Us_1m1, *Us_m1m1, *Us_11, *Us_m11, *Us_m10, *Us_10, *Us_00;
    double_complex* WVnimu0_Us1m1, *WVnimu1_Usm1m1, *WVnimu2_Us11;
    double_complex* WVnimu3_Usm11, *WVnimu4_Usm10,  *WVnimu5_Us10;
    double_complex* LambdaXYp, *LambdaXYm, *LambdaZ;
    double_complex* pinvUs, *PsiXYp, *PsiXYm, *PsiZ;
    double_complex* tmp_KK, *V, *PhiXYp, *PhiXYm, *PhiZ;
 
}sphESPRIT_data;
 
 
/* ========================================================================== */
/*                          Misc. Internal Functions                          */
/* ========================================================================== */
 
float wigner_3j(/* Input arguments */
                int j1,
                int j2,
                int j3,
                int m1,
                int m2,
                int m3);
 
void gaunt_mtx(/* Input arguments */
               int N1,
               int N2,
               int N,
               /* Output arguments */
               float* A);
 
 
/* ========================================================================== */
/*             Internal functions for spherical harmonic rotations            */
/* ========================================================================== */
 
float getP(int M, int i, int l, int a, int b, float R_1[3][3], float* R_lm1);
 
float getU(int M, int l, int m, int n, float R_1[3][3], float* R_lm1);
 
float getV(int M, int l, int m, int n, float R_1[3][3], float* R_lm1);
 
float getW(int M, int l, int m, int n, float R_1[3][3], float* R_lm1);
 
float getW(int M, int l, int m, int n, float R_1[3][3], float* R_lm1);
 
 
/* ========================================================================== */
/*                        Internal functions for sphESPRIT                    */
/* ========================================================================== */
 
void getWnimu(int order, int mm, int ni, int mu, double* Wnimu);
 
void getVnimu(int order, int ni, int mu, double* Vnimu);
 
void muni2q(int order, int ni, int mu, int* idx_nimu, int* idx_nm);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __SAF_SH_INTERNAL_H_INCLUDED__ */