fmu.sumo.explorer.objects.surface module

Module containg class for surface

class fmu.sumo.explorer.objects.surface.Surface(sumo, metadata, blob=None)[source]

Bases: Child

Class representing a surface object in Sumo

Parameters:
  • sumo (SumoClient) – connection to Sumo

  • metadata (dict) – dictionary metadata

  • blob – data object

to_regular_surface()[source]

Get surface object as a RegularSurface

Returns:

A RegularSurface object

Return type:

RegularSurface

async to_regular_surface_async()[source]

Get surface object as a RegularSurface

Returns:

A RegularSurface object

Return type:

RegularSurface

property aggregation: str

Object aggregation operation

property asset: str

Object asset name

property bbox: Dict

Object boundary-box data

property blob: BytesIO

Object blob

property blob_async: BytesIO

Object blob

property casename: str

Object case name

property caseuuid: str

Object case uuid

property classname: str

Object class name

property columns: List[str]

Object table columns

property content: str

Content

property context: str

Object context

property dataformat: str

Object file format

property dataname: str

Object data name

property ensemble: str

Object ensemble

property entity: str

Entity uuid for object.

property format: str

Object file format

property interval: str | Tuple[str, str] | None

Object interval data

property metadata

Return metadata for document

Returns:

the metadata

Return type:

dict

property name: str

Object data name

property operationname: str

Object aggregation operation name

property realization: str

Object realization

property relative_path: str

Object relative file path

property spec: Dict

Object spec data

property stage: str

Object stage

property stratigraphic: str

Object stratigraphic

property tagname: str

Object tagname

property timestamp: str | None

Object timestmap data

property uuid

Return uuid

Returns:

the uuid of the case

Return type:

str

property vertical_domain: str

Object vertical domain