ObitTimeFilter.c File Reference

ObitTimeFilter class function definitions. More...

#include <math.h>
#include "ObitTimeFilter.h"

Functions
void	ObitTimeFilterInit (gpointer in)
	Private: Initialize newly instantiated object.
void	ObitTimeFilterClear (gpointer in)
	Private: Deallocate members.
ObitTimeFilter *	newObitTimeFilter (gchar *name, gint nTime, gint nSeries)
	Public: Constructor.
gconstpointer	ObitTimeFilterGetClass (void)
	Public: ClassInfo pointer.
void	ObitTimeFilterResize (ObitTimeFilter *in, gint nTime)
	Public: Resize arrays.
void	ObitTimeFilter2Freq (ObitTimeFilter *in)
	Public: Compute frequency series.
void	ObitTimeFilter2Time (ObitTimeFilter *in)
	Public: Compute Time series.
void	ObitTimeFilterFilter (ObitTimeFilter *in, gint seriesNo, ObitTimeFilterType type, gfloat *parms, ObitErr *err)
	Public: Apply Filter to Frequency series.
void	ObitTimeFilterClassInit (void)
	Public: Class initializer.

---

Detailed Description

ObitTimeFilter class function definitions.

This class is derived from the Obit base class.

---

Function Documentation

ObitTimeFilter* newObitTimeFilter (  gchar *  name, gint  nTime, gint  nSeries )

Public: Constructor. Initializes class if needed on first call. Parameters: name  An optional name for the object. nTime  Number of times in arrays to be filtered It is best to add some extra padding (10%) to allow a smooth transition from the end of the sequence back to the beginning. Remember the FFT algorithm assumes the function is periodic. nSeries  Number of time sequences to be filtered Returns: the new object.

void ObitTimeFilter2Freq (  ObitTimeFilter *  in  )

Public: Compute frequency series. A linear interpolation between the last valid point and the first valid point is made to reduce the wraparound edge effects. Parameters: in  Object with TimeFilter structures.

void ObitTimeFilter2Time (  ObitTimeFilter *  in  )

Public: Compute Time series. Parameters: in  Object with TimeFilter structures.

void ObitTimeFilterClassInit (  void   )

Public: Class initializer.

void ObitTimeFilterClear (  gpointer  inn  )

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

void ObitTimeFilterFilter (  ObitTimeFilter *  in, gint  seriesNo, ObitTimeFilterType  type, gfloat *  parms, ObitErr *  err )

Public: Apply Filter to Frequency series. Following Filters are supported: OBIT_TimeFilter_LowPass - Zeroes frequencies above a fraction, parms[0], of the highest. OBIT_TimeFilter_HighPass - Zeroes frequencies below a fraction, parms[0], of the highest. Parameters: in  Object with TimeFilter structures. seriesNo  Which time/frequency series to apply to (0-rel), <0 => all type  Filter type to apply *parm  Parameters for filter, meaning depends on type. err  Error stack

gconstpointer ObitTimeFilterGetClass (  void   )

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

void ObitTimeFilterInit (  gpointer  inn  )

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

void ObitTimeFilterResize (  ObitTimeFilter *  in, gint  nTime )

Public: Resize arrays. Parameters: in  ObitTimeFilter to resize. nTime  Number of times in arrays to be filtered It is best to add some extra padding (10%) to allow a smooth transition from the end of the sequence back to the beginning. Remember the FFT algorithm assumes the function is periodic.

---