:py:mod:`adi_py.xarray_accessors`
=========================================

.. py:module:: adi_py.xarray_accessors



Classes
~~~~~~~

.. autoapisummary::

   adi_py.xarray_accessors.ADIDataArrayAccessor
   adi_py.xarray_accessors.ADIDatasetAccessor





.. py:class:: ADIDataArrayAccessor(xarray_obj)

   
   Used to apply special ADI functions to an xarray data array (i.e., variable)
   with the namespace 'adi'






   .. rst-class:: section-separator

   Class Methods

   .. autoapisummary::
      :nosignatures:

       adi_py.xarray_accessors.ADIDataArrayAccessor.assign_coordinate_system
       adi_py.xarray_accessors.ADIDataArrayAccessor.assign_output_datastream
       adi_py.xarray_accessors.ADIDataArrayAccessor.nsamples
       adi_py.xarray_accessors.ADIDataArrayAccessor.source_ds_name
       adi_py.xarray_accessors.ADIDataArrayAccessor.source_var_name


   .. rst-class:: section-separator

   Method Descriptions

   .. py:method:: assign_coordinate_system(self, coordinate_system_name: str)


   .. py:method:: assign_output_datastream(self, output_datastream_name: str, variable_name_in_datastream: str = None)


   .. py:method:: nsamples(self) -> int
       :property:


   .. py:method:: source_ds_name(self) -> str
       :property:


   .. py:method:: source_var_name(self) -> str
       :property:




.. py:class:: ADIDatasetAccessor(xarray_obj)

   
   Used to apply special ADI functions to an xarray dataset with the
   namespace 'adi'






   .. rst-class:: section-separator

   Class Methods

   .. autoapisummary::
      :nosignatures:

       adi_py.xarray_accessors.ADIDatasetAccessor.add_qc_variable
       adi_py.xarray_accessors.ADIDatasetAccessor.add_variable
       adi_py.xarray_accessors.ADIDatasetAccessor.convert_units
       adi_py.xarray_accessors.ADIDatasetAccessor.drop_transform_metadata
       adi_py.xarray_accessors.ADIDatasetAccessor.drop_variables
       adi_py.xarray_accessors.ADIDatasetAccessor.get_companion_transform_variable_names
       adi_py.xarray_accessors.ADIDatasetAccessor.get_qc_variable
       adi_py.xarray_accessors.ADIDatasetAccessor.record_qc_results
       adi_py.xarray_accessors.ADIDatasetAccessor.variables_exist


   .. rst-class:: section-separator

   Method Descriptions

   .. py:method:: add_qc_variable(self, variable_name: str)


   .. py:method:: add_variable(self, variable_name: str, dim_names: List[str], data: numpy.ndarray, long_name: str = None, standard_name: str = None, units: str = None, valid_min=None, valid_max=None, missing_value: numpy.ndarray = None, fill_value=None)


   .. py:method:: convert_units(self, old_units: str, new_units: str, variable_names: List[str] = None, converter_function: Callable = None)


   .. py:method:: drop_transform_metadata(self, variable_names: List[str]) -> xarray.Dataset


   .. py:method:: drop_variables(self, variable_names: List[str]) -> xarray.Dataset


   .. py:method:: get_companion_transform_variable_names(self, variable_name: str) -> List[str]


   .. py:method:: get_qc_variable(self, variable_name: str)


   .. py:method:: record_qc_results(self, variable_name: str, bit_number: int = None, test_results: numpy.ndarray = None)


   .. py:method:: variables_exist(self, variable_names: List[str] = []) -> numpy.ndarray