:py:mod:`transform_utils`
=========================

.. py:module:: transform_utils

.. autoapi-nested-parse::

   Utility functions for processing data used for training and validation



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

Classes
~~~~~~~

.. autoapisummary::

   transform_utils.ComposeXYLocal
   transform_utils.Metadata
   transform_utils.Standardizer
   transform_utils.Slicer
   transform_utils.Rejector
   transform_utils.MagErrorSimulator
   transform_utils.MagErrorSimulatorTorch



Functions
~~~~~~~~~

.. autoapisummary::

   transform_utils.get_idx
   transform_utils.get_bands_in_x



.. py:class:: ComposeXYLocal(transforms_X_pre=[], transforms_Y_local_pre=[], transforms_X_Y_local=[], transforms_X_post=[], transforms_Y_local_post=[], transforms_X_meta_post=[])

   .. py:method:: __call__(x, y_local, x_meta)



.. py:function:: get_idx(orig_list, sub_list)


.. py:class:: Metadata(all_features=['ra_true', 'dec_true', 'u', 'g', 'r', 'i', 'z', 'y'], pos_features=['ra_true', 'dec_true'])

   .. py:method:: __call__(x_meta, x)



.. py:class:: Standardizer(mean, std)

   .. py:method:: __call__(x, y=None)



.. py:class:: Slicer(feature_idx)

   .. py:method:: __call__(x)



.. py:class:: Rejector(all_features=[], ref_features=[], max_vals=None, min_vals=None)

   .. py:method:: __call__(x, y)



.. py:function:: get_bands_in_x(x_cols)


.. py:class:: MagErrorSimulator(mag_idx=[2, 3, 4, 5, 6, 7], which_bands=list('ugrizy'), override_kwargs=None, depth=5, airmass=1.15304)

   .. py:attribute:: bands
      :value: ['u', 'g', 'r', 'i', 'z', 'y']

      

   .. py:attribute:: m_skys
      :value: [22.5, 22.19191, 21.10172, 19.93964, 18.3, 17.7]

      

   .. py:attribute:: seeings
      :value: [1.029668, 0.951018, 0.8996875, 0.868422, 1, 1]

      

   .. py:attribute:: gammas
      :value: [0.038, 0.039, 0.039, 0.039, 0.039, 0.039]

      

   .. py:attribute:: k_ms
      :value: [0.491, 0.213, 0.126, 0.096, 0.069, 0.17]

      

   .. py:attribute:: C_ms
      :value: [23.09, 24.42, 24.44, 24.32, 24.16, 23.73]

      

   .. py:attribute:: delta_C_m_infs
      :value: [0.62, 0.18, 0.1, 0.07, 0.05, 0.04]

      

   .. py:attribute:: num_visits_10_year
      :value: [56, 80, 184, 184, 160, 160]

      

   .. py:method:: _format_input_params()

      Convert param lists into arrays for vectorized computation

              


   .. py:method:: _slice_input_params()

      Slice and reorder input params so only the relevant bands
      in `self.which_bands` remain, in that order



   .. py:method:: calculate_delta_C_ms()

      Returns delta_C_m correction for num_visits > 1
      (i.e. exposure times > 30s), for ugrizy
      following Eq 7 in Science Drivers.



   .. py:method:: calculate_5sigma_depths()

      Returns m_5 found using Eq 6 in Science Drivers,
      using eff seeing, sky brightness, exposure time,
      extinction coeff, airmass, for ugrizy.
      Includes dependence on number of visits.



   .. py:method:: calculate_rand_err(mags)

      "Returns sigma_rand_squared


   .. py:method:: get_sigmas(mags)

      "Returns sigma (photometric error in mag).
      Calculated using figures and formulae from Science Drivers

      Params:
      - AB mag (float)


   .. py:method:: __call__(x)



.. py:class:: MagErrorSimulatorTorch(mag_idx=[2, 3, 4, 5, 6, 7], which_bands=list('ugrizy'), override_kwargs=None, depth=5, airmass=1.15304)

   .. py:attribute:: bands
      :value: ['u', 'g', 'r', 'i', 'z', 'y']

      

   .. py:attribute:: m_skys
      :value: [22.5, 22.19191, 21.10172, 19.93964, 18.3, 17.7]

      

   .. py:attribute:: seeings
      :value: [1.029668, 0.951018, 0.8996875, 0.868422, 1, 1]

      

   .. py:attribute:: gammas
      :value: [0.038, 0.039, 0.039, 0.039, 0.039, 0.039]

      

   .. py:attribute:: k_ms
      :value: [0.491, 0.213, 0.126, 0.096, 0.069, 0.17]

      

   .. py:attribute:: C_ms
      :value: [23.09, 24.42, 24.44, 24.32, 24.16, 23.73]

      

   .. py:attribute:: delta_C_m_infs
      :value: [0.62, 0.18, 0.1, 0.07, 0.05, 0.04]

      

   .. py:attribute:: num_visits_10_year
      :value: [56, 80, 184, 184, 160, 160]

      

   .. py:method:: _format_input_params()

      Convert param lists into arrays for vectorized computation

              


   .. py:method:: _slice_input_params()

      Slice and reorder input params so only the relevant bands
      in `self.which_bands` remain, in that order



   .. py:method:: calculate_delta_C_ms()

      Returns delta_C_m correction for num_visits > 1
      (i.e. exposure times > 30s), for ugrizy
      following Eq 7 in Science Drivers.



   .. py:method:: calculate_5sigma_depths()

      Returns m_5 found using Eq 6 in Science Drivers,
      using eff seeing, sky brightness, exposure time,
      extinction coeff, airmass, for ugrizy.
      Includes dependence on number of visits.



   .. py:method:: calculate_rand_err(mags)

      "Returns sigma_rand_squared


   .. py:method:: get_sigmas(mags)

      "Returns sigma (photometric error in mag).
      Calculated using figures and formulae from Science Drivers

      Params:
      - AB mag (float)


   .. py:method:: __call__(x)