saf_cdf4sap.h

Go to the documentation of this file.

/*
 * Copyright 2018-2019 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_CDF4SAP_H_INCLUDED__
#define __SAF_CDF4SAP_H_INCLUDED__
 
#include "../saf_utilities/saf_utility_complex.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
 
void cdf4sap_create(/* Input Arguments */
                    void ** const phCdf,
                    int nXcols,
                    int nYcols);
 
void cdf4sap_cmplx_create(/* Input Arguments */
                          void ** const phCdf,
                          int nXcols,
                          int nYcols);
 
void cdf4sap_destroy(/* Input Arguments */
                     void ** const phCdf);
 
void cdf4sap_cmplx_destroy(/* Input Arguments */
                           void ** const phCdf);
 
void formulate_M_and_Cr(/* Input Arguments */
                        void * const hCdf,
                        float* Cx,
                        float* Cy,
                        float* Q,
                        int useEnergyFLAG,
                        float reg,
                        /* Output Arguments */
                        float* M,
                        float* Cr);
 
void formulate_M_and_Cr_cmplx(/* Input Arguments */
                              void * const hCdf,
                              float_complex* Cx,
                              float_complex* Cy,
                              float_complex* Q,
                              int useEnergyFLAG,
                              float reg,
                              /* Output Arguments */
                              float_complex* M,
                              float_complex* Cr);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif  /* __SAF_CDF4SAP_H_INCLUDED__ */
 
 /* doxygen addtogroup CDF4SAP */