ModeBasis
=========

.. currentmodule:: hcipy.mode_basis

.. autoclass:: ModeBasis
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~ModeBasis.is_dense
      ~ModeBasis.is_sparse
      ~ModeBasis.num_modes
      ~ModeBasis.orthogonalized
      ~ModeBasis.transformation_matrix

   .. rubric:: Methods Summary

   .. autosummary::

      ~ModeBasis.append
      ~ModeBasis.coefficients_for
      ~ModeBasis.extend
      ~ModeBasis.from_dict
      ~ModeBasis.linear_combination
      ~ModeBasis.to_dense
      ~ModeBasis.to_dict
      ~ModeBasis.to_sparse

   .. rubric:: Attributes Documentation

   .. autoattribute:: is_dense
   .. autoattribute:: is_sparse
   .. autoattribute:: num_modes
   .. autoattribute:: orthogonalized
   .. autoattribute:: transformation_matrix

   .. rubric:: Methods Documentation

   .. automethod:: append
   .. automethod:: coefficients_for
   .. automethod:: extend
   .. automethod:: from_dict
   .. automethod:: linear_combination
   .. automethod:: to_dense
   .. automethod:: to_dict
   .. automethod:: to_sparse