API Reference
- Surfaces (maps)
- RegularSurface
- Functions
- Classes
RegularSurfaceRegularSurface.__init__()RegularSurface.add()RegularSurface.add_inside()RegularSurface.add_outside()RegularSurface.autocrop()RegularSurface.avg_from_3dprop()RegularSurface.coarsen()RegularSurface.compare_topology()RegularSurface.copy()RegularSurface.dataframe()RegularSurface.describe()RegularSurface.dimensionsRegularSurface.distance_from_point()RegularSurface.div_inside()RegularSurface.div_outside()RegularSurface.divide()RegularSurface.dtypeRegularSurface.eli_inside()RegularSurface.eli_outside()RegularSurface.filesrcRegularSurface.fill()RegularSurface.generate_hash()RegularSurface.get_boundary_polygons()RegularSurface.get_dataframe()RegularSurface.get_fence()RegularSurface.get_ij_values()RegularSurface.get_ij_values1d()RegularSurface.get_map_xycorners()RegularSurface.get_nx()RegularSurface.get_ny()RegularSurface.get_randomline()RegularSurface.get_rotation()RegularSurface.get_value_from_xy()RegularSurface.get_values1d()RegularSurface.get_xinc()RegularSurface.get_xori()RegularSurface.get_xy_value_from_ij()RegularSurface.get_xy_value_lists()RegularSurface.get_xy_values()RegularSurface.get_xy_values1d()RegularSurface.get_xyz_values()RegularSurface.get_xyz_values1d()RegularSurface.get_yinc()RegularSurface.get_yori()RegularSurface.gridding()RegularSurface.hc_thickness_from_3dprops()RegularSurface.ilinesRegularSurface.load_values()RegularSurface.make_lefthanded()RegularSurface.make_righthanded()RegularSurface.metadataRegularSurface.methods()RegularSurface.mul_inside()RegularSurface.mul_outside()RegularSurface.multiply()RegularSurface.nactiveRegularSurface.nameRegularSurface.ncolRegularSurface.npvalues1dRegularSurface.nrowRegularSurface.operation()RegularSurface.operation_polygons()RegularSurface.quickplot()RegularSurface.refine()RegularSurface.resample()RegularSurface.rotationRegularSurface.set_inside()RegularSurface.set_outside()RegularSurface.set_values1d()RegularSurface.similarity_index()RegularSurface.slice_cube()RegularSurface.slice_cube_window()RegularSurface.slice_grid3d()RegularSurface.smooth()RegularSurface.sub_inside()RegularSurface.sub_outside()RegularSurface.subtract()RegularSurface.swapaxes()RegularSurface.to_file()RegularSurface.to_hdf()RegularSurface.to_roxar()RegularSurface.translate_coordinates()RegularSurface.undefRegularSurface.undef_limitRegularSurface.unrotate()RegularSurface.valuesRegularSurface.values1dRegularSurface.xincRegularSurface.xlinesRegularSurface.xmaxRegularSurface.xminRegularSurface.xoriRegularSurface.yflipRegularSurface.yincRegularSurface.ymaxRegularSurface.yminRegularSurface.yori
- Surfaces
- RegularSurface
- Points and Polygons
- Points
- Functions
- Classes
PointsPoints.__init__()Points.add_inside()Points.add_inside_polygons()Points.add_outside()Points.add_outside_polygons()Points.copy()Points.dataframePoints.delete_columns()Points.describe()Points.div_inside()Points.div_inside_polygons()Points.div_outside()Points.div_outside_polygons()Points.eli_inside()Points.eli_inside_polygons()Points.eli_outside()Points.eli_outside_polygons()Points.geometry_columns()Points.get_boundary()Points.get_dataframe()Points.get_nwells()Points.get_xyz_arrays()Points.mark_in_polygons()Points.mul_inside()Points.mul_inside_polygons()Points.mul_outside()Points.mul_outside_polygons()Points.nrowPoints.operation_polygons()Points.protected_columns()Points.set_dataframe()Points.set_inside()Points.set_inside_polygons()Points.set_outside()Points.set_outside_polygons()Points.snap_surface()Points.sub_inside()Points.sub_inside_polygons()Points.sub_outside()Points.sub_outside_polygons()Points.to_file()Points.to_roxar()Points.xnamePoints.xyztypePoints.ynamePoints.zname
- Polygons
- Functions
- Classes
PolygonsPolygons.__init__()Polygons.add_inside()Polygons.add_inside_polygons()Polygons.add_outside()Polygons.add_outside_polygons()Polygons.boundary_from_points()Polygons.copy()Polygons.dataframePolygons.delete_columns()Polygons.describe()Polygons.dhnamePolygons.div_inside()Polygons.div_inside_polygons()Polygons.div_outside()Polygons.div_outside_polygons()Polygons.dtnamePolygons.eli_inside()Polygons.eli_inside_polygons()Polygons.eli_outside()Polygons.eli_outside_polygons()Polygons.extend()Polygons.filter_byid()Polygons.geometry_columns()Polygons.get_boundary()Polygons.get_dataframe()Polygons.get_fence()Polygons.get_nwells()Polygons.get_shapely_objects()Polygons.get_xyz_arrays()Polygons.get_xyz_dataframe()Polygons.hlen()Polygons.hnamePolygons.mark_in_polygons()Polygons.mul_inside()Polygons.mul_inside_polygons()Polygons.mul_outside()Polygons.mul_outside_polygons()Polygons.namePolygons.nrowPolygons.operation_polygons()Polygons.pnamePolygons.protected_columns()Polygons.quickplot()Polygons.rescale()Polygons.set_dataframe()Polygons.set_inside()Polygons.set_inside_polygons()Polygons.set_outside()Polygons.set_outside_polygons()Polygons.simplify()Polygons.sub_inside()Polygons.sub_inside_polygons()Polygons.sub_outside()Polygons.sub_outside_polygons()Polygons.tlen()Polygons.tnamePolygons.to_file()Polygons.to_roxar()Polygons.xnamePolygons.xyztypePolygons.ynamePolygons.zname
- Points
- Wells
- Well (single)
- Functions
- Classes
WellWell.__init__()Well.copy()Well.copy_log()Well.create_log()Well.create_relative_hlen()Well.create_surf_distance_log()Well.dataframeWell.delete_log()Well.delete_logs()Well.describe()Well.downsample()Well.ensure_consistency()Well.geometrics()Well.get_dataframe()Well.get_fence_polyline()Well.get_filled_dataframe()Well.get_fraction_per_zone()Well.get_gridproperties()Well.get_lognames()Well.get_logrecord()Well.get_logrecord_codename()Well.get_logtype()Well.get_polygons()Well.get_short_wellname()Well.get_surface_picks()Well.get_wlogs()Well.get_zonation_points()Well.get_zone_interval()Well.isdiscrete()Well.limit_tvd()Well.lognamesWell.lognames_allWell.make_ijk_from_grid()Well.make_zone_qual_log()Well.mask_shoulderbeds()Well.may_overlap()Well.mdlognameWell.metadataWell.nameWell.ncolWell.nlogsWell.nrowWell.rename_log()Well.report_zonation_holes()Well.rescale()Well.rkbWell.safewellnameWell.set_dataframe()Well.set_logrecord()Well.set_logtype()Well.set_wlogs()Well.shortwellnameWell.to_file()Well.to_hdf()Well.to_roxar()Well.truewellnameWell.truncate_parallel_path()Well.wellnameWell.wlogrecordsWell.wlogtypesWell.wnameWell.xnameWell.xposWell.xwellnameWell.ynameWell.yposWell.znameWell.zonelogname
- Wells (multiple)
- Blocked well (single)
- Functions
- Classes
BlockedWellBlockedWell.__init__()BlockedWell.copy()BlockedWell.copy_log()BlockedWell.create_log()BlockedWell.create_relative_hlen()BlockedWell.create_surf_distance_log()BlockedWell.dataframeBlockedWell.delete_log()BlockedWell.delete_logs()BlockedWell.describe()BlockedWell.downsample()BlockedWell.ensure_consistency()BlockedWell.geometrics()BlockedWell.get_dataframe()BlockedWell.get_fence_polyline()BlockedWell.get_filled_dataframe()BlockedWell.get_fraction_per_zone()BlockedWell.get_gridproperties()BlockedWell.get_lognames()BlockedWell.get_logrecord()BlockedWell.get_logrecord_codename()BlockedWell.get_logtype()BlockedWell.get_polygons()BlockedWell.get_short_wellname()BlockedWell.get_surface_picks()BlockedWell.get_wlogs()BlockedWell.get_zonation_points()BlockedWell.get_zone_interval()BlockedWell.gridnameBlockedWell.isdiscrete()BlockedWell.limit_tvd()BlockedWell.lognamesBlockedWell.lognames_allBlockedWell.make_ijk_from_grid()BlockedWell.make_zone_qual_log()BlockedWell.mask_shoulderbeds()BlockedWell.may_overlap()BlockedWell.mdlognameBlockedWell.metadataBlockedWell.nameBlockedWell.ncolBlockedWell.nlogsBlockedWell.nrowBlockedWell.rename_log()BlockedWell.report_zonation_holes()BlockedWell.rescale()BlockedWell.rkbBlockedWell.safewellnameBlockedWell.set_dataframe()BlockedWell.set_logrecord()BlockedWell.set_logtype()BlockedWell.set_wlogs()BlockedWell.shortwellnameBlockedWell.to_file()BlockedWell.to_hdf()BlockedWell.to_roxar()BlockedWell.truewellnameBlockedWell.truncate_parallel_path()BlockedWell.wellnameBlockedWell.wlogrecordsBlockedWell.wlogtypesBlockedWell.wnameBlockedWell.xnameBlockedWell.xposBlockedWell.xwellnameBlockedWell.ynameBlockedWell.yposBlockedWell.znameBlockedWell.zonelogname
- Blocked wells (multiple)
- Well (single)
- Cubes (e.g. seismic)
- Cube
- Functions
- Classes
CubeCube.__init__()Cube.compute_attributes_in_window()Cube.copy()Cube.describe()Cube.dimensionsCube.do_cropping()Cube.do_thinning()Cube.filesrcCube.generate_hash()Cube.get_randomline()Cube.get_xy_value_from_ij()Cube.ilinesCube.metadataCube.ncolCube.nlayCube.nrowCube.resample()Cube.rotationCube.segyfileCube.swapaxes()Cube.to_file()Cube.to_roxar()Cube.traceidcodesCube.valuesCube.values_dead_traces()Cube.xincCube.xlinesCube.xoriCube.yflipCube.yincCube.yoriCube.zflipCube.zincCube.zoriCube.zslices
- Cube
- 3D grids and properties
- Grid
- Functions
- Classes
GridGrid.__init__()Grid.activate_all()Grid.actnum_arrayGrid.actnum_indicesGrid.append_prop()Grid.collapse_inactive_cells()Grid.convert_to_hybrid()Grid.convert_units()Grid.copy()Grid.crop()Grid.describe()Grid.dimensionsGrid.dualpermGrid.dualporoGrid.estimate_design()Grid.estimate_flip()Grid.filesrcGrid.generate_hash()Grid.get_actnum()Grid.get_actnum_indices()Grid.get_adjacent_cells()Grid.get_boundary_polygons()Grid.get_bounding_box()Grid.get_bulk_volume()Grid.get_cell_volume()Grid.get_dataframe()Grid.get_dualactnum_indices()Grid.get_dx()Grid.get_dy()Grid.get_dz()Grid.get_geometrics()Grid.get_gridquality_properties()Grid.get_heights_above_ffl()Grid.get_ijk()Grid.get_ijk_from_points()Grid.get_layer_slice()Grid.get_onelayer_grid()Grid.get_prop_by_name()Grid.get_property_between_surfaces()Grid.get_randomline()Grid.get_subgrids()Grid.get_vtk_esg_geometry_data()Grid.get_vtk_geometries()Grid.get_xyz()Grid.get_xyz_cell_corners()Grid.get_xyz_corners()Grid.get_zoneprop_from_subgrids()Grid.gridpropsGrid.ijk_handednessGrid.inactivate_by_dz()Grid.inactivate_inside()Grid.inactivate_outside()Grid.make_zconsistent()Grid.metadataGrid.nactiveGrid.nameGrid.ncolGrid.nlayGrid.nrowGrid.ntotalGrid.propnamesGrid.propsGrid.reduce_to_one_layer()Grid.refine()Grid.refine_vertically()Grid.rename_subgrids()Grid.report_zone_mismatch()Grid.reverse_row_axis()Grid.roxgridGrid.roxindexerGrid.set_actnum()Grid.set_subgrids()Grid.subgridsGrid.subgrids_from_zoneprop()Grid.to_file()Grid.to_hdf()Grid.to_roxar()Grid.to_xtgf()Grid.translate_coordinates()Grid.vectordimensions
- Grid property (single)
- Functions
- Classes
GridPropertyGridProperty.__init__()GridProperty.actnum_indicesGridProperty.add_inside()GridProperty.add_outside()GridProperty.codesGridProperty.continuous_to_discrete()GridProperty.copy()GridProperty.crop()GridProperty.dateGridProperty.describe()GridProperty.dimensionsGridProperty.discrete_to_continuous()GridProperty.div_inside()GridProperty.div_outside()GridProperty.dtypeGridProperty.ensure_correct_values()GridProperty.filesrcGridProperty.generate_hash()GridProperty.geometryGridProperty.get_active_npvalues1d()GridProperty.get_actnum()GridProperty.get_npvalues1d()GridProperty.get_npvalues3d()GridProperty.get_values_by_ijk()GridProperty.get_xy_value_lists()GridProperty.isdiscreteGridProperty.mask_undef()GridProperty.metadataGridProperty.methods()GridProperty.mul_inside()GridProperty.mul_outside()GridProperty.nactiveGridProperty.nameGridProperty.ncodesGridProperty.ncolGridProperty.nlayGridProperty.nrowGridProperty.ntotalGridProperty.operation_polygons()GridProperty.roxar_dtypeGridProperty.roxoriginGridProperty.set_inside()GridProperty.set_outside()GridProperty.sub_inside()GridProperty.sub_outside()GridProperty.to_file()GridProperty.to_roxar()GridProperty.undefGridProperty.undef_limitGridProperty.valuesGridProperty.values1d
- Grid properties (multiple)
- Classes
GridPropertiesGridProperties.__init__()GridProperties.append_props()GridProperties.copy()GridProperties.datesGridProperties.describe()GridProperties.generate_hash()GridProperties.get_actnum()GridProperties.get_dataframe()GridProperties.get_ijk()GridProperties.get_prop_by_name()GridProperties.namesGridProperties.ncolGridProperties.nlayGridProperties.nrowGridProperties.propsGridProperties.scan_dates()
- Classes
- Grid
- Other APIs
- Roxar utilities
- RoxUtils
RoxUtilsRoxUtils.__init__()RoxUtils.clear_horizon_category()RoxUtils.clear_zone_category()RoxUtils.create_horizons_category()RoxUtils.create_zones_category()RoxUtils.delete_horizons_category()RoxUtils.delete_zones_category()RoxUtils.projectRoxUtils.rmsversion()RoxUtils.roxversionRoxUtils.safe_close()RoxUtils.version_required()
- RoxUtils
- Metadata (experimental)
- Roxar utilities