cigvis package

Subpackages

• cigvis.gui package
  • Subpackages
    • cigvis.gui.gui2d package
      • Submodules
      • Module contents
    • cigvis.gui.gui3d package
      • Submodules
      • Module contents
  • Submodules
    • cigvis.gui.custom_widgets module
  • Module contents
• cigvis.io package
  • Submodules
    • cigvis.io.fault_skin module
      • idx()
      • load_one_skin()
      • load_skins()
    • cigvis.io.horiz module
      • convert()
    • cigvis.io.las module
      • load_las()
    • cigvis.io.vds module
      • VDSReader
      • create_vds_from_array()
  • Module contents
• cigvis.meshs package
  • Submodules
    • cigvis.meshs.indicator module
      • default_north_pointer()
      • north_pointer_mesh()
      • petrel_north_pointer()
    • cigvis.meshs.merge module
      • merge_meshs()
    • cigvis.meshs.points module
      • cube_points()
      • regular_poly_points()
    • cigvis.meshs.surfaces module
      • arbline2mesh()
      • surface2mesh()
    • cigvis.meshs.well_logs module
      • curves_mesh()
      • rotate()
      • trajectory_mesh()
  • Module contents
• cigvis.utils package
  • Submodules
    • cigvis.utils.coord module
      • apply_transform()
      • get_transform_metrix()
    • cigvis.utils.maskutils module
      • surf_to_mask()
    • cigvis.utils.plotlyutils module
      • get_image_func()
      • kwargs_toaxies()
      • kwargs_todict()
      • make_3Dscene()
      • make_slices()
      • make_triang()
      • make_xyz()
      • verifyshape()
    • cigvis.utils.surfaceutils module
      • arbitray_line()
      • extract_data()
      • fill_grid()
      • interp_arb()
      • interp_linefirst_impl()
      • interp_surf()
      • interp_timefirst_impl()
      • interpolate_path()
      • preproc_surf_array2()
      • preproc_surf_array3()
      • preproc_surf_pos()
    • cigvis.utils.utils module
      • auto_clim()
      • check_mmap()
      • deprecated()
      • get_shape()
      • is_torch_tensor()
      • mmap_max()
      • mmap_min()
      • nmax()
      • nmin()
    • cigvis.utils.vispyutils module
      • get_valid_kwargs()
      • init_cbar_region_ratio()
      • set_canvas_size()
      • valid_kwargs()
  • Module contents
• cigvis.visernodes package
  • Submodules
    • cigvis.visernodes.meshnode module
      • ArbLineNode
      • MeshNode
      • SurfaceNode
      • color2textual()
      • color_f2i()
      • color_i2f()
    • cigvis.visernodes.server module
      • Server
      • update_clim()
      • update_cmap()
      • update_mask_cmap()
    • cigvis.visernodes.volume_slice module
      • PosObserver
      • VolumeSlice
    • cigvis.visernodes.well_log module
      • LogBase
      • LogLineSegments
      • LogPoints
  • Module contents
• cigvis.vispynodes package
  • Submodules
    • cigvis.vispynodes.axis3d module
      • Axis3D
    • cigvis.vispynodes.axis_aligned_image module
      • AxisAlignedImage
      • InteractiveLine
      • get_image_func()
    • cigvis.vispynodes.canvas_mixin module
      • AxisMixin
      • EventMixin
      • LightMixin
    • cigvis.vispynodes.colorbar module
      • Colorbar
    • cigvis.vispynodes.fixed_image module
      • FixedImage
    • cigvis.vispynodes.indicator module
      • FixMixin
      • NorthPointer
      • Units
      • XYZAxis
    • cigvis.vispynodes.meshnode module
      • ArbLineNode
      • SurfaceNode
    • cigvis.vispynodes.vis_canvas module
      • VisCanvas
    • cigvis.vispynodes.volume_slices module
      • volume_slices()
    • cigvis.vispynodes.well_log module
      • WellLog
      • make_triangle_line()
      • make_triangle_tube()
  • Module contents

Submodules

• cigvis.colormap module
  • Tools for colormap
  • arrs_to_image()
  • blend_multiple()
  • blend_two_arrays()
  • cmap_to_mpl()
  • cmap_to_plotly()
  • cmap_to_vispy()
  • custom_disc_cmap()
  • discrete_cmap()
  • fast_set_cmap()
  • get_cmap_from_str()
  • get_colors_from_cmap()
  • get_custom_cmap()
  • list_custom_cmap()
  • plot_all_custom_cmap()
  • plot_cmap()
  • ramp()
  • reversed()
  • set_alpha()
  • set_alpha_except_bottom()
  • set_alpha_except_max()
  • set_alpha_except_min()
  • set_alpha_except_ranges()
  • set_alpha_except_top()
  • set_alpha_except_values()
  • set_down_as()
  • set_up_as()
• cigvis.colors module
  • view_colors()
• cigvis.config module
  • global configs
  • is_axis_reversed()
  • is_line_first()
  • is_x_reversed()
  • is_y_reversed()
  • is_z_reversed()
  • set_axis_reversed()
  • set_order()
  • set_x_reversed()
  • set_y_reversed()
  • set_z_reversed()
• cigvis.customcmap module
• cigvis.mpl1dplot module
  • Functions for plotting 1D data using matplotlib
  • plot1_with_fill()
  • plot1d()
  • plot_multi_traces()
  • plot_signal_compare()
• cigvis.mpl2dplot module
  • Functions for plotting 2D data using matplotlib
  • annotate_args()
  • discrete_cbar()
  • fg_image_args()
  • flattened_view()
  • line_args()
  • marker_args()
  • plot2d()
• cigvis.mplstyle module
  • load_theme
    • load_theme.parse_style_string()
    • load_theme.set_label_font()
    • load_theme.set_legend_font()
    • load_theme.set_minor_ticks()
    • load_theme.set_tick_font()
    • load_theme.set_title_font()
    • load_theme.using_hncb()
  • set_label_font()
  • set_legend_font()
  • set_minor_ticks()
  • set_mixed_fonts()
  • set_tick_font()
  • set_title_font()
• cigvis.plotlyplot module
  • Functions for drawing 3D seismic figure using plotly
  • Note
  • Examples
  • add_mask()
  • create_Line_logs()
  • create_bodys()
  • create_fault_skin()
  • create_overlay()
  • create_points()
  • create_slices()
  • create_surfaces()
  • create_well_logs()
  • plot3D()
• cigvis.tools module
  • extract_arbitrary_line_by_view()
• cigvis.viserplot module
  • add_mask()
  • create_server()
  • create_slices()
  • create_surfaces()
  • create_well_logs()
  • link_servers()
  • plot3D()
  • run()
• cigvis.vispyplot module
  • Functions for drawing 3D seismic figure using vispy
  • Note
  • add_mask()
  • create_Line_logs()
  • create_arbitrary_line()
  • create_axis()
  • create_bodys()
  • create_colorbar()
  • create_colorbar_from_nodes()
  • create_fault_skin()
  • create_overlay()
  • create_points()
  • create_slices()
  • create_surfaces()
  • create_well_logs()
  • plot3D()
  • run()
  • set_surface_color_by_slices_nodes()

Module contents

CIGVis - a tool for visualizing multidimensional geophysical data

cigvis is a tool for visualizing multidimensional geophysical data, developed by the Computational Interpretation Group (CIG). Users can quickly visualize data with just a few lines of code.

cigvis can be used for various geophysical data visualizations, including 3D seismic data, overlays of seismic data with other information like labels, faults, RGT, horizon surfaces, well log trajectories, and well log curves, 3D geological bodies, 2D data, and 1D data, among others. Its GitHub repository can be found at github.com/JintaoLee-Roger/cigvis, and documentation is available at https://cigvis.readthedocs.io/ <https://cigvis.readthedocs.io/>.

cigvis leverages the power of underlying libraries such as vispy for 3D visualization, matplotlib for 2D and 1D visualization, and plotly for Jupyter environments (work in progress). The 3D visualization component is heavily based on the code from yunzhishi/seismic-canvas and has been further developed upon this foundation.

class cigvis.ExceptionWrapper(e, custom='')

Bases: object

Copy from trimesh.exceptions.ExceptionWrapper

Create a dummy object which will raise an exception when attributes are accessed (i.e. when used as a module) or when called (i.e. when used like a function)

For soft dependencies we want to survive failing to import but we would like to raise an appropriate error when the functionality is actually requested so the user gets an easily debuggable message.

cigvis.is_running_in_notebook()