itm.grid.data - Accessing data fields

The module :module:`itm.grid.data` contains the classes for working with data that is stored CPO fields using the general grid description.

Contents

• itm.grid.data - Accessing data fields
  • itm.grid.base.ScalarData - Scalar data fields
    • Obtaining the ScalarData object
    • Getting values
    • Detailed class documentation for itm.grid.data.ScalarData
  • itm.grid.base.ScalarData - Lists of scalar data fields
    • Obtaining the ScalarDataList object
    • Getting values
    • Detailed class documentation for itm.grid.data.ScalarDataList

itm.grid.base.ScalarData - Scalar data fields

Obtaining the ScalarData object

Getting values

Detailed class documentation for itm.grid.data.ScalarData

class itm.grid.data.ScalarData(cpo, data, path=None)

Wraps a complexgrid_scalar data structure to provide high-level operations.

__init__(cpo, data, path=None)

__str__()

cpo

data

path

grid

Return grid for this data object.

subgrid_index

Return subgrid index for this data object.

subgrid

Return subgrid for this data object.

values

Return the data for this scalar data field. Depending on the data representation a 1d, 2d or 3d numpy array is returned, with one value/vector/matrix per object in the associated subgrid.

values_for_objects(objs)

Return values of this data object for a sequence of objects as 1d numpy array.

If for any of the object no data is available, None is returned.

__module__ = 'itm.grid.data'

itm.grid.base.ScalarData - Lists of scalar data fields

Obtaining the ScalarDataList object

Getting values

Detailed class documentation for itm.grid.data.ScalarDataList

class itm.grid.data.ScalarDataList(cpo, dataList, path=None)

Wrap a list of complexgrid_scalar data structures to provide high-level operations.

__init__(cpo, dataList, path=None)

__len__()

__getitem__(key)

__str__()

cpo

data_list

path

for_subgrid_index(sgInd)

for_subgrid_id(sgId)

values_for_objects(objs)

Return data values for the given objects. If values for the objects are stored in multiple entries of the data list, the data from the first entry that can serve all objects is returned. If no data entry is found that can serve all objects, None is returned.

__module__ = 'itm.grid.data'