ObitFFT.h

Go to the documentation of this file.

/* $Id: ObitFFT.h,v 1.7 2007/08/31 17:24:48 bcotton Exp $         */
/*--------------------------------------------------------------------*/
/*;  Copyright (C) 2003-2007                                          */
/*;  Associated Universities, Inc. Washington DC, USA.                */
/*;                                                                   */
/*;  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.              */
/*;                                                                   */
/*;  This program is distributed in the hope that it will be useful,  */
/*;  but WITHOUT ANY WARRANTY; without even the implied warranty of   */
/*;  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    */
/*;  GNU General Public License for more details.                     */
/*;                                                                   */
/*;  You should have received a copy of the GNU General Public        */
/*;  License along with this program; if not, write to the Free       */
/*;  Software Foundation, Inc., 675 Massachusetts Ave, Cambridge,     */
/*;  MA 02139, USA.                                                   */
/*;                                                                   */
/*;Correspondence about this software should be addressed as follows: */
/*;         Internet email: bcotton@nrao.edu.                         */
/*;         Postal address: William Cotton                            */
/*;                         National Radio Astronomy Observatory      */
/*;                         520 Edgemont Road                         */
/*;                         Charlottesville, VA 22903-2475 USA        */
/*--------------------------------------------------------------------*/
#ifndef OBITFFT_H 
#define OBITFFT_H 

/* Disable FFTW if not needed */
#if HAVE_FFTW==1
#include <fftw.h>
#include <rfftw.h>
#elif HAVE_GSL==1  /* Else try GSL version */
#include <gsl/gsl_fft_complex_float.h>
#include <gsl/gsl_fft_halfcomplex_float.h>
#include <gsl/gsl_fft_real_float.h>
#endif /* HAVE_GSL */
#include "Obit.h"
#include "ObitThread.h"
#include "ObitFArray.h"
#include "ObitCArray.h"

/*-------- Obit: Software for the recently deceased ------------------*/
/*-------------- enumerations -------------------------------------*/
enum obitFFTdir {
  OBIT_FFT_Forward,
  OBIT_FFT_Reverse
}; /* end enum obitFFTdir */
typedef enum obitFFTdir ObitFFTdir;

enum obitFFTtype {
  OBIT_FFT_FullComplex,
  OBIT_FFT_HalfComplex
}; /* end enum obitFFTtype */
typedef enum obitFFTtype ObitFFTtype;

/*--------------Class definitions-------------------------------------*/
typedef struct {
#include "ObitFFTDef.h"   /* this class definition */
} ObitFFT;

/*----------------- Macroes ---------------------------*/
#define ObitFFTUnref(in) ObitUnref (in)

#define ObitFFTRef(in) ObitRef (in)

#define ObitFFTIsA(in) ObitIsA (in, ObitFFTGetClass())

/*---------------Public functions---------------------------*/
void ObitFFTClassInit (void);

ObitFFT* newObitFFT (gchar* name, ObitFFTdir dir, ObitFFTtype type, 
                     gint rank, gint *dim);
typedef ObitFFT* (*newObitFFTFP) (gchar *name, ObitFFTdir dir, 
                                  ObitFFTtype type, 
                                  gint rank, gint *dim);

gconstpointer ObitFFTGetClass (void);

gint ObitFFTSuggestSize (gint length);

void ObitFFTR2C (ObitFFT *in, ObitFArray *inArray, ObitCArray *outArray);
typedef void (*ObitFFTR2CFP) (ObitFFT *in, ObitFArray *inArray, 
                            ObitCArray *outArray);

void ObitFFTC2R (ObitFFT *in, ObitCArray *inArray, ObitFArray *outArray);
typedef void (*ObitFFTC2RFP) (ObitFFT *in, ObitCArray *inArray, 
                            ObitFArray *outArray);

void ObitFFTC2C (ObitFFT *in, ObitCArray *inArray, ObitCArray *outArray);
typedef void (*ObitFFTC2CFP) (ObitFFT *in, ObitCArray *inArray, 
                            ObitCArray *outArray);

/*----------- ClassInfo Structure -----------------------------------*/
typedef struct  {
#include "ObitFFTClassDef.h"
} ObitFFTClassInfo; 

#endif /* OBITFFT_H */ 

---