:py:mod:`odpy.seisman`
======================

.. py:module:: odpy.seisman


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   odpy.seisman.getSeismicDBList
   odpy.seisman.getName
   odpy.seisman.getDBKey
   odpy.seisman.get_file_location
   odpy.seisman.isPresent
   odpy.seisman.show_line
   odpy.seisman.ConvertSegy2Numpy



Attributes
~~~~~~~~~~

.. autoapisummary::

   odpy.seisman.seismanexe
   odpy.seisman.seisdbdirid
   odpy.seisman.seistrlgrp
   odpy.seisman.dgbtrl
   odpy.seisman.dblist


.. py:data:: seismanexe
   :annotation: = od_DBMan

   

.. py:data:: seisdbdirid
   :annotation: = 100010

   

.. py:data:: seistrlgrp
   :annotation: = Seismic Data

   

.. py:data:: dgbtrl
   :annotation: = dGB

   

.. py:data:: dblist
   

   

.. py:function:: getSeismicDBList(reload, args=None)

   Gets information on available seismics from database for a survey

   Parameters:
       * reload (boolean, optional): Force re-reading of the database files (no caching allowed)
       * args (dictionary, optional): Dictionary of optional parameters (see odpy.common).
           Default to None.

   Returns:
       dict: containing information on survey seismic (size, IDs, Names, Status, etc)


.. py:function:: getName(dbkey, args=None)

   Gets seismic name

   Parameters:
     * dbkey (str): seismic database key
     * reload (boolean, optional): Force re-reading of the database files
           (no caching allowed). Default to False
     * args (dictionary, optional): Dictionary of optional parameters (see common).
           Default to None.

   Returns:
     * str: seismic data name



.. py:function:: getDBKey(seisnm, reload=True, args=None)

   Gets well database key

   Parameters:
     * seisnm (str): seismic name
     * reload (boolean, optional): Force re-reading of the database files
           (no caching allowed). Default to False
     * args (dictionary, optional): Dictionary of optional parameters (see common).
           Default to None.

   Returns:
     str: Database key for seismic name provided


.. py:function:: get_file_location(dbname)

   Gets file location of seismic data

   Parameters:
       * dbname (str): seismic name

   Returns:
       str: full path to seismic data


.. py:function:: isPresent(dbname)

   Checks if seismic data exists in survey

   Parameters:
       dbname (str): seismic data name

   Returns:
       bool: True if seismic data is found in survey, False if otherwise


.. py:function:: show_line(data, ranges, figsize, inline=False, xline=False, Z=False)

   Displays 2D visualization of either inline, crossline, or Z/time slice

   Parameters:
       * data (array): 3d numpy array of data (time/depth, crossline, inline)
       * ranges (dict): specifying survey ranges (with keys inline, xline, Z)
       * figsize (tuple): width and height specifications for figure
       * inline, xline, Z (int): inline, xline, or time slice to be displayed

   Note: either inline or xline or Z can be displayed once. other dimensions retain their default
           False value when a dimension is selected/displayed

   Returns: None (figure is displayed)


.. py:function:: ConvertSegy2Numpy(filename: str)

   converts segy data to numpy array

   Parameters:
       * filename (str): path to segy data in sgy or segy, zgy format

   Returns:
       * ndarray: of segy data