FieldOutlineData

FieldOutline

A block describing a field outline.

BoundingBox3D

Contains the 3D coordinates within which a data object is contained.

FaultRoomSurfaceSpecification

Specifies relevant values describing a Faultroom surface object.

CubeSpecification

Specifies relevant values describing a cube object, i.e. a seismic cube.

PointSpecification

Specifies relevant values describing an xyz points object.

PolygonsSpecification

Specifies relevant values describing a polygon object.

Geometry

The geometry of the object, i.e. the grid that an object representing a grid property is derivative of.

Time

A block containing lists of objects describing timestamp information for this data object, if applicable, like Flow simulator restart dates, or dates for seismic 4D surveys.

CPGridPropertySpecification

Specifies relevant values describing a corner point grid property object.

CPGridSpecification

Specifies relevant values describing a corner point grid object.

SurfaceSpecification

Specifies relevant values describing a regular surface object.

TableSpecification

Specifies relevant values describing a generic tabular data object.

BoundingBox2D

Contains the 2D coordinates within which a data object is contained.

AnyStandardResult

The standard result field contains information about which standard result this data object represents.

Layer

Used to represent a layer, i.e. top or bottom, of a given stratigraphic interval.

GridModel

A block containing information pertaining to grid model content.
pydantic model FieldOutlineData[source]

The data block contains information about the data contained in this object. This class contains metadata for field outlines.

Fields:
field standard_result: Optional[AnyStandardResult] = None

Information about the standard result that these data represent. The presence of this field indicates that these data conforms to a specified standard.

field name: str [Required]

This is the identifying name of this data object. For surfaces, this is typically the horizon name or similar. Shall be compliant with the stratigraphic column if applicable.

field alias: Optional[List[str]] = None

Other known-as names for data.name. Typically names used within specific software, e.g. RMS and others.

field tagname: Optional[str] = None

An identifier for this/these data object(s). Similar to the second part of the generated filename in disk-oriented FMU data standard.

You should avoid using tagname as metadata in queries since its value is free-form. The intention with tagname is mostly backward compatibility with legacy scratch-file naming rules in FMU.

field stratigraphic: bool [Required]

True if this is defined in the stratigraphic column.

field description: Optional[List[str]] = None

A list of strings, freetext description of this data, if applicable.

field geometry: Optional[Geometry] = None

The geometry of the object, i.e. the grid that an object representing a grid property is derivative of. See Geometry.

field bbox: Optional[Union[BoundingBox3D, BoundingBox2D]] = None

A block containing the bounding box for this data. Only applicable if the object is coordinate-based. See BoundingBox3D and BoundingBox2D.

field format: enums.FileFormat [Required]

A reference to a known file format.

field grid_model: Optional[GridModel] = None

A block containing information pertaining to grid model content. See GridModel.

Warning

This has currently no function and is likely to be deprecated.

field is_observation: bool [Required]

True if this is an observation.

field is_prediction: bool [Required]

True if this is a prediction.

field layout: Optional[enums.Layout] = None

A reference to the layout of the data object. See enums.Layout.

field offset: float = 0.0

If a specific horizon is represented with an offset, e.g. “2 m below Top Volantis”.

Constraints:

  • allow_inf_nan = False

field spec: Optional[AnySpecification] = None

A block containing the specs for this object, if applicable. See AnySpecification.

field time: Optional[Time] = None

A block containing lists of objects describing timestamp information for this data object, if applicable, like Flow simulator restart dates, or dates for seismic 4D surveys. See Time.

Note

data.time items can currently hold a maximum of two values.

field undef_is_zero: Optional[bool] = None

Flag if undefined values are to be interpreted as zero

field unit: str = ''

A reference to a known unit.

field vertical_domain: Optional[enums.VerticalDomain] = None

A reference to a known vertical domain.

field domain_reference: Optional[enums.DomainReference] = None

The reference for the vertical scale of the data.

field table_index: Optional[List[str]] = None

Column names in the table which can be used for indexing. Only applicable if the data object is a table.

field base: Optional[Layer] = None

If the data represent an interval, this field can be used to represent its base. See Layer.

Note

top is required to use with this.

field top: Optional[Layer] = None

If the data represent an interval, this field can be used to represent its top. See Layer.

Note

base is required to use with this.

field content: Literal[enums.Content.field_outline] [Required]

The type of content these data represent.

field field_outline: FieldOutline [Required]

A block describing a field outline. See FieldOutline.