Wavelet

class cegalprizm.pythontool.Wavelet(python_petrel_property: WaveletGrpc)

A class holding information about a wavelet

Functions

__init__(python_petrel_property)
add_comment(new_comment[, overwrite])	Add a comment to the already existing comments on the PetrelObject, or overwrite the existing comments.
as_dataframe()	The values of the position and amplitude of the wavelet as a Pandas DataFrame
clone(name_of_clone[, copy_values])	Creates a clone of the Petrel object.
retrieve_history()	The Petrel history for the object.
retrieve_stats()	Retrieves a dictionary summarizing the statistics for the object
set(amplitudes[, sampling_start, ...])	Replaces all the wavelet amplitude with the supplied values

Properties

amplitudes	Returns the amplitudes of the wavelet object as a numpy array
comments	The comments on the PetrelObject.
droid	The Petrel Droid (object id or guid) for the object
path	The path of this object in Petrel.
petrel_name	Returns the name of this object in Petrel
readonly	The read-only status of this object
sample_count	The number of samples contained in the Wavelet object.
sample_points	Returns the time values of the wavelet object as a numpy array
sampling_interval
sampling_start	Returns the first time value of the wavelet object as a float
template	Returns the Petrel template for the object as a string.
time_unit_symbol	Returns the time unit of the wavelet object

add_comment(new_comment: str, overwrite: bool = False) → None

Add a comment to the already existing comments on the PetrelObject, or overwrite the existing comments.

Input:

new_comment: The new comment to add to the PetrelObject. overwrite: Boolean flag to overwrite all existing comments with the new comment. Default is False.

Raises

PythonToolException – if object is read-only

as_dataframe() → pandas.core.frame.DataFrame

The values of the position and amplitude of the wavelet as a Pandas DataFrame

clone(name_of_clone: str, copy_values: bool = False) → cegalprizm.pythontool.wavelet.Wavelet

Creates a clone of the Petrel object.

The clone is placed in the same collection as the source object. A clone cannot be created with the same name as an existing Petrel object in the same collection.

This is a Python Tool Pro function and is not available when running scripts in the editor integrated in Python Tool or in a workflow.

Parameters

• path_of_clone – Petrel name of the clone

• copy_values – Set to True if values shall be copied into the clone. Defaults to False.

Returns

The clone

Return type

Wavelet

Raises

• Exception – If there already exists a Petrel object with the same name

• ValueError – If name_of_clone is empty or contains slashes

retrieve_history() → pandas.core.frame.DataFrame

The Petrel history for the object.

Returns the Petrel history for the object as Pandas dataframe.

Returns

The history of the object as reported by Petrel

Return type

DataFrame

retrieve_stats() → Dict[str, str]

Retrieves a dictionary summarizing the statistics for the object

The statistics are a snapshot of the information in the Statistics page of the Settings panel of the object in the Petrel tree. Both the dict key and value are strings, and may contain punctuation, English phrases or just filler information. Any changes to the dict returned will not be saved or affect anything.

Note: this operation may be slow, since the statistics are ‘live’ - they represent the most up to date information.

Returns

The statistics of the object as reported by Petrel

Return type

dict

set(amplitudes: Iterable[float], sampling_start: Optional[float] = None, sampling_interval: Optional[float] = None) → None

Replaces all the wavelet amplitude with the supplied values

Parameters

• amplitudes – a list of the amplitude values

• sampling_start – the starting values of the wavelet. Defaults to None.

• sampling_interval – the sampling interval of the wavelet. Defaults to None.

Raises

PythonToolException – Wavelet sampling interval must be positive

property amplitudes: numpy.array

Returns the amplitudes of the wavelet object as a numpy array

property comments

The comments on the PetrelObject.

Returns

The comments on the PetrelObject as a string.

Return type

string

property droid: str

The Petrel Droid (object id or guid) for the object

Returns the Petrel Droid or object id or guid for the object. If not available, will throw a PythonToolException.

This property is planned to be deprecated in favour of a similar but more general id schema in future releases.

Returns

The Petrel Droid of the object

Return type

str

property path: str

The path of this object in Petrel. Neither the Petrel name nor the path is guaranteed to be unique.

Returns

The path of the Petrel object

Return type

str

property petrel_name: str

Returns the name of this object in Petrel

property readonly: bool

The read-only status of this object

Returns

True if the object is read-only

Return type

bool

property sample_count: int

The number of samples contained in the Wavelet object.

Returns

The number of points in the wavelet.

property sample_points: numpy.ndarray

Returns the time values of the wavelet object as a numpy array

property sampling_start: float

Returns the first time value of the wavelet object as a float

property template: str

Returns the Petrel template for the object as a string. If no template available, will return an empty string.

property time_unit_symbol: str

Returns the time unit of the wavelet object