.. _datautils:
.. public

Data Utilities
##############

General utilities for common data file manipulations




.. Desurvey Drill Hole Data
.. ========================
..
..
.. Desurvey Drillhole Class
.. ------------------------
.. .. autoclass:: pygeostat.datautils.desurvey.Drillhole
..
.. Get String with Drillhole Info
.. ++++++++++++++++++++++++++++++
.. .. automethod:: pygeostat.datautils.desurvey.Drillhole.__str__
..
.. Calculate Change in X
.. +++++++++++++++++++++
.. .. automethod:: pygeostat.datautils.desurvey.Drillhole.delx
..
.. Calculate Change in Y
.. +++++++++++++++++++++
.. .. automethod:: pygeostat.datautils.desurvey.Drillhole.dely
..
.. Calculate Change in Z
.. +++++++++++++++++++++
.. .. automethod:: pygeostat.datautils.desurvey.Drillhole.delz
..
.. Get XYZ at a Length Downhole
.. ++++++++++++++++++++++++++++
.. .. automethod:: pygeostat.datautils.desurvey.Drillhole.getxyz
..
..
.. Desurvey From and Tos
.. ---------------------
.. .. autofunction:: pygeostat.datautils.desurvey.set_desurvey
..
.. Populate Dataframe with Composite From and Tos
.. ----------------------------------------------
.. .. autofunction:: pygeostat.datautils.desurvey.get_desurvey
..
.. Populate Dataframe with Composite From and Tos
.. ----------------------------------------------
.. .. autofunction:: pygeostat.datautils.desurvey.set_comps
..
.. Populate Dataframe with Upscaled Composites
.. -------------------------------------------
.. .. autofunction:: pygeostat.datautils.desurvey.get_comps
..
.. Get Upscaled Composite From and Tos
.. -----------------------------------
.. .. autofunction:: pygeostat.datautils.desurvey.upscale_worker
..
.. Upscale Comps
.. -------------
.. .. autofunction:: pygeostat.datautils.desurvey.serial_upscale
..
.. Return Comps from DataFrame
.. ---------------------------
.. .. autofunction:: pygeostat.datautils.desurvey.serial_get_comps
..
.. Fast Composites
.. ---------------
.. .. autofunction:: pygeostat.datautils.desurvey.fast_comps
..
.. Write VTP File
.. --------------
.. .. autofunction:: pygeostat.datautils.desurvey.write_vtp




.. Extract Drill Holes From Block Model
.. ====================================
.. .. automodule:: pygeostat.datautils.drillmodel
..
.. Extract Single Drillhole
.. ------------------------
.. .. autofunction:: pygeostat.datautils.drillmodel.azidipdrill
..
.. Drill Block Model
.. -----------------
.. .. autofunction:: pygeostat.datautils.drillmodel.drillmodel




Making Labels
=============

Insert Realization Index
------------------------
.. autofunction:: pygeostat.datautils.labels.insert_real_idx

Make Labels
-----------
.. autofunction:: pygeostat.datautils.labels.make_labels




Assorted Utility Functions
==========================

Check Len of Gridded Ascii File
-------------------------------
.. autofunction:: pygeostat.datautils.utils.check_grid_file_size

Round to Significant Figures
----------------------------
.. autofunction:: pygeostat.datautils.utils.round_sigfig

Get Collocated Data from Grid
-----------------------------
.. autofunction:: pygeostat.datautils.utils.getcollocated

Get File Header
---------------
.. autofunction:: pygeostat.datautils.utils.fileheader

Convert Corrmat to GSLIB string for USGSIM
------------------------------------------
.. autofunction:: pygeostat.datautils.utils.corrmatstr

Get the 2D Slice of a 3D Grid
-----------------------------
.. autofunction:: pygeostat.datautils.utils.slicegrid

Get a Slice of a 3D Point Dataset
---------------------------------
.. autofunction:: pygeostat.datautils.utils.slicescatter

Get Absolute Filepath
---------------------
.. autofunction:: pygeostat.datautils.utils.fixpath

Test if Data is Numeric
-----------------------
.. autofunction:: pygeostat.datautils.utils.is_numeric

Ensure a Directory Exists
-------------------------
.. autofunction:: pygeostat.datautils.utils.ensure_dir

Ensure a Path-to-Directory Exists
---------------------------------
.. autofunction:: pygeostat.datautils.utils.ensure_path

Get the Euclidean Distance to the Nearest Sample
------------------------------------------------
.. autofunction:: pygeostat.datautils.utils.nearest_eucdist