diff --git a/MyLibs/Inc/filters.h b/MyLibs/Inc/filters.h index bbbf3c9..d72854d 100644 --- a/MyLibs/Inc/filters.h +++ b/MyLibs/Inc/filters.h @@ -273,22 +273,52 @@ int FilterLUT_Init(FilterLUT_t* filter, float* input_arr, float* output_arr, uin float FilterLUT_Process(FilterLUT_t* filter, float input); -// Расчет всякого +/** + * @brief Расчет коэфициента альфа + * @param tau Постоянная времени (время нарастания до 63% от уровня сигнала) + * @param TsUs Период вызова фильтра в микросекундах + * @return Коэфициент альфа + */ #define FilterExp_CalcAlpha(tau, TsUs) (((float)TsUs/1000000) / (((float)TsUs/1000000) + (tau))) -/* Расчет alpha для времени нарастания до 63% */ +/** + * @brief Расчет alpha для времени нарастания до 63% + * @param rise_time Требуемое время нарастания до 63% + * @param TsUs Период вызова фильтра в микросекундах + * @return Коэфициент альфа + */ #define FilterExp_CalcAlpha63(rise_time, TsUs) FilterExp_CalcAlpha((rise_time) / 1.0f, TsUs) -/* Расчет alpha для времени нарастания до 86% */ +/** + * @brief Расчет alpha для времени нарастания до 86% + * @param rise_time Требуемое время нарастания до 86% + * @param TsUs Период вызова фильтра в микросекундах + * @return Коэфициент альфа + */ #define FilterExp_CalcAlpha86(rise_time, TsUs) FilterExp_CalcAlpha((rise_time) / 2.0f, TsUs) -/* Расчет alpha для времени нарастания до 95% */ +/** + * @brief Расчет alpha для времени нарастания до 95% + * @param rise_time Требуемое время нарастания до 95% + * @param TsUs Период вызова фильтра в микросекундах + * @return Коэфициент альфа + */ #define FilterExp_CalcAlpha95(rise_time, TsUs) FilterExp_CalcAlpha((rise_time) / 3.0f, TsUs) -/* Расчет alpha для времени нарастания до 98% */ +/** + * @brief Расчет alpha для времени нарастания до 98% + * @param rise_time Требуемое время нарастания до 98% + * @param TsUs Период вызова фильтра в микросекундах + * @return Коэфициент альфа + */ #define FilterExp_CalcAlpha98(rise_time, TsUs) FilterExp_CalcAlpha((rise_time) / 4.0f, TsUs) -/* Расчет alpha для времени нарастания до 99% */ +/** + * @brief Расчет alpha для времени нарастания до 99% + * @param rise_time Требуемое время нарастания до 99% + * @param TsUs Период вызова фильтра в микросекундах + * @return Коэфициент альфа + */ #define FilterExp_CalcAlpha99(rise_time, TsUs) FilterExp_CalcAlpha((rise_time) / 5.0f, TsUs) // ==================== INT32_T ВЕРСИИ ====================