// aps.h
//
// Author: J.A. de Jong - ASCEE
//
// Description:
//
//////////////////////////////////////////////////////////////////////
#pragma once
#ifndef APS_H
#define APS_H
#include "types.h"
#include "ascee_math.h"
#include "window.h"

typedef struct AvPowerSpectra_s AvPowerSpectra;

/** 
 * Allocates a AvPowerSpectra object which is used to compute an
 * averaged power spectra from given input time samples.
 *
 * @param[in] nfft Size of the fft,
 *
 * @param[in] nchannels Number of channels of time data to allocate
 * for.
 *
 * @param[in] overlap_percentage. Should be 0<= overlap_pct < 100. The
 * overlap percentage will be coerced, as the offset will be an
 * integer number of samples at all cases. Therefore, the real overlap
 * percentage can be obtained later on
 *
 * @param wt 
 *
 * @return 
 */
AvPowerSpectra* AvPowerSpectra_alloc(const us nfft,
                                     const us nchannels,
                                     const d overlap_percentage,
                                     const WindowType wt);
                                 

/** 
 * Computes the real overlap offset 
 *
 * @param aps 
 */
d AvPowerSpectra_realoverlappct(const AvPowerSpectra* aps);

/** 
 * Return the current number of averages taken to obtain the result.
 *
 * @return The number of averages taken.
 */
us AvPowerSpectra_getAverages(const AvPowerSpectra*);

/** 
 * Add time data to this Averaged Power Spectra. Remembers the part
 * that should be overlapped with the next time data.
 *
 * @param aps AvPowerSpectra handle 
 *
 * @param timedata Pointer to timedata buffer. Number of rows SHOULD
 * *at least* be nfft. Number of columns should exactly be nchannels.
 *
 * @return pointer to the averaged power spectra buffer that is being
 * written to. Pointer is valid until AvPowerSpectra_free() is called.
 */
cmat* AvPowerSpectra_addTimeData(AvPowerSpectra* aps,
                                 const dmat* timedata);

/** 
 * Free storage of the AvPowerSpectra
 */
void AvPowerSpectra_free(AvPowerSpectra*);


#endif // APS_H
//////////////////////////////////////////////////////////////////////