blockmean

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

pygmt.blockmean(data=None, x=None, y=None, z=None, outfile=None,
\*, spacing=None, region=None, summary=None, verbose=None,
aspatial=None, binary=None, nodata=None, find=None, coltypes=None,
header=None, incols=None, outcols=None, registration=None,
wrap=None, \**kwargs)

Utilité :

Moyenne les données (x, y, z) d’un tableau en blocs en utilisant une estimation moyenne.

Lit des triplets (x, y, z) [ou éventuellement des quadruplets pondérés (x, y, z, w)] avec des emplacements arbitraires et écrit en sortie une position moyenne et une valeur pour chaque bloc non vide dans une région de la grille définie par les paramètres region et spacing.

Prend en entrée une matrice, des triplets (x, y, z) ou un nom de fichier.

Vous devez fournir soit des données, soit x, y et z.

Paramètres :

data (str or numpy.ndarray or pandas.DataFrame or xarray.Dataset or geopandas.GeoDataFrame) - Fournit les valeurs (x, y, z) ou (longitude, latitude, élévation) en passant un nom de fichier d’un tableau de données ASCII, un tableau numpy.ndarray 2D, un pandas.DataFrame, un xarray.Dataset composé de variables de données xarray.DataArray 1D, ou un geopandas.GeoDataFrame contenant les données tabulaires.

x/y/z (tableaux 1D) - Tableaux des coordonnées x et y et des valeurs z des points de données.

spacing (str) - x_inc[+e|n][/y_inc[+e|n]]. x_inc [et éventuellement y_inc] est l’espacement de la grille.

Coordonnées géographiques (degrés) : Optionnellement, ajoutez une unité d’incrément. Choisissez parmi m pour indiquer des minutes d’arc ou s pour indiquer des secondes d’arc. Si l’une des unités e, f, k, M, n ou u est ajoutée, l’incrément est supposé être donné en mètre, pied, kilomètre, mile, mille nautique ou pied d’enquête américain, respectivement, et sera converti en degrés de longitude équivalents à la latitude moyenne de la région (la conversion dépend de PROJ_ELLIPSOID). Si y_inc est donné mais défini à 0, il sera réinitialisé à la même valeur que x_inc ; sinon, il sera converti en degrés de latitude.

Toutes les coordonnées : Si +e est ajouté, alors la valeur maximale correspondante de x (est) ou y (nord) peut être légèrement ajustée pour correspondre exactement à l’incrément donné [par défaut, l’incrément peut être légèrement ajusté pour s’adapter au domaine donné]. Enfin, au lieu de donner un incrément, vous pouvez spécifier le nombre de nœuds souhaité en ajoutant +n à l’argument entier fourni ; l’incrément est alors recalculé à partir du nombre de nœuds, de l’enregistrement et du domaine. La valeur d’incrément résultante dépend de la grille enregistrée sur les lignes de grille ou enregistrée sur les pixels ; voir GMT File Formats pour plus de détails.

Remarque : Si region=grdfile est utilisé, alors l’espacement de la grille et l’enregistrement ont déjà été initialisés ; utilisez spacing et registration pour remplacer ces valeurs.

summary (str) - [m|n|s|w]. Type de valeurs de résumé calculées par blockmean.

m - rapporte la valeur moyenne [Par défaut]

n - rapporte le nombre de points d’entrée à l’intérieur de chaque bloc

s - rapporte la somme de toutes les valeurs z à l’intérieur d’un bloc

w - rapporte la somme des poids

region (str ou list) - xmin/xmax/ymin/ymax[+r][+uunit]. Spécifie la région d’intérêt.

outfile (str) - Le nom du fichier pour le fichier de sortie ASCII.

verbose (bool ou str) - Sélectionne le niveau de verbosité [Par défaut w], qui module les messages écrits dans stderr. Choisissez parmi 7 niveaux de verbosité :

q - Silencieux, aucun message d’erreur fatal n’est produit.

e - Messages d’erreur uniquement.

w - Avertissements [Par défaut].

t - Chronométrage (rapporte les temps d’exécution pour les algorithmes intensifs en temps).

i - Messages d’information (identique à verbose=True).

c - Avertissements de compatibilité.

d - Messages de débogage.

aspatial (bool ou str) - [col=]name[,…]. Contrôle la façon dont les données aspatiales sont traitées lors de l’entrée et de la sortie. La documentation complète se trouve à l’adresse https://docs.generic-mapping-tools.org/latest/gmt.html#aspatial-full.

binary (bool ou str) -

i|o[ncols][type][w][+l|b]. Sélectionnez une entrée binaire native (en utilisant binary= »i ») ou une sortie binaire (en utilisant binary= »o »), où ncols est le nombre de colonnes de données de type, qui doit être l’un des suivants :

c - int8_t (char signé d’1 octet)

u - uint8_t (unsigned char d’1 octet)

h - int16_t (entier signé sur 2 octets)

H - uint16_t (entier non signé sur 2 octets)

i - int32_t (entier signé sur 4 octets)

I - uint32_t (entier non signé sur 4 octets)

l - int64_t (entier signé sur 8 octets)

L - uint64_t (entier non signé sur 8 octets)

f - flottant sur 4 octets (précision simple)

d - flottant sur 8 octets (double précision)

x - utiliser pour sauter ncols n’importe où dans l’enregistrement

Pour les enregistrements avec des types mixtes, ajoutez des combinaisons supplémentaires séparées par des virgules de ncols type (sans espace). Les modificateurs suivants sont pris en charge :

w après n’importe quel élément pour forcer l’inversion des octets.

+l|b pour indiquer que l’ensemble du fichier de données doit être lu en tant que petit ou grand boutiste, respectivement.

La documentation complète se trouve à l’adresse https://docs.generic-mapping-tools.org/latest/gmt.html#bi-full.

nodata (str) - i|onodata. Remplacez des valeurs spécifiques par NaN (pour les données tabulaires). Par exemple, nodata= »-9999 » remplacera toutes les valeurs égales à -9999 par NaN lors de l’entrée et toutes les valeurs NaN par -9999 lors de la sortie. Préfixez i à la valeur nodata pour les colonnes d’entrée uniquement. Préfixez o à la valeur nodata pour les colonnes de sortie uniquement.

find (str) - [~]“pattern” | [~]/regexp/[i]. Ne transmettez que les enregistrements correspondant au motif ou aux expressions régulières donnés [Par défaut, tous les enregistrements sont traités]. Préfixez ~ au motif ou à l’expression régulière pour ne passer que les expressions de données qui ne correspondent pas au motif. Ajoutez i pour une correspondance insensible à la casse. Cela ne s’applique pas aux en-têtes ou aux en-têtes de segment.

incols (str ou tableau 1-D) -

Spécifiez les colonnes de données pour l’entrée principale dans un ordre arbitraire. Les colonnes peuvent être répétées et les colonnes non répertoriées seront ignorées [Par défaut, toutes les colonnes sont lues dans l’ordre, en commençant par la première (c’est-à-dire la colonne 0)].

Pour un tableau 1-D : spécifiez les colonnes individuelles dans l’ordre d’entrée (par exemple, incols=[1,0] pour la 2e colonne suivie de la 1 ère colonne).

Pour une chaîne de caractères : spécifiez les colonnes individuelles ou les plages de colonnes au format début[:inc]:fin, où inc est par défaut à 1 s’il n’est pas spécifié, avec des colonnes et/ou des plages de colonnes séparées par des virgules (par exemple, incols= »0:2,4+l » pour entrer les trois premières colonnes suivies de la colonne 5e avec une transformation logarithmique). Pour lire à partir d’une colonne donnée jusqu’à la fin de l’enregistrement, omettez la fin lors de la spécification de la plage de colonnes. Pour lire le texte final, ajoutez la colonne t. Ajoutez le numéro de mot à t pour n’ingérer qu’un seul mot du texte final. Au lieu de spécifier des colonnes, utilisez incols= »n » pour simplement lire une entrée numérique et ignorer le texte final. Facultativement, ajoutez l’un des modificateurs suivants à n’importe quelle colonne ou plage de colonnes pour transformer les colonnes d’entrée :

+l pour prendre le logarithme en base 10 des valeurs d’entrée.

+d pour diviser les valeurs d’entrée par le diviseur [Par défaut, 1].

+s pour multiplier les valeurs d’entrée par l’échelle [Par défaut, 1].

+o pour ajouter le décalage donné aux valeurs d’entrée [Par défaut, 0].

coltypes (str) - [i|o]colinfo. Spécifiez les types de données des colonnes d’entrée et/ou de sortie (données temporelles ou géographiques). La documentation complète se trouve à l’adresse https://docs.generic-mapping-tools.org/latest/gmt.html#f-full.

header (str) -

[i|o][n][+c][+d][+msegheader][+rremark][+ttitle]. Spécifiez que le fichier d’entrée et/ou de sortie a n enregistrements d’en-tête [Par défaut, 0]. Préfixez i si seule l’entrée principale doit avoir des enregistrements d’en-tête. Préfixez o pour contrôler l’écriture des enregistrements d’en-tête, avec les modificateurs suivants pris en charge :

+d pour supprimer les enregistrements d’en-tête existants.

+c pour ajouter un commentaire d’en-tête avec les noms des colonnes à la sortie [Par défaut, pas de noms de colonnes].

+m pour ajouter un en-tête de segment segheader à la sortie après le bloc d’en-tête [Par défaut, pas d’en-tête de segment].

+r pour ajouter un commentaire de remarque à la sortie [Par défaut, pas de commentaire]. La chaîne de remarque peut contenir n pour indiquer les sauts de ligne.

+t pour ajouter un commentaire de titre à la sortie [Par défaut, pas de titre]. La chaîne de titre peut contenir n pour indiquer les sauts de ligne.

Les lignes vides et les lignes commençant par # sont toujours ignorées.

outcols (str ou tableau 1-D) -

cols[,…][,t[mot]]. Spécifie z les colonnes de données pour la sortie principale dans un ordre arbitraire. Les colonnes peuvent être répétées et les colonnes non répertoriées seront ignorées [Par défaut, toutes les colonnes sont écrites dans l’ordre, en commençant par la première (c’est-à-dire la colonne 0)].

Pour un tableau 1-D : spécifiez les colonnes individuelles dans l’ordre de sortie (par exemple, outcols=[1,0] pour la 2e colonne suivie de la 1ère colonne).

Pour une chaîne de caractères : spécifiez les colonnes individuelles ou les plages de colonnes au format début[:inc]:fin, où inc est par défaut à 1 s’il n’est pas spécifié, avec des colonnes et/ou des plages de colonnes séparées par des virgules (par exemple, outcols= »0:2,4 » pour écrire les trois premières colonnes suivies de la 5e colonne). Pour écrire à partir d’une colonne donnée jusqu’à la fin de l’enregistrement, omettez la fin lors de la spécification de la plage de colonnes. Pour écrire le texte final, ajoutez la colonne t. Ajoutez le numéro de mot à t pour n’écrire qu’un seul mot du texte final. Notez que si incols est également utilisé, les colonnes spécifiées dans outcols correspondent à l’ordre après la sélection de incols.

registration* (str) - g|p. Force l’enregistrement des nœuds de grille (g) ou des pixels (p) [Par défaut, g (enregistrement des lignes de grille)].

wrap (str) -

y|a|w|d|h|m|s|cperiod[/phase][+ccol]. Convertissez la coordonnée x d’entrée en une coordonnée cyclique ou une colonne différente si sélectionnée via +ccol. Les transformations de coordonnées cycliques suivantes sont prises en charge :

y - cycle annuel (normalisé)

a - cycle annuel (mensuel)

w - cycle hebdomadaire (jour)

d - cycle journalier (heure)

h - cycle horaire (minute)

m - cycle minuterie (seconde)

s - cycle des secondes (seconde)

c - cycle personnalisé (normalisé)