py3dinterpolations.core.griddata.GridData

class py3dinterpolations.core.griddata.GridData(data: DataFrame, ID: str = 'ID', X: str = 'X', Y: str = 'Y', Z: str = 'Z', V: str = 'V', preprocessor_params: dict = {})

Bases: object

GridData class

Class for 3D grid data.

As defaults, looks for X, Y, Z, V columns in the data. Otherwise, custom column names can be provided.

This object keeps track of the transformations (preprocessing) applied to the data, by storing the relative parameters in the preprocessor_params attribute.

Parameters

data (pd.DataFrame) – source data
ID (str) – column name of the ID, default: “ID”
X (str) – column name of the X, default: “X”
Y (str) – column name of the Y, default: “Y”
Z (str) – column name of the Z, default: “Z”
V (str) – column name of the V, default: “V”
preprocessor_params (dict) – preprocessing parameters used by the Preprocessor object that has generated the initiated GridData object, default: {}

data

data in GridData.data standard

Type: pd.DataFrame

preprocessor_params

preprocessing parameters used by the Preprocessor object that has generated the initiated GridData object, default: {}

Type: dict

columns

column names mapping

Type: dict

Properties:: numpy_data (np.ndarray): numpy data of X,Y,Z,V specs (GridDataSpecs): specs of the GridData

Methods

__init__(data[, ID, X, Y, Z, V, ...])

Attributes

`columns`
`data`
`numpy_data`	get numpy data
`preprocessor_params`
`specs`	specs of the GridData

property numpy_data: ndarray

get numpy data

Returns: numpy data of X,Y,Z,V
Return type: np.ndarray

property specs

specs of the GridData

Initializes a GridDataSpecs object with the current GridData object to get the specs of the GridData

Returns: specs of the GridData
Return type: GridDataSpecs