Phenomenon

Phenomena	Collection of phenomena
Phenomenon	Class for representing information about a collection of objects

class lue.data_model.Phenomena

Collection of phenomena

Phenomenon collections can be obtained from Dataset and Universe instances.

class lue.data_model.Phenomenon

Class for representing information about a collection of objects

A phenomenon contains two property set collections. The first contains information about each object in a collection of objects. The second second contains information that is representable for the collection of objects as a whole.

Phenomena are used to organize information about different collections of objects. For example, information about cows, parcels and farmers can be stored using three phenomena.

add_collection_property_set(*args, **kwargs)

Overloaded function.

1. add_collection_property_set(self: lue.lue_py.data_model.Phenomenon, name: str) -> lue.lue_py.data_model.PropertySet

   Add new property-set to collection

   param str name:

   Name of property-set to create

   return:

   Property-set created

   rtype:

   PropertySet

   raises RuntimeError:

   In case the property-set cannot be created

   The property-set will have no time domain and no space domain. Information stored in this property-set will be omnipresent through time and space.

2. add_collection_property_set(self: lue.lue_py.data_model.Phenomenon, name: str, time_domain: lue.lue_py.data_model.TimeDomain) -> lue.lue_py.data_model.PropertySet

   Add new property-set to collection

   param str name:

   Name of property-set to create

   param TimeDomain time_domain:

   Another property-set’s time domain to use. Sharing time domains makes sense when the locations in time are the same. This saves space in the dataset.

   return:

   Property-set created

   rtype:

   PropertySet

   raises RuntimeError:

   In case the property-set cannot be created

   The property-set will have no space domain. Information stored in this property-set will be omnipresent through space.

add_property_set(*args, **kwargs)

Overloaded function.

1. add_property_set(self: lue.lue_py.data_model.Phenomenon, name: str) -> lue.lue_py.data_model.PropertySet

   Add new property-set to collection

   param str name:

   Name of property-set to create

   return:

   Property-set created

   rtype:

   PropertySet

   raises RuntimeError:

   In case the property-set cannot be created

   The property-set will have no time domain and no space domain. Information stored in this property-set will be omnipresent through time and space.

2. add_property_set(self: lue.lue_py.data_model.Phenomenon, name: str, space_configuration: lue.lue_py.data_model.SpaceConfiguration, space_coordinate_dtype: object, rank: int) -> lue.lue_py.data_model.PropertySet

   Add new property-set to collection

   param str name:

   Name of property-set to create

   param SpaceConfiguration space_configuration:

   Configuration of space domain

   param numpy.dtype space_coordinate_dtype:

   Datatype of the spatial coordinates

   param int rank:

   Number of spatial dimensions

   return:

   Property-set created

   rtype:

   PropertySet

   raises RuntimeError:

   In case the property-set cannot be created

   The property-set returned will have no time domain. Information stored in this property-set will be omnipresent through time.

3. add_property_set(self: lue.lue_py.data_model.Phenomenon, name: str, time_configuration: lue.lue_py.data_model.TimeConfiguration, clock: lue.lue_py.data_model.Clock) -> lue.lue_py.data_model.PropertySet

   Add new property-set to collection

   param str name:

   Name of property-set to create

   param TimeConfiguration time_configuration:

   Configuration of time domain

   param Clock clock:

   Clock for locations in time

   return:

   Property-set created

   rtype:

   PropertySet

   raises RuntimeError:

   In case the property-set cannot be created

4. add_property_set(self: lue.lue_py.data_model.Phenomenon, name: str, time_configuration: lue.lue_py.data_model.TimeConfiguration, clock: lue.lue_py.data_model.Clock, space_configuration: lue.lue_py.data_model.SpaceConfiguration, space_coordinate_dtype: object, rank: int) -> lue.lue_py.data_model.PropertySet

   Add new property-set to collection

   param str name:

   Name of property-set to create

   param TimeConfiguration time_configuration:

   Configuration of time domain

   param Clock clock:

   Clock for locations in time

   param SpaceConfiguration space_configuration:

   Configuration of space domain

   param numpy.dtype space_coordinate_dtype:

   Datatype of the spatial coordinates

   param int rank:

   Number of spatial dimensions

   return:

   Property-set created

   rtype:

   PropertySet

   raises RuntimeError:

   In case the property-set cannot be created

5. add_property_set(self: lue.lue_py.data_model.Phenomenon, name: str, time_domain: lue.lue_py.data_model.TimeDomain) -> lue.lue_py.data_model.PropertySet

   Add new property-set to collection

   param str name:

   Name of property-set to create

   param TimeDomain time_domain:

   Another property-set’s time domain to use. Sharing time domains makes sense when the locations in time are the same. This saves space in the dataset.

   return:

   Property-set created

   rtype:

   PropertySet

   raises RuntimeError:

   In case the property-set cannot be created

   The property-set will have no space domain. Information stored in this property-set will be omnipresent through space.

6. add_property_set(self: lue.lue_py.data_model.Phenomenon, name: str, time_configuration: lue.lue_py.data_model.TimeConfiguration, clock: lue.lue_py.data_model.Clock, object_tracker: lue.lue_py.data_model.ObjectTracker) -> lue.lue_py.data_model.PropertySet

   Add new property-set to collection

   param str name:

   Name of property-set to create

   param TimeConfiguration time_configuration:

   Configuration of time domain

   param Clock clock:

   Clock for locations in time

   param ObjectTracker object_tracker:

   Another property-set’s object tracker to use. Sharing object trackers makes sense when the active set in different property-sets are the same.

   return:

   Property-set created

   rtype:

   PropertySet

   raises RuntimeError:

   In case the property-set cannot be created

   The property-set will have no space domain. Information stored in this property-set will be omnipresent through space.

7. add_property_set(self: lue.lue_py.data_model.Phenomenon, name: str, time_domain: lue.lue_py.data_model.TimeDomain, object_tracker: lue.lue_py.data_model.ObjectTracker) -> lue.lue_py.data_model.PropertySet

   Add new property-set to collection

   param str name:

   Name of property-set to create

   param TimeDomain time_domain:

   Another property-set’s time domain to use. Sharing time domains makes sense when the locations in time are the same. This saves space in the dataset.

   param ObjectTracker object_tracker:

   Another property-set’s object tracker to use. Sharing object trackers makes sense when the active set in different property-sets are the same.

   return:

   Property-set created

   rtype:

   PropertySet

   raises RuntimeError:

   In case the property-set cannot be created

   The property-set will have no space domain. Information stored in this property-set will be omnipresent through space.

8. add_property_set(self: lue.lue_py.data_model.Phenomenon, name: str, time_domain: lue.lue_py.data_model.TimeDomain, space_configuration: lue.lue_py.data_model.SpaceConfiguration, space_coordinate_dtype: object, rank: int) -> lue.lue_py.data_model.PropertySet

   Add new property-set to collection

   param str name:

   Name of property-set to create

   param TimeDomain time_domain:

   Another property-set’s time domain to use. Sharing time domains makes sense when the locations in time are the same. This saves space in the dataset.

   param SpaceConfiguration space_configuration:

   Configuration of space domain

   param numpy.dtype space_coordinate_dtype:

   Datatype of the spatial coordinates

   param int rank:

   Number of spatial dimensions

   return:

   Property-set created

   rtype:

   PropertySet

   raises RuntimeError:

   In case the property-set cannot be created

9. add_property_set(self: lue.lue_py.data_model.Phenomenon, name: str, time_domain: lue.lue_py.data_model.TimeDomain, object_tracker: lue.lue_py.data_model.ObjectTracker, space_configuration: lue.lue_py.data_model.SpaceConfiguration, space_coordinate_dtype: object, rank: int) -> lue.lue_py.data_model.PropertySet

   Add new property-set to collection

   param str name:

   Name of property-set to create

   param TimeDomain time_domain:

   Another property-set’s time domain to use. Sharing time domains makes sense when the locations in time are the same. This saves space in the dataset.

   param ObjectTracker object_tracker:

   Another property-set’s object tracker to use. Sharing object trackers makes sense when the active set in different property-sets are the same.

   param SpaceConfiguration space_configuration:

   Configuration of space domain

   param numpy.dtype space_coordinate_dtype:

   Datatype of the spatial coordinates

   param int rank:

   Number of spatial dimensions

   return:

   Property-set created

   rtype:

   PropertySet

   raises RuntimeError:

   In case the property-set cannot be created

property collection_property_sets

Return property sets collection containing information about the collection of objects

Return type:

PropertySets

property description

Return description

property object_id

object_id docstring…

property property_sets

Return property sets collection containing information about each object in the collection of objects

Return type:

PropertySets