ObitFInterpolate.c File Reference

ObitFInterpolate class function definitions. More...

#include "ObitFInterpolate.h"
#include "ObitPosition.h"

Functions
void	ObitFInterpolateInit (gpointer in)
	Private: Initialize newly instantiated object.
void	ObitFInterpolateClear (gpointer in)
	Private: Deallocate members.
ObitFInterpolate *	newObitFInterpolate (gchar *name)
	Public: Constructor.
ObitFInterpolate *	newObitFInterpolateCreate (gchar *name, ObitFArray *array, ObitImageDesc *desc, glong hwidth)
	Public: Constructor from value.
gconstpointer	ObitFInterpolateGetClass (void)
	Public: ClassInfo pointer.
ObitFInterpolate *	ObitFInterpolateCopy (ObitFInterpolate *in, ObitFInterpolate *out, ObitErr *err)
	Public: Copy (deep) constructor.
ObitFInterpolate *	ObitFInterpolateClone (ObitFInterpolate *in, ObitFInterpolate *out)
	Public: Copy (shallow) constructor.
void	ObitFInterpolateReplace (ObitFInterpolate *in, ObitFArray *newArray)
	Public: Replace member ObitFArray.
gfloat	ObitFInterpolatePixel (ObitFInterpolate *in, gfloat *pixel, ObitErr *err)
	Public: Interpolate Pixel in 2D array.
gfloat	ObitFInterpolate1D (ObitFInterpolate *in, gfloat pixel)
	Public: Interpolate value in 1- array.
gfloat	ObitFInterpolatePosition (ObitFInterpolate *in, gdouble *coord, ObitErr *err)
	Public: Interpolate Position in 2D array.
gfloat	ObitFInterpolateOffset (ObitFInterpolate *in, gdouble *off, ObitErr *err)
	Public: Interpolate Offset in 2D array.
void	ObitFInterpolateClassInit (void)
	Public: Class initializer.

---

Detailed Description

ObitFInterpolate class function definitions.

This class is derived from the Obit base class. This class supports 1 and 2-D interpolation in ObitFArrays using Lagrange interpolation.

---

Function Documentation

ObitFInterpolate* newObitFInterpolate (  gchar *  name  )

Public: Constructor. Initializes class if needed on first call. Parameters: name  An optional name for the object. Returns: the new object.

ObitFInterpolate* newObitFInterpolateCreate (  gchar *  name, ObitFArray *  array, ObitImageDesc *  desc, glong  hwidth )

Public: Constructor from value. Initializes class if needed on first call. Parameters: name  An optional name for the object. array  The ObitFarray to be interpolated. desc  if nonNULL, an image descriptor to be attached to the output. hwidth  Half width of interpolation kernal (range [1,4] allowed). Returns: the new object.

gfloat ObitFInterpolate1D (  ObitFInterpolate *  in, gfloat  pixel )

Public: Interpolate value in 1- array. Parameters: in  The object to interpolate pixel  Pixel location (1-rel) in array Returns: value, blanked if invalid

void ObitFInterpolateClassInit (  void   )

Public: Class initializer.

void ObitFInterpolateClear (  gpointer  inn  )

Private: Deallocate members. Does (recursive) deallocation of parent class members. For some reason this wasn't build into the GType class. Parameters: in  Pointer to the object to deallocate. Actually it should be an ObitFInterpolate* cast to an Obit*.

ObitFInterpolate* ObitFInterpolateClone (  ObitFInterpolate *  in, ObitFInterpolate *  out )

Public: Copy (shallow) constructor. The result will have pointers to the more complex members. Parent class members are included but any derived class info is ignored. Parameters: in  The object to copy out  An existing object pointer for output or NULL if none exists. Returns: pointer to the new object.

ObitFInterpolate* ObitFInterpolateCopy (  ObitFInterpolate *  in, ObitFInterpolate *  out, ObitErr *  err )

Public: Copy (deep) constructor. Copies are made of complex members including disk files; these will be copied applying whatever selection is associated with the input. Parent class members are included but any derived class info is ignored. Parameters: in  The object to copy out  An existing object pointer for output or NULL if none exists. err  Error stack, returns if not empty. Returns: pointer to the new object.

gconstpointer ObitFInterpolateGetClass (  void   )

Public: ClassInfo pointer. Returns: pointer to the class structure.

void ObitFInterpolateInit (  gpointer  inn  )

Private: Initialize newly instantiated object. Parent classes portions are (recursively) initialized first Parameters: in  Pointer to the object to initialize.

gfloat ObitFInterpolateOffset (  ObitFInterpolate *  in, gdouble *  off, ObitErr *  err )

Public: Interpolate Offset in 2D array. The object must have an image descriptor to allow determing pixel coordinates. Interpolation between planes is not supported. Parameters: in  The object to interpolate off  Coordinate offset in plane err  Error stack is pixel not inside image. Returns: value, blanked if invalid

gfloat ObitFInterpolatePixel (  ObitFInterpolate *  in, gfloat *  pixel, ObitErr *  err )

Public: Interpolate Pixel in 2D array. Interpolation between planes is not supported. Parameters: in  The object to interpolate pixel  Pixel location (1-rel) in planes and which plane. Should have number of dimensions equal to in. err  Error stack if pixel not inside image. Returns: value, magic blanked if invalid

gfloat ObitFInterpolatePosition (  ObitFInterpolate *  in, gdouble *  coord, ObitErr *  err )

Public: Interpolate Position in 2D array. The object must have an image descriptor to allow determing pixel coordinates. Interpolation between planes is not supported. Parameters: in  The object to interpolate coord  Coordinate value in plane and which plane. Should have number of dimensions equal to in. err  Error stack is pixel not inside image. Returns: value, blanked if invalid

void ObitFInterpolateReplace (  ObitFInterpolate *  in, ObitFArray *  newArray )

Public: Replace member ObitFArray. Parameters: in  The object to update newArray  The new FArray for in

---