GSTPy.ParsedGeometry — GSTPy documentation

# GSTPy.ParsedGeometry

class `GSTPy.``ParsedGeometry`

  Describes a parsed geometry.

  `add_object_property_value`((ParsedGeometry)self, (str)name, (str)value) → None :

    Add an object property with a value.

    Parameters:

    - name (str) – The name of the property.
    - value (str) – The value of the property.

  `get_object_property_value`((ParsedGeometry)self, (str)name) → str :

    Get a object property value by name.

    Parameters: | name (str) – The name of the property.
    Returns: | The property value.
    Return type: | str

  `list_simplex_properties`((ParsedGeometry)self) → list :

    List the simplex property descriptions of the geometry.

    Returns:

    List of simplex
      property descriptions.

    Return type: | list[ParsedSimplexPropertyDescription]

  static `load_file`((str)file_path, (FileType)file_type, (GeometryTypes)geom_type) → list :

    Loads and parses geometries from a file.

    Parameters:

    - file_path (str) – The file path.
    - file_type (FileType) – The type of the file.
    - geom_type (GeometryTypes) – The geometry type to be parsed.

    Returns: | List of contained geometries.
    Return type: | list[ParsedGeometry]

  `remove_all_object_properties`((ParsedGeometry)self) → None :

    Removes all object properties.

  `remove_object_property`((ParsedGeometry)self, (str)name) → None :

    Remove a object property by name.

    Parameters: | name (str) – The name of the property to remove.

  `rename_object_property`((ParsedGeometry)self, (str)name, (str)new_name) → bool :

    Rename an object property.

    Parameters:

    - name (str) – The current name of the property.
    - new_name (str) – The new name of the property.

    Returns: | Tells if rename did occur.
    Return type: | bool

  `set_color`((ParsedGeometry)self, (Color)color) → None :

    Sets the color of the geometry.

    Parameters: | color (Color) – The color.

  `set_name`((ParsedGeometry)self, (str)name) → None :

    Sets the name of the geometry.

    Parameters: | name (str) – The name.

  `set_segy_info`((ParsedGeometry)self, (SEGYInfo)info) → None :

    Sets the SEGY info.

    Parameters: | info (SEGYInfo) – The information about the SEGY.

  `set_simplex_property_matching`((ParsedGeometry)self, (dict)matching) → None :

    Set the matching for simplex properties.

    Parameters: | matching (dict) – Mapping of simplex property names of the parsed geometry and feature class.

  `set_srs`((ParsedGeometry)self, (SRS)srs) → None :

    Sets the SRS of the geometry.

    Parameters: | srs (SRS) – The SRS of this feature.