> For the complete documentation index, see [llms.txt](https://doc.moost.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.moost.io/platform-manual/rules/rule-language/functions/filter.md). # FILTER ### Description Filter data on a *vector,* *grouped scalar* or *grouped vector*, by comparing with a threshold. Only data which fulfills that boolean condition is kept. ### Filter(Vector\, Scalar\, Scalar\) ```java FILTER(vector: Vector, comparisonSymbol: Scalar, threshold: Scalar): Vector ``` Filter data in the given *vector* by comparing with the threshold. #### Parameters
ParameterDescription
vectorA vector whose data is to be filtered
comparisonSymbolThe comparison symbol. One of: <, <=, =, !=, >=, >
thresholdA scalar which is used to filter data.
#### Returns *Vector* of same type as from the first function parameter, with filtered data. ### Examples Filter events, so that only values > 1000 are kept in the vector. ```java FILTER($GridPowerConsumption, '>', 1000) ``` *** ### Filter(GroupedScalar\, Scalar\, Scalar\) ```java FILTER(groupedScalar: GroupedScalar, comparisonSymbol: Scalar, threshold: Scalar): GroupedScalar ``` Filter data in the given *grouped scalar* by comparing with the threshold. Empty groups are removed from the *grouped scalar.* #### Parameters
ParameterDescription
groupedScalarA vector whose data is to be filtered.
comparisonSymbolThe comparison symbol. One of: <, <=, =, !=, >=, >
thresholdA scalar which is used to filter data.
#### Returns *Grouped scalar* of same type as from the first function parameter, with filtered data. ### Examples Filter events in the *grouped scalar*, so that only values > 1000 are kept in the vector. ```java FILTER(MIN(GROUP_BY_DEVICE($PowerConsumption)), '!=', 0) ``` *** ### Filter(GroupedVector\, Scalar\, Scalar\) ```java FILTER(groupedVector: GroupedVector, comparisonSymbol: Scalar, threshold: Scalar): GroupedVector ``` Filter data in the given *grouped vector* by comparing with the threshold. Empty groups are removed from the *grouped vector.* #### Parameters
ParameterDescription
groupedVectorA vector whose data is to be filtered.
comparisonSymbolThe comparison symbol. One of: <, <=, =, !=, >=, >
thresholdA scalar which is used to filter data.
#### Returns *Grouped vector* of same type as from the first function parameter, with filtered data. ### Examples Filter events, so that only values > 1000 are kept in the *grouped vector*. ```java FILTER(GROUP_BY_DEVICE($PowerConsumption), '<=', 200) ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://doc.moost.io/platform-manual/rules/rule-language/functions/filter.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.