Rogii Solo.Interpretation¶

`Interpretation`¶
attribute well	The well object to which `Interpretation` belongs.
attribute uuid	Unique identifier of the `Interpretation`.
attribute name	Name of the `Interpretation`.
attribute mode	Sharing mode of the `Interpretation`.
attribute owner	User ID of the `Interpretation`’s creator or owner.
attribute properties	Dictionary of `Interpretation` specific visualization and display settings.
attribute format	Version of the `Interpretation`.
property assembled_segments	Get the assembled Segments data for `Interpretation`,
property horizons	Get the collection of `Horizon` objects for this `Interpretation`.
property earth_models	Get the collection of `EarthModel` objects for this `Interpretation`.
property starred_horizon_top	Get the top starred `Horizon` for this `Interpretation`.
property starred_horizon_center	Get the center starred `Horizon` for this `Interpretation`.
property starred_horizon_bottom	Get the bottom starred `Horizon` for this `Interpretation`.
method to_dict(get_converted)	Convert the `Interpretation` instance to a dictionary.
method to_df(get_converted)	Convert the `Interpretation` to a dictionary with Pandas DataFrames.
method get_tvt_data(md_step)	Get TVT (True Vertical Thickness) list of the `Interpretation`.

Module Contents¶

class Interpretation(papi_client: rogii_solo.papi.client.PapiClient, well: rogii_solo.well.Well, **kwargs)¶

Bases: rogii_solo.base.ComplexObject

Represent an Interpretation for a Well, containing data about Horizon, EarthModel, and assembled Segments. The Interpretation class provides methods to get and process Interpretation details.

Example:

from rogii_solo import SoloClient

client_id = ...  # Input your client ID
client_secret = ...  # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
projects = solo_client.set_project_by_name('Project1')
well = projects.wells.find_by_name('Well1')

# Get an Interpretation in the Well
interpretation = well.interpretations.find_by_name('Interpretation1')

# Get the Well object to which Interpretation belongs
well = interpretation.well
print(well.name)

# Get a unique ID of the Interpretation
interpretation_uuid = interpretation.uuid
print(interpretation_uuid)

# Get the name of the Interpretation
interpretation_name = interpretation.name
print(interpretation_name)

# Get the owner ID of the Interpretation
interpretation_owner = interpretation.owner
print(interpretation_owner)

# Get the sharing mode of the Interpretation
interpretation_mode = interpretation.mode
print(interpretation_mode)

# Get the version of the Interpretation
interpretation_format = interpretation.format
print(interpretation_format)

well¶: The well object to which Interpretation belongs.

uuid: str | None = None¶: Unique identifier of the Interpretation.

name: str | None = None¶: Name of the Interpretation.

mode: str | None = None¶: Sharing mode of the Interpretation.

owner: int | None = None¶: User ID of the Interpretation’s creator or owner.

properties: rogii_solo.types.DataList | None = None¶: Dictionary of Interpretation specific visualization and display settings.

format: str | None = None¶: Version of the Interpretation.

property assembled_segments: rogii_solo.papi.types.PapiAssembledSegments¶

Get the assembled Segments data for Interpretation, including Horizon positions and fitted Segments.

Returns:: Assembled Segments data.
Example:

from rogii_solo import SoloClient

client_id = ...  # Input your client ID
client_secret = ...  # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
projects = solo_client.set_project_by_name('Project1')
well = projects.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')

# Get the assembled Segments data
assembled_segments = interpretation.assembled_segments
print(assembled_segments.to_dict())

property horizons: rogii_solo.base.ObjectRepository[rogii_solo.horizon.Horizon]¶

Get the collection of Horizon objects for this Interpretation.

Returns:: An ObjectRepository containing the Horizon instances.
Example:

from rogii_solo import SoloClient

client_id = ...  # Input your client ID
client_secret = ...  # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
projects = solo_client.set_project_by_name('Project1')
well = projects.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')

# Get the Horizons for this Interpretation
horizons = interpretation.horizons
print(horizons.to_dict())

property earth_models: rogii_solo.base.ObjectRepository[rogii_solo.earth_model.EarthModel]¶

Get the collection of EarthModel objects for this Interpretation.

Returns:: An ObjectRepository containing EarthModel instances.
Example:

from rogii_solo import SoloClient

client_id = ...  # Input your client ID
client_secret = ...  # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
projects = solo_client.set_project_by_name('Project1')
well = projects.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')

# Get the EarthModels for this Interpretation
earth_models = interpretation.earth_models
print(earth_models.to_dict())

property starred_horizon_top: rogii_solo.horizon.Horizon | None¶

Get the top starred Horizon for this Interpretation.

Returns:: A Horizon instance representing the top starred Horizon, or None if none exists.
Example:

from rogii_solo import SoloClient

client_id = ...  # Input your client ID
client_secret = ...  # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
projects = solo_client.set_project_by_name('Project1')
well = projects.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')

# Get the top starred Horizon for this Interpretation
top_starred_horizon = interpretation.starred_horizon_top
print(top_starred_horizon.to_dict())

property starred_horizon_center: rogii_solo.horizon.Horizon | None¶

Get the center starred Horizon for this Interpretation.

Returns:: A Horizon instance representing the center starred Horizon, or None if none exists.
Example:

from rogii_solo import SoloClient

client_id = ...  # Input your client ID
client_secret = ...  # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
projects = solo_client.set_project_by_name('Project1')
well = projects.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')

# Get the center starred Horizon for this Interpretation
center_starred_horizon = interpretation.starred_horizon_center
print(center_starred_horizon.to_dict())

property starred_horizon_bottom: rogii_solo.horizon.Horizon | None¶

Get the bottom starred Horizon for this Interpretation.

Returns:: A Horizon instance representing the bottom starred Horizon, or None if none exists.
Example:

from rogii_solo import SoloClient

client_id = ...  # Input your client ID
client_secret = ...  # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
projects = solo_client.set_project_by_name('Project1')
well = projects.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')

# Get the bottom starred Horizon for this Interpretation
bottom_starred_horizon = interpretation.starred_horizon_bottom
print(bottom_starred_horizon.to_dict())

to_dict(get_converted: bool = True) → Dict[str, Any]¶

Convert the Interpretation instance to a dictionary.

Parameters:: get_converted – (Optional) Whether to convert numeric values to the current project’s measurement units. Default = True.
Returns:: Dictionary containing meta information, horizons, segments, and earth model info.
Example:

from rogii_solo import SoloClient

client_id = ...  # Input your client ID
client_secret = ...  # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
projects = solo_client.set_project_by_name('Project1')
well = projects.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')

# Convert the Interpretation to a dictionary
interpretation_dict = interpretation.to_dict()
print(interpretation_dict)

to_df(get_converted: bool = True) → rogii_solo.types.Interpretation¶

Convert the Interpretation to a dictionary with Pandas DataFrames.

Parameters:: get_converted – (Optional) Whether to convert numeric values to the current project’s measurement units. Default = True.
Returns:: A dictionary of DataFrames, containing Interpretation metadata, Horizon, EarthModels and Segments.
Example:

from rogii_solo import SoloClient

client_id = ...  # Input your client ID
client_secret = ...  # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
projects = solo_client.set_project_by_name('Project1')
well = projects.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')

# Convert the Interpretation to a dictionary with DataFrames
interpretation_df = interpretation.to_df()
print(interpretation_df)

get_tvt_data(md_step: int = 1) → rogii_solo.types.DataList¶

Get TVT (True Vertical Thickness) list of the Interpretation.

Parameters:: md_step – (Optional) Step size for MD (measured depth) when fetching TVT data. Default = 1.
Returns:: A list of TVT data points.
Example:

from rogii_solo import SoloClient

client_id = ...  # Input your client ID
client_secret = ... # Input your client secret
solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
projects = solo_client.set_project_by_name('Project1')
well = projects.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')

# Get TVT data for the Interpretation
tvt_data = interpretation.get_tvt_data(md_step=10)
print(tvt_data)