citrine.gemd_queries.filter module

Definitions for GemdQuery objects, and their sub-objects.

class citrine.gemd_queries.filter.AllIntegerFilter

Bases: Serializable[AllIntegerFilter], PropertyFilterType

Filter for any integer value that fits certain constraints.

Parameters:

• lower (float) – The lower bound on this filter range.

• upper (float) – The upper bound on this filter range.

• inclusive (bool) – Whether the lower & upper bounds are included in the range.

classmethod build(data: dict) → Self

Build an instance of this object from given data.

dump() → dict

Dump this instance.

classmethod get_type(data) → Type[Serializable]

Return the subtype.

inclusive = True

lower = None

typ = 'all_integer_filter'

upper = None

class citrine.gemd_queries.filter.AllRealFilter

Bases: Serializable[AllRealFilter], PropertyFilterType

Filter for any real value that fits certain constraints.

Parameters:

• lower (float) – The lower bound on this filter range.

• upper (float) – The upper bound on this filter range.

• unit (str) – The units associated with the floating point values for this filter.

classmethod build(data: dict) → Self

Build an instance of this object from given data.

dump() → dict

Dump this instance.

classmethod get_type(data) → Type[Serializable]

Return the subtype.

lower = None

typ = 'all_real_filter'

unit = None

upper = None

class citrine.gemd_queries.filter.NominalCategoricalFilter

Bases: Serializable[NominalCategoricalFilter], PropertyFilterType

Filter based upon a fixed list of Categorical Values.

Parameters:

categories (Set[str]) – Which categorical values match.

classmethod build(data: dict) → Self

Build an instance of this object from given data.

dump() → dict

Dump this instance.

classmethod get_type(data) → Type[Serializable]

Return the subtype.

categories = None

typ = 'nominal_categorical_filter'