Io Filter

Data Structures
struct	IoFilter
	IoFilter Structure. More...

Typedefs
typedef signed char	byte_t
	Define byte_t to be a signed char.

Functions
void	Io_filter_free (IoFilter *filter)
	Free an IoFilter Structure.
IoFilter *	Io_filter_init (size_t ntimes, size_t nwavelens, time_t *times, float *wavelens, float **Ios, float **Ios_std, size_t mask_nwaves, float *mask_waves, time_t Io_time, time_t window_width, IoFilter *filter)
	Initialize an IoFilter Structure.
float *	Io_filter_run (IoFilter *filter)
	Run the Io filtering algorithm.

---

Detailed Description

---

Function Documentation

void Io_filter_free

(

IoFilter *

filter

)

Free an IoFilter Structure.

Parameters:

filter

- pointer to the IoFilter structure.

Definition at line 589 of file Io_filter.c.

IoFilter* Io_filter_init	(	size_t	ntimes,
		size_t	nwavelens,
		time_t *	times,
		float *	wavelens,
		float **	Ios,
		float **	Ios_std,
		size_t	mask_nwaves,
		float *	mask_waves,
		time_t	Io_time,
		time_t	window_width,
		IoFilter *	filter
	)

Initialize an IoFilter Structure.

The memory used by the returned structure is dynamically allocated and must be freed using the Io_filter_free() function.

This structure is designed so it can be reused without the need to reallocate memory unless needed. To reuse an IoFilter structure simply pass it back into the Io_filter_init() function.

The in_times, in_Ios, wavelens, and mask_waves arrays are used as-is and are not copied, freed, or altered in any way.

Parameters:

ntimes	- the number of times
nwavelens	- the number of wavelengths
times	- pointer to the array of times
wavelens	- pointer to the array of wavelengths
Ios	- pointer to the array of input Io values
Ios_std	- pointer to the array of Io standard deviations
mask_nwaves	- number of wavelengths in the mask_waves array
mask_waves	- wavelengths used to create the Io mask
Io_time	- the time to compute the Io values for
window_width	- width of the smoothing window (days)
filter	- pointer to the IoFilter structure, or NULL to create a new IoFilter structure.

Returns:

:

• pointer to the IoFilter structure
• NULL if a memory allocation error occurred

Definition at line 648 of file Io_filter.c.

float* Io_filter_run

(

IoFilter *

filter

)

Run the Io filtering algorithm.

Parameters:

filter

- pointer to the IoFilter

Return values:

Ios	array of smoothed Io values for each wavelength

Definition at line 797 of file Io_filter.c.