.. pygmt:

filter1d
========

Ici vous aurez des explications sur la commande et ses différents paramètres.

.. code-block:: python 
		
	pygmt.filter1d(data, output_type='pandas', outfile=None,*, end=None,
	filter_type=None, time_col=None, \**kwargs)
	
Utilité :
---------

Filtrage dans le domaine temporel des tableaux de données à une dimension.

Un filtre général dans le domaine temporel pour des données de séries temporelles à plusieurs colonnes. L'utilisateur spécifie quelle colonne représente le temps (c'est-à-dire la variable indépendante) via time_col. L'opération la plus rapide se produit lorsque les séries temporelles d'entrée sont régulièrement espacées et ne présentent aucun trou ou valeur aberrante, et que les options spéciales ne sont pas nécessaires. Lit une table et renvoie un numpy.ndarray, un pandas.DataFrame ou un fichier ASCII.

Paramètres :
------------

**filter_type** (str) –

typewidth[+h]. Définit le type de filtre. Choisissez parmi les filtres de convolution et les filtres non-convolutifs. Ajoutez le code du filtre suivi de la largeur complète du filtre dans les mêmes unités que la colonne de temps. Par défaut, cela effectue un filtrage passe-bas ; ajoutez +h pour sélectionner un filtrage passe-haut. Certains filtres permettent des arguments facultatifs et un modificateur.

        Les types de filtres de convolution disponibles sont :

            (b) Rectangulaire : tous les poids sont égaux.

            (c) Cosinus Arch : les poids suivent une courbe de cosinus arch.

            (g) Gaussien : les poids sont donnés par la fonction gaussienne.

            (f) Personnalisé : au lieu de la largeur, donnez le nom d'un fichier à une colonne avec vos propres coefficients de poids.

        Les types de filtres non-convolutifs sont :

            (m) Médiane : renvoie la valeur médiane.

            (p) Probabilité du maximum de vraisemblance (estimation de mode) : renvoie la valeur modale. Si plusieurs modes sont trouvés, nous renvoyons leur valeur moyenne. Ajoutez +l ou +u si vous préférez renvoyer la valeur la plus basse ou la plus élevée des valeurs modales.

            (l) Inférieur : renvoie le minimum de toutes les valeurs.

            (L) Inférieur : renvoie le minimum des valeurs positives uniquement.

            (u) Supérieur : renvoie le maximum de toutes les valeurs.

            (U) Supérieur : renvoie le maximum des valeurs négatives uniquement.

Les types de filtres en majuscules B, C, G, M, P, F utiliseront des versions de filtres robustes : c'est-à-dire qu'ils remplacent les valeurs aberrantes (2,5 fois l'écart à l'échelle L1 par rapport à la médiane, en utilisant la déviation absolue médiane [MAD] multipliée par 1,4826) par la médiane lors du filtrage.

Dans le cas de L|U, il est possible qu'aucune donnée ne passe le test de signe initial ; dans ce cas, le filtre renverra 0.0. À l'exception des coefficients personnalisés (f), les autres filtres peuvent accepter des largeurs de filtre variables en passant la largeur sous forme d'un fichier de série temporelle à deux colonnes avec les largeurs de filtre dans la deuxième colonne. Le fichier de largeur de filtre n'a pas besoin d'être enregistré avec les données, car nous obtenons la largeur de filtre requise à chaque emplacement de sortie par interpolation. Pour les fichiers de données à segments multiples, le fichier de filtre doit avoir le même nombre de segments ou un seul segment à utiliser pour tous les segments de données.

**end** (bool) – Inclure les extrémités de la série temporelle dans la sortie. Par défaut [False], on perd la moitié de la largeur du filtre de données à chaque extrémité.

**time_col** (int) – Indique quelle colonne contient la variable indépendante (temps). La colonne la plus à gauche est 0, tandis que la plus à droite est (n_cols - 1) [Par défaut : 0].

**output_type** (str) –

Détermine le format dans lequel les données xyz seront renvoyées [Par défaut : pandas] :

	numpy - numpy.ndarray
	
	pandas- pandas.DataFrame
	
	file - fichier ASCII (nécessite un nom de fichier de sortie)

**outfile** (str) – Le nom de fichier pour le fichier ASCII de sortie.