mirror of
https://github.com/OPM/ResInsight.git
synced 2024-12-29 10:21:54 -06:00
64 lines
2.1 KiB
Python
64 lines
2.1 KiB
Python
"""
|
|
ResInsight 3d contour map module
|
|
"""
|
|
|
|
import Commands_pb2
|
|
|
|
from .pdmobject import add_method
|
|
from .view import View
|
|
from .resinsight_classes import EclipseContourMap, GeoMechContourMap
|
|
|
|
|
|
@add_method(EclipseContourMap)
|
|
def export_to_text(
|
|
self: EclipseContourMap,
|
|
export_file_name: str = "",
|
|
export_local_coordinates: bool = False,
|
|
undefined_value_label: str = "NaN",
|
|
exclude_undefined_values: bool = False,
|
|
):
|
|
"""Export snapshot for the current view
|
|
|
|
Arguments:
|
|
export_file_name(str): The file location to store results in.
|
|
export_local_coordinates(bool): Should we export local coordinates, or UTM.
|
|
undefined_value_label(str): Replace undefined values with this label.
|
|
exclude_undefined_values(bool): Skip undefined values.
|
|
"""
|
|
return self._execute_command(
|
|
exportContourMapToText=Commands_pb2.ExportContourMapToTextRequest(
|
|
exportFileName=export_file_name,
|
|
exportLocalCoordinates=export_local_coordinates,
|
|
undefinedValueLabel=undefined_value_label,
|
|
excludeUndefinedValues=exclude_undefined_values,
|
|
viewId=self.id,
|
|
)
|
|
)
|
|
|
|
|
|
@add_method(GeoMechContourMap)
|
|
def export_to_text(
|
|
self: GeoMechContourMap,
|
|
export_file_name: str = "",
|
|
export_local_coordinates: bool = False,
|
|
undefined_value_label: str = "NaN",
|
|
exclude_undefined_values: bool = False,
|
|
):
|
|
"""Export snapshot for the current view
|
|
|
|
Arguments:
|
|
export_file_name(str): The file location to store results in.
|
|
export_local_coordinates(bool): Should we export local coordinates, or UTM.
|
|
undefined_value_label(str): Replace undefined values with this label.
|
|
exclude_undefined_values(bool): Skip undefined values.
|
|
"""
|
|
return self._execute_command(
|
|
exportContourMapToText=Commands_pb2.ExportContourMapToTextRequest(
|
|
exportFileName=export_file_name,
|
|
exportLocalCoordinates=export_local_coordinates,
|
|
undefinedValueLabel=undefined_value_label,
|
|
excludeUndefinedValues=exclude_undefined_values,
|
|
viewId=self.id,
|
|
)
|
|
)
|