resqpy.fault.grid_columns_property_from_gcs_property

resqpy.fault.grid_columns_property_from_gcs_property(model, gcs_property_uuid, null_value=nan, title=None, multiple_handling='default')

Derives a new grid columns property (map) from a single-grid gcs property using values for k faces.

Parameters:

  • model (Model) – the model in which the existing objects are to be found and the new property added

  • gcs_property_uuid (uuid) – the uuid of the existing grid connection set property

  • null_value (float or int, default NaN) – the value to use in columns where no K faces are present in the gcs

  • title (str, optional) – the title for the new grid property; defaults to that of the gcs property

  • multiple_handling (str, default 'mean') – one of ‘default’, ‘mean’, ‘min’, ‘max’, ‘min_k’, ‘max_k’, ‘exception’; determines how a value is generated when more than one K face is present in the gcs for a column

Returns:

uuid of the newly created Property (RESQML ContinuousProperty, DiscreteProperty, CategoricalProperty or PointsProperty)

Notes

the grid connection set which is the support for gcs_property must involve only one grid; the resulting columns grid property is of the same class as the original gcs property; the write_hdf() and create_xml() methods are called by this function, for the new property, which is added to the model; the default multiple handling mode is mean for continuous data, any for discrete (inc categorical); in the case of discrete (including categorical) data, a null_value of NaN will be changed to -1