<html class="writer-html5" lang="en" data-content_root="./">

<meta charset="utf-8" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>Index &mdash; diffpy.utils 3.7.2 documentation</title>

<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />

<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />

<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />

<script src="_static/jquery.js?v=5d32c60e"></script>

<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>

<script src="_static/documentation_options.js?v=07dc2002"></script>

<script src="_static/doctools.js?v=fd6eb6e6"></script>

<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>

<script src="_static/clipboard.min.js?v=a7894cd8"></script>

<script src="_static/copybutton.js?v=cca77546"></script>

<script src="_static/js/theme.js"></script>

<link rel="index" title="Index" href="#" />

<link rel="search" title="Search" href="search.html" />

<body class="wy-body-for-nav">

<div class="wy-grid-for-nav">

<nav data-toggle="wy-nav-shift" class="wy-nav-side">

<div class="wy-side-scroll">

<div class="wy-side-nav-search" >

<a href="index.html" class="icon icon-home">

diffpy.utils

</a>

<div role="search">

<form id="rtd-search-form" class="wy-form" action="search.html" method="get">

<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />

<input type="hidden" name="check_keywords" value="yes" />

<input type="hidden" name="area" value="default" />

</form>

</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">

<ul>

<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>

<li class="toctree-l1"><a class="reference internal" href="release.html">Release notes</a></li>

<li class="toctree-l1"><a class="reference internal" href="utilities/utilities.html">Utilities</a></li>

<li class="toctree-l1"><a class="reference internal" href="examples/examples.html">Examples</a></li>

<li class="toctree-l1"><a class="reference internal" href="api/diffpy.utils.html">Package API</a></li>

</div>

</div>

</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >

<i data-toggle="wy-nav-top" class="fa fa-bars"></i>

<a href="index.html">diffpy.utils</a>

</nav>

<div class="wy-nav-content">

<div class="rst-content">

<div role="navigation" aria-label="Page navigation">

<ul class="wy-breadcrumbs">

<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>

<li class="breadcrumb-item active">Index</li>

<li class="wy-breadcrumbs-aside">

<a href="https://github.com/diffpy/diffpy.utils/blob/main/docs/source/genindex" class="fa fa-github"> Edit on GitHub</a>

</li>

</ul>

<hr/>

<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">

<div itemprop="articleBody">

<h1 id="index">Index</h1>

<div class="genindex-jumpbox">

<a href="#A"><strong>A</strong></a>

| <a href="#B"><strong>B</strong></a>

| <a href="#C"><strong>C</strong></a>

| <a href="#D"><strong>D</strong></a>

| <a href="#G"><strong>G</strong></a>

| <a href="#I"><strong>I</strong></a>

| <a href="#L"><strong>L</strong></a>

| <a href="#M"><strong>M</strong></a>

| <a href="#N"><strong>N</strong></a>

| <a href="#O"><strong>O</strong></a>

| <a href="#Q"><strong>Q</strong></a>

| <a href="#R"><strong>R</strong></a>

| <a href="#S"><strong>S</strong></a>

| <a href="#T"><strong>T</strong></a>

| <a href="#U"><strong>U</strong></a>

| <a href="#W"><strong>W</strong></a>

<h2 id="A">A</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.all_arrays">all_arrays (diffpy.utils.diffraction_objects.DiffractionObject property)</a>

</ul></td>

<h2 id="B">B</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils._deprecator.build_deprecation_message">build_deprecation_message() (in module diffpy.utils._deprecator)</a>

</ul></td>

<h2 id="C">C</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.tools.check_and_build_global_config">check_and_build_global_config() (in module diffpy.utils.tools)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.tools.compute_mu_using_xraydb">compute_mu_using_xraydb() (in module diffpy.utils.tools)</a>

</ul></td>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.tools.compute_mud">compute_mud() (in module diffpy.utils.tools)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.copy">copy() (diffpy.utils.diffraction_objects.DiffractionObject method)</a>

</ul></td>

<h2 id="D">D</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.transforms.d_to_q">d_to_q() (in module diffpy.utils.transforms)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.transforms.d_to_tth">d_to_tth() (in module diffpy.utils.transforms)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils._deprecator.deprecated">deprecated() (in module diffpy.utils._deprecator)</a>

<li><a href="api/diffpy.utils.parsers.html#diffpy.utils.parsers.serialization.deserialize_data">deserialize_data() (in module diffpy.utils.parsers.serialization)</a>

<li>

diffpy.utils

<ul>

<li><a href="api/diffpy.utils.html#module-diffpy.utils">module</a>

</ul></li>

<li>

diffpy.utils._deprecator

<ul>

<li><a href="api/diffpy.utils.html#module-diffpy.utils._deprecator">module</a>

</ul></li>

<li>

diffpy.utils.diffraction_objects

<ul>

<li><a href="api/diffpy.utils.html#module-diffpy.utils.diffraction_objects">module</a>

</ul></li>

<li>

diffpy.utils.parsers

<ul>

<li><a href="api/diffpy.utils.parsers.html#module-diffpy.utils.parsers">module</a>

</ul></li>

<li>

diffpy.utils.parsers.custom_exceptions

<ul>

<li><a href="api/diffpy.utils.parsers.html#module-diffpy.utils.parsers.custom_exceptions">module</a>

</ul></li>

<li>

diffpy.utils.parsers.loaddata

<ul>

<li><a href="api/diffpy.utils.parsers.html#module-diffpy.utils.parsers.loaddata">module</a>

</ul></li>

<li>

diffpy.utils.parsers.serialization

<ul>

<li><a href="api/diffpy.utils.parsers.html#module-diffpy.utils.parsers.serialization">module</a>

</ul></li>

</ul></td>

<td style="width: 33%; vertical-align: top;"><ul>

<li>

diffpy.utils.resampler

<ul>

<li><a href="api/diffpy.utils.html#module-diffpy.utils.resampler">module</a>

</ul></li>

<li>

diffpy.utils.tools

<ul>

<li><a href="api/diffpy.utils.html#module-diffpy.utils.tools">module</a>

</ul></li>

<li>

diffpy.utils.transforms

<ul>

<li><a href="api/diffpy.utils.html#module-diffpy.utils.transforms">module</a>

</ul></li>

<li>

diffpy.utils.utils_app

<ul>

<li><a href="api/diffpy.utils.html#module-diffpy.utils.utils_app">module</a>

</ul></li>

<li>

diffpy.utils.validators

<ul>

<li><a href="api/diffpy.utils.html#module-diffpy.utils.validators">module</a>

</ul></li>

<li>

diffpy.utils.wx

<ul>

<li><a href="api/diffpy.utils.wx.html#module-diffpy.utils.wx">module</a>

</ul></li>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject">DiffractionObject (class in diffpy.utils.diffraction_objects)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.dmax">dmax (diffpy.utils.diffraction_objects.DiffractionObject attribute)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.dmin">dmin (diffpy.utils.diffraction_objects.DiffractionObject attribute)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.dump">dump() (diffpy.utils.diffraction_objects.DiffractionObject method)</a>

</ul></td>

<h2 id="G">G</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils._deprecator.generate_deprecation_docstring">generate_deprecation_docstring() (in module diffpy.utils._deprecator)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.get_array_index">get_array_index() (diffpy.utils.diffraction_objects.DiffractionObject method)</a>

</ul></td>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.tools.get_density_from_cloud">get_density_from_cloud() (in module diffpy.utils.tools)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.tools.get_package_info">get_package_info() (in module diffpy.utils.tools)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.tools.get_user_info">get_user_info() (in module diffpy.utils.tools)</a>

</ul></td>

<h2 id="I">I</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.parsers.html#diffpy.utils.parsers.custom_exceptions.ImproperSizeError">ImproperSizeError</a>

</ul></td>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.input_xtype">input_xtype (diffpy.utils.diffraction_objects.DiffractionObject property)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.validators.is_number">is_number() (in module diffpy.utils.validators)</a>

</ul></td>

<h2 id="L">L</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="license.html#index-0">license</a>

<li><a href="api/diffpy.utils.parsers.html#diffpy.utils.parsers.load_data">load_data() (in module diffpy.utils.parsers)</a>

<ul>

<li><a href="api/diffpy.utils.parsers.html#diffpy.utils.parsers.loaddata.load_data">(in module diffpy.utils.parsers.loaddata)</a>

</ul></li>

</ul></td>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.parsers.html#diffpy.utils.parsers.loaddata.loadData">loadData() (in module diffpy.utils.parsers.loaddata)</a>

</ul></td>

<h2 id="M">M</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.utils_app.main">main() (in module diffpy.utils.utils_app)</a>

<li>

module

<ul>

<li><a href="api/diffpy.utils.html#module-diffpy.utils">diffpy.utils</a>

<li><a href="api/diffpy.utils.html#module-diffpy.utils._deprecator">diffpy.utils._deprecator</a>

<li><a href="api/diffpy.utils.html#module-diffpy.utils.diffraction_objects">diffpy.utils.diffraction_objects</a>

<li><a href="api/diffpy.utils.parsers.html#module-diffpy.utils.parsers">diffpy.utils.parsers</a>

<li><a href="api/diffpy.utils.parsers.html#module-diffpy.utils.parsers.custom_exceptions">diffpy.utils.parsers.custom_exceptions</a>

<li><a href="api/diffpy.utils.parsers.html#module-diffpy.utils.parsers.loaddata">diffpy.utils.parsers.loaddata</a>

<li><a href="api/diffpy.utils.parsers.html#module-diffpy.utils.parsers.serialization">diffpy.utils.parsers.serialization</a>

<li><a href="api/diffpy.utils.html#module-diffpy.utils.resampler">diffpy.utils.resampler</a>

<li><a href="api/diffpy.utils.html#module-diffpy.utils.tools">diffpy.utils.tools</a>

<li><a href="api/diffpy.utils.html#module-diffpy.utils.transforms">diffpy.utils.transforms</a>

<li><a href="api/diffpy.utils.html#module-diffpy.utils.utils_app">diffpy.utils.utils_app</a>

<li><a href="api/diffpy.utils.html#module-diffpy.utils.validators">diffpy.utils.validators</a>

<li><a href="api/diffpy.utils.wx.html#module-diffpy.utils.wx">diffpy.utils.wx</a>

</ul></li>

</ul></td>

<h2 id="N">N</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.name">name (diffpy.utils.diffraction_objects.DiffractionObject attribute)</a>

</ul></td>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.resampler.nsinterp">nsinterp() (in module diffpy.utils.resampler)</a>

</ul></td>

<h2 id="O">O</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.on_d">on_d() (diffpy.utils.diffraction_objects.DiffractionObject method)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.on_q">on_q() (diffpy.utils.diffraction_objects.DiffractionObject method)</a>

</ul></td>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.on_tth">on_tth() (diffpy.utils.diffraction_objects.DiffractionObject method)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.on_xtype">on_xtype() (diffpy.utils.diffraction_objects.DiffractionObject method)</a>

</ul></td>

<h2 id="Q">Q</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.transforms.q_to_d">q_to_d() (in module diffpy.utils.transforms)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.transforms.q_to_tth">q_to_tth() (in module diffpy.utils.transforms)</a>

</ul></td>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.qmax">qmax (diffpy.utils.diffraction_objects.DiffractionObject attribute)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.qmin">qmin (diffpy.utils.diffraction_objects.DiffractionObject attribute)</a>

</ul></td>

<h2 id="R">R</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.parsers.html#diffpy.utils.parsers.loaddata.TextDataLoader.read">read() (diffpy.utils.parsers.loaddata.TextDataLoader method)</a>

<li><a href="api/diffpy.utils.parsers.html#diffpy.utils.parsers.loaddata.TextDataLoader.readfp">readfp() (diffpy.utils.parsers.loaddata.TextDataLoader method)</a>

</ul></td>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="release.html#index-0">release notes</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.resampler.resample">resample() (in module diffpy.utils.resampler)</a>

</ul></td>

<h2 id="S">S</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.scale_to">scale_to() (diffpy.utils.diffraction_objects.DiffractionObject method)</a>

</ul></td>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.scat_quantity">scat_quantity (diffpy.utils.diffraction_objects.DiffractionObject attribute)</a>

<li><a href="api/diffpy.utils.parsers.html#diffpy.utils.parsers.serialization.serialize_data">serialize_data() (in module diffpy.utils.parsers.serialization)</a>

</ul></td>

<h2 id="T">T</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.parsers.html#diffpy.utils.parsers.loaddata.TextDataLoader">TextDataLoader (class in diffpy.utils.parsers.loaddata)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.transforms.tth_to_d">tth_to_d() (in module diffpy.utils.transforms)</a>

</ul></td>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.transforms.tth_to_q">tth_to_q() (in module diffpy.utils.transforms)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.tthmax">tthmax (diffpy.utils.diffraction_objects.DiffractionObject attribute)</a>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.tthmin">tthmin (diffpy.utils.diffraction_objects.DiffractionObject attribute)</a>

</ul></td>

<h2 id="U">U</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.parsers.html#diffpy.utils.parsers.custom_exceptions.UnsupportedTypeError">UnsupportedTypeError</a>

</ul></td>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.uuid">uuid (diffpy.utils.diffraction_objects.DiffractionObject property)</a>

</ul></td>

<h2 id="W">W</h2>

<table style="width: 100%" class="indextable genindextable"><tr>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.wavelength">wavelength (diffpy.utils.diffraction_objects.DiffractionObject attribute)</a>

</ul></td>

<td style="width: 33%; vertical-align: top;"><ul>

<li><a href="api/diffpy.utils.html#diffpy.utils.resampler.wsinterp">wsinterp() (in module diffpy.utils.resampler)</a>

</ul></td>

</div>

</div>

<footer>

<hr/>

<div role="contentinfo">

<p>&#169; Copyright 2026, The Trustees of Columbia University in the City of New York.</p>

</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>

provided by <a href="https://readthedocs.org">Read the Docs</a>.

</div>

</div>

</section>

</div>

<script>

jQuery(function () {

SphinxRtdTheme.Navigation.enable(true);

});

</script>