flip.data_vector.basic
======================

.. py:module:: flip.data_vector.basic


Attributes
----------

.. autoapisummary::

   flip.data_vector.basic.jax_installed
   flip.data_vector.basic.log


Classes
-------

.. autoapisummary::

   flip.data_vector.basic.DataVector
   flip.data_vector.basic.Dens
   flip.data_vector.basic.DirectVel
   flip.data_vector.basic.DensVel
   flip.data_vector.basic.VelFromHDres
   flip.data_vector.basic.FisherVelMesh
   flip.data_vector.basic.FisherVelFromHDres
   flip.data_vector.basic.FisherDens
   flip.data_vector.basic.FisherDensVel


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

.. py:data:: jax_installed
   :value: True


.. py:data:: log

.. py:class:: DataVector(data, covariance_observation=None, **kwargs)

   Bases: :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: _free_par
      :value: []



   .. py:attribute:: _kind
      :value: ''



   .. py:property:: conditional_free_par


   .. py:property:: free_par


   .. py:property:: kind


   .. py:property:: conditional_needed_keys


   .. py:property:: needed_keys


   .. py:property:: data


   .. py:method:: give_data_and_variance(**kwargs)
      :abstractmethod:



   .. py:method:: _check_keys(data)


   .. py:attribute:: _covariance_observation
      :value: None



   .. py:attribute:: _data


   .. py:attribute:: _kwargs


   .. py:method:: __call__(*args)


   .. py:method:: get_masked_data_and_cov(bool_mask)


   .. py:method:: compute_covariance(model, power_spectrum_dict, **kwargs)


.. py:class:: Dens(data, covariance_observation=None, **kwargs)

   Bases: :py:obj:`DataVector`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: _kind
      :value: 'density'



   .. py:attribute:: _needed_keys
      :value: ['density', 'density_error']



   .. py:method:: give_data_and_variance(*args)


.. py:class:: DirectVel(data, covariance_observation=None)

   Bases: :py:obj:`DataVector`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: _kind
      :value: 'velocity'



   .. py:attribute:: _needed_keys
      :value: ['velocity']



   .. py:property:: conditional_needed_keys


   .. py:method:: give_data_and_variance(*args)


.. py:class:: DensVel(density_vector, velocity_vector)

   Bases: :py:obj:`DataVector`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: _kind
      :value: 'cross'



   .. py:property:: needed_keys


   .. py:property:: free_par


   .. py:method:: give_data_and_variance(*args)


   .. py:attribute:: densities


   .. py:attribute:: velocities


   .. py:method:: compute_covariance(model, power_spectrum_dict, **kwargs)


.. py:class:: VelFromHDres(data, covariance_observation=None, velocity_estimator='full', **kwargs)

   Bases: :py:obj:`DirectVel`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: _needed_keys
      :value: ['dmu', 'zobs']



   .. py:attribute:: _free_par
      :value: ['M_0']



   .. py:property:: conditional_needed_keys


   .. py:method:: give_data_and_variance(parameter_values_dict)


   .. py:attribute:: velocity_estimator
      :value: 'full'



.. py:class:: FisherVelMesh(data, velocity_estimator='full', **kwargs)

   Bases: :py:obj:`DataVector`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: _kind
      :value: 'velocity'



   .. py:attribute:: _needed_keys
      :value: ['zobs', 'ra', 'dec', 'rcom_zobs']



   .. py:method:: give_data_and_variance(parameter_values_dict)


   .. py:attribute:: _distance_modulus_difference_to_velocity


.. py:class:: FisherVelFromHDres(data, velocity_estimator='full')

   Bases: :py:obj:`DataVector`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: _kind
      :value: 'velocity'



   .. py:attribute:: _needed_keys
      :value: ['zobs', 'ra', 'dec', 'rcom_zobs']



   .. py:attribute:: _free_par
      :value: ['sigma_M']



   .. py:method:: give_data_and_variance(parameter_values_dict)


   .. py:attribute:: velocity_estimator
      :value: 'full'



.. py:class:: FisherDens(data, velocity_estimator='full', **kwargs)

   Bases: :py:obj:`DataVector`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: _kind
      :value: 'density'



   .. py:attribute:: _needed_keys
      :value: ['ra', 'dec', 'rcom_zobs']



   .. py:attribute:: _free_par
      :value: []



   .. py:method:: give_data_and_variance(parameter_values_dict)


.. py:class:: FisherDensVel(fisher_density, fisher_velocity)

   Bases: :py:obj:`DataVector`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: _kind
      :value: 'cross'



   .. py:method:: give_data_and_variance(*args)


   .. py:attribute:: densities


   .. py:attribute:: velocities


   .. py:method:: compute_covariance(model, power_spectrum_dict, **kwargs)