ObitCArray.h

Go to the documentation of this file.

/* $Id: ObitCArray.h,v 1.9 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 OBITCARRAY_H 
#define OBITCARRAY_H 

#include "Obit.h"
#include "ObitErr.h"
#include "ObitThread.h"
#include "ObitInfoList.h"
#include "ObitFArray.h"

/*-------- Obit: Software for the recently deceased ------------------*/
/*--------------Class definitions-------------------------------------*/
typedef struct {
#include "ObitCArrayDef.h"   /* this class definition */
} ObitCArray;

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

#define ObitCArrayRef(in) ObitRef (in)

#define ObitCArrayIsA(in) ObitIsA (in, ObitCArrayGetClass())

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

ObitCArray* newObitCArray (gchar* name);

ObitCArray* ObitCArrayCreate (gchar* name, glong ndim, glong *naxis);
typedef void (*ObitCArrayCreateFP) (gchar* name, glong ndim, glong *naxis);

gconstpointer ObitCArrayGetClass (void);

ObitCArray* ObitCArrayCopy  (ObitCArray *in, ObitCArray *out, ObitErr *err);

gboolean ObitCArrayIsCompatable  (ObitCArray *in1, ObitCArray *in2);
typedef gboolean (*ObitCArrayIsCompatableFP) (ObitCArray *in1, ObitCArray *in2);

ObitCArray* ObitCArrayRealloc (ObitCArray* in, glong ndim, glong *naxis);
typedef void (*ObitCArrayReallocFP) (ObitCArray* in, glong ndim, glong *naxis);

gfloat* ObitCArrayIndex (ObitCArray* in, glong *pos);
typedef gfloat* (*ObitCArrayIndexFP) (ObitCArray* in, glong *pos);

gfloat ObitCArrayMaxAbs (ObitCArray* in, glong *pos);
typedef gfloat (*ObitCArrayMaxAbsFP) (ObitCArray* in, glong *pos);

gfloat ObitCArrayMin (ObitCArray* in, glong *pos);
typedef gfloat (*ObitCArrayMinFP) (ObitCArray* in, glong *pos);

void ObitCArrayNeg (ObitCArray* in);
typedef void (*ObitCArrayNegFP) (ObitCArray* in);

void ObitCArrayConjg (ObitCArray* in);
typedef void (*ObitCArrayConjgFP) (ObitCArray* in);

void ObitCArrayFill (ObitCArray* in, gfloat cmpx[2]);
typedef void (*ObitCArrayFillFP) (ObitCArray* in, gfloat cmpx[2]);

void ObitCArraySAdd (ObitCArray* in, gfloat scalar);
typedef void (*ObitCArraySAddFP) (ObitCArray* in, gfloat scalar);

void ObitCArraySMul (ObitCArray* in, gfloat scalar);
typedef void (*ObitCArraySMulFP) (ObitCArray* in, gfloat scalar);

void ObitCArrayCSAdd (ObitCArray* in, gfloat scalar[2]);
typedef void (*ObitCArrayCSAddFP) (ObitCArray* in, gfloat scalar[2]);

void ObitCArrayCSMul (ObitCArray* in, gfloat scalar[2]);
typedef void (*ObitCArrayCSMulFP) (ObitCArray* in, gfloat scalar[2]);

void ObitCArrayAdd (ObitCArray* in1, ObitCArray* in2, ObitCArray* out);
typedef void (*ObitCArrayAddFP) (ObitCArray* in1, ObitCArray* in2, 
                                  ObitCArray* out);

void ObitCArraySub (ObitCArray* in1, ObitCArray* in2, ObitCArray* out);
typedef void (*ObitCArraySubFP) (ObitCArray* in1, ObitCArray* in2, 
                                  ObitCArray* out);

void ObitCArrayMul (ObitCArray* in1, ObitCArray* in2, ObitCArray* out);
typedef void (*ObitCArrayMulFP) (ObitCArray* in1, ObitCArray* in2, 
                                  ObitCArray* out);

void ObitCArrayDiv (ObitCArray* in1, ObitCArray* in2, ObitCArray* out);
typedef void (*ObitCArrayDivFP) (ObitCArray* in1, ObitCArray* in2, 
                                  ObitCArray* out);

/* CArray - FArray functions */

ObitFArray* ObitCArrayMakeF  (ObitCArray *Cin);
typedef ObitFArray* (*ObitCArrayMakeFFP) (ObitCArray *Cin);

ObitCArray* ObitCArrayMakeC  (ObitFArray *Fin);
typedef ObitCArray* (*ObitCArrayMakeCFP) (ObitFArray *Fin);

gboolean ObitCArrayIsFCompatable  (ObitCArray *Cin, ObitFArray *Fin);
typedef gboolean (*ObitCArrayIsFCompatableFP) (ObitCArray *Cin, ObitFArray *Fin);

void ObitCArrayFMul (ObitCArray* Cin, ObitFArray* Fin, ObitCArray* out);
typedef void (*ObitCArrayFMulFP) (ObitCArray* Cin, ObitFArray* Fin, 
                                  ObitCArray* out);

void ObitCArrayFDiv (ObitCArray* Cin, ObitFArray* Fin, ObitCArray* out);
typedef void (*ObitCArrayFDivFP) (ObitCArray* Cin, ObitFArray* Fin, 
                                  ObitCArray* out);

void ObitCArrayFRot (ObitCArray* Cin, ObitFArray* Fin, ObitCArray* out);
typedef void (*ObitCArrayFRotFP) (ObitCArray* Cin, ObitFArray* Fin, 
                                  ObitCArray* out);

void ObitCArrayFAdd (ObitCArray* Cin, ObitFArray* Fin, ObitCArray* out);
typedef void (*ObitCArrayFAddFP) (ObitCArray* Cin, ObitFArray* Fin, 
                                  ObitCArray* out);

void ObitCArrayComplex (ObitFArray* Fin1, ObitFArray* Fin2, ObitCArray* out);
typedef void (*ObitCArrayComplexFP) (ObitFArray* Fin1, ObitFArray* Fin2, 
                                      ObitCArray* out);

void ObitCArrayReal (ObitCArray* in, ObitFArray* out);
typedef void (*ObitCArrayRealFP) (ObitCArray* in, ObitCArray* out);

void ObitCArrayImag (ObitCArray* in, ObitFArray* out);
typedef void (*ObitCArrayImagFP) (ObitCArray* in, ObitCArray* out);

void ObitCArrayAmp (ObitCArray* in, ObitFArray* out);
typedef void (*ObitCArrayAmpFP) (ObitCArray* in, ObitCArray* out);

void ObitCArrayPhase (ObitCArray* in, ObitFArray* out);
typedef void (*ObitCArrayPhaseFP) (ObitCArray* in, ObitCArray* out);

void ObitCArray2DCenter (ObitCArray* in);
typedef void (*ObitCArray2DCenterFP) (ObitCArray* in);


ObitCArray* ObitCArrayAddConjg (ObitCArray* in, glong numConjCol);
typedef ObitCArray* (*ObitCArrayAddConjgFP) (ObitCArray* in, 
                                             glong numConjCol);


/*----------- ClassInfo Structure -----------------------------------*/
typedef struct  {
#include "ObitCArrayClassDef.h"
} ObitCArrayClassInfo; 

#endif /* OBITCARRAY_H */ 

---