weisang.com > Documents Articles > TimePeriods (FPScript)

Documentation FlexPro

TimePeriods (FPScript)

21.09.2021

Recherche des segments de temps périodiques dans un ensemble de données avec des valeurs de temps calendaire.

Syntaxe

TimePeriods(DataSet, Criterion, LowerBound, UpperBound [ , Operation = EVENT_DEFAULT ])

La syntaxe de la fonction TimePeriods se compose des éléments suivants :

Section

Description

DataSet

L'ensemble de données avec les valeurs de temps calendaire dans lequel on recherche des périodes.

Les structures de données autorisées sont Séries de données, Matrice de données, Signal, Série de signaux et Série de signaux avec composante X bidimensionnelle. Tous les types de données réels sont autorisés.

Si l'argument est une liste, alors la fonction est exécutée pour chaque élément de la liste et le résultat est également une liste.

Criterion

Précise sur quel élément de date la recherche doit être basée.

L'argument Criterion peut avoir les valeurs suivantes :

Constante	Signification
SECOND	Seconde dans la minute (0,0 à 59,9999)
MINUTE	Minute dans l'heure 0,0 à 59,9999)
HOUR	Heure de la journée (0,0 à 23,9999)
DAY	Jour du mois (1 à 31)
WEEKDAY	Jour de la semaine (0 pour le dimanche à 6 pour le samedi, au lieu de valeurs numériques, vous pouvez également utiliser les constantes SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY et SATURDAY ).
MONTH	Mois de l'année (1 à 12)
YEAR	Année (1970 à 3000)
DAYOFYEAR	Jour de l'année (1 à 366)

Si l'argument est une liste, alors son premier élément est pris. S'il s'agit à nouveau d'une liste, le processus est répété.

LowerBound

Spécifie la limite inférieure du segment temporel. Si vous spécifiez une valeur avec une unité, cette unité doit correspondre à l'élément de date sélectionné.

Les structures de données autorisées sont Scalaire. Tous les types de données réels sont autorisés.

Si l'argument est une liste, alors la fonction est exécutée pour chaque élément de la liste et le résultat est également une liste.

UpperBound

Spécifie la limite supérieure du segment temporel. Si vous spécifiez une valeur avec une unité, cette unité doit correspondre à l'élément de date sélectionné.

Les structures de données autorisées sont Scalaire. Tous les types de données réels sont autorisés.

Si l'argument est une liste, alors la fonction est exécutée pour chaque élément de la liste et le résultat est également une liste.

Operation

Précise le mode de fonctionnement de la fonction.

L'argument Operation peut avoir les valeurs suivantes :

Constante	Signification
EVENT_INDEX	Les indices des valeurs ou des points remplissant la condition sont placés dans l'ensemble de données de résultat.
EVENT_EXTRACT	Seuls les points ou valeurs remplissant la condition sont transférés dans l'ensemble de données de résultat.
EVENT_SETVOID	Les points ou valeurs qui ne remplissent pas la condition sont également inclus dans l'ensemble de données de résultat, mais ils y sont marqués comme nuls.
EVENT_DEFAULT	Correspond à EVENT_SETVOID si une matrice de données ou une série de signaux est présente, et sinon EVENT_INDEX.
+ EVENT_COMPLEMENT	Cette constante peut être ajoutée de manière optionnelle et permet ensuite d'inverser l'opération sélectionnée. Ainsi, par exemple, avec EVENT_EXTRACT, les points qui ne correspondent pas à la condition sont copiés.

Si l'argument est une liste, alors son premier élément est pris. S'il s'agit à nouveau d'une liste, le processus est répété.

Si l'argument n'est pas spécifié, il est défini à la valeur par défaut EVENT_DEFAULT .

Remarques

Le résultat est toujours du type de données Temps calendaire.

Dans le cas des signaux et des séries de signaux, la composante X est recherchée.

Dans le cas où LowerBound est inférieure ou égale à UpperBound une valeur se trouve dans l'intervalle si elle est supérieure ou égale à LowerBoundet est inférieure ou égale à UpperBound. Si LowerBound est spécifié comme étant supérieur à UpperBound une valeur se trouve dans l'intervalle si elle est supérieure ou égale à LowerBoundou inférieure ou égale à UpperBound. Cela équivaut approximativement à un complément.

Pour les éléments de date SECOND, MINUTE et HOUR vous pouvez spécifier les limites d'intervalle comme des valeurs à virgule flottante.

Disponible dans

FlexPro Basic, Professional, Developer Suite

Exemples

TimePeriods(TimeSignal, SECOND, 3.5, 12.3)	Renvoie les indices des valeurs du signal "TimeSignal", qui sont dans l'intervalle [3,5, 12,3] secondes dans chaque minute.
TimePeriods(TimeSignal, SECOND, 200 ms, 600 ms)	Renvoie les indices des valeurs du signal "TimeSignal", qui sont dans l'intervalle [0,2, 0,6] secondes dans chaque minute.
TimePeriods(SignalSeries, WEEKDAY, MONDAY, FRIDAY, EVENT_SETVOID)	Renvoie la série de signaux où toutes les valeurs Y survenant au cours d'un week-end ont été définies comme invalides (void).
IndexAnd(TimePeriods(TimeSignal, WEEKDAY, MONDAY, FRIDAY), TimePeriods(TimeSignal, HOUR, 9.0, 17.5))	Renvoie les indices des valeurs du signal "TimeSignal" qui tombent un jour de semaine et se situent entre 9h00 et 17h30.