cf.ge

cf.ge(value, units=None, attr=None)[source]

Return a cf.Query object for a variable for being greater than or equal to a value.

Parameters:
value :

The value which a variable is to be compared with.

units : str or cf.Units, optional

The units of value. By default, the same units as the variable being tested are assumed, if applicable.

attr : str, optional

Return a query object for a variable’s attr attribute.

Returns:
out : cf.Query

The query object.

Examples:
>>> q = cf.ge(5)
>>> q
<CF Query: x ge 5>
>>> q.evaluate(5)
True
>>> q.evaluate(4)
False
>>> cf.ge(10, 'm')
<CF Query: (ge <CF Data: 10 m>)>
>>> cf.ge(100, cf.Units('kg'))
<CF Query: (ge <CF Data: 100 kg>)>
>>> cf.ge(2, attr='month')
<CF Query: month(ge 2)>

Previous topic

cf.eq

Next topic

cf.gt

This Page