:py:mod:`pygsti.models.modelparaminterposer`
============================================

.. py:module:: pygsti.models.modelparaminterposer

.. autoapi-nested-parse::

   Defines the ModelParamsInterposer class and supporting functionality.






Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   pygsti.models.modelparaminterposer.ModelParamsInterposer
   pygsti.models.modelparaminterposer.LinearInterposer




.. py:class:: ModelParamsInterposer(num_params, num_op_params)


   Bases: :py:obj:`pygsti.baseobjs.nicelyserializable.NicelySerializable`

   A function class that sits in between an :class:`OpModel`'s parameter vector and those of its operations.

   .. py:attribute:: num_params

      

   .. py:attribute:: num_op_params

      

   .. py:method:: model_paramvec_to_ops_paramvec(v)


   .. py:method:: ops_paramvec_to_model_paramvec(w)


   .. py:method:: ops_paramlbls_to_model_paramlbls(w)


   .. py:method:: deriv_op_params_wrt_model_params()


   .. py:method:: ops_params_dependent_on_model_params(model_param_indices)



.. py:class:: LinearInterposer(transform_matrix)


   Bases: :py:obj:`ModelParamsInterposer`

   Model parameters are linear combinations of operation parameters.

   FUTURE possibility:
   Also includes functionality for taking square/sqrt of parameters
   to be compatible with cases where the "true" parameter we want to
   include in the linear combination is the square of an actual parameter
   (to constrain it to being positive).

   .. py:attribute:: transform_matrix

      

   .. py:attribute:: inv_transform_matrix

      

   .. py:method:: model_paramvec_to_ops_paramvec(v)


   .. py:method:: ops_paramvec_to_model_paramvec(w)


   .. py:method:: ops_paramlbls_to_model_paramlbls(wl)


   .. py:method:: deriv_op_params_wrt_model_params()


   .. py:method:: ops_params_dependent_on_model_params(model_param_indices)

      TODO: docstring: returns the indices of op parameters that are influenced by the given model params