SimPEG.regularization.VectorAmplitude
=====================================

.. currentmodule:: SimPEG.regularization

.. autoclass:: VectorAmplitude
  :show-inheritance:

  
   .. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
      .. autosummary::
         :toctree:
      
         VectorAmplitude.__call__
         VectorAmplitude.__getitem__
         VectorAmplitude.__len__
         VectorAmplitude.__mul__
         VectorAmplitude.deriv
         VectorAmplitude.deriv2
         VectorAmplitude.get_functions_of_type
         VectorAmplitude.remove_weights
         VectorAmplitude.set_weights
         VectorAmplitude.test
         VectorAmplitude.update_weights
      
         VectorAmplitude.__call__
         VectorAmplitude.__len__
         VectorAmplitude.__mul__
         VectorAmplitude.__getitem__
  

  
  
   .. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
      .. autosummary::
         :toctree:
      
         VectorAmplitude.W
         VectorAmplitude.active_cells
         VectorAmplitude.alpha_s
         VectorAmplitude.alpha_x
         VectorAmplitude.alpha_xx
         VectorAmplitude.alpha_y
         VectorAmplitude.alpha_yy
         VectorAmplitude.alpha_z
         VectorAmplitude.alpha_zz
         VectorAmplitude.cell_weights
         VectorAmplitude.gradientType
         VectorAmplitude.gradient_type
         VectorAmplitude.indActive
         VectorAmplitude.irls_scaled
         VectorAmplitude.irls_threshold
         VectorAmplitude.length_scale_x
         VectorAmplitude.length_scale_y
         VectorAmplitude.length_scale_z
         VectorAmplitude.mapping
         VectorAmplitude.model
         VectorAmplitude.mref
         VectorAmplitude.multipliers
         VectorAmplitude.nP
         VectorAmplitude.norms
         VectorAmplitude.reference_model
         VectorAmplitude.reference_model_in_smooth
         VectorAmplitude.regularization_mesh
         VectorAmplitude.units
  
  

.. minigallery:: SimPEG.regularization.VectorAmplitude
    :add-heading: Galleries and Tutorials using ``SimPEG.regularization.VectorAmplitude``
    :heading-level: -