Raw File
Tip revision: 3294608db9cbb99abc9a55cd962114465f785848 authored by Steven Murray on 15 February 2022, 14:39:04 UTC
docs: update changelog
Tip revision: 3294608
Developer Docs
Documentation for all the under-the-hood classes and functions that most users
won't need to interact with.

Base Classes
These classes are the under-the-hood classes that provide much of the
infrastructure for pyuvdata's user classes.

``UVParameter`` is the base class for the attributes on pyuvdata's user classes,
allowing the attributes to carry information like expected type and shape,
acceptable values or ranges and tolerances. We also have some type specific
parameter objects (e.g. for angles and earth locations) with extra functionality.

``UVBase`` is the base class for pyuvdata's user classes which has the common
infrastructure to turn the UVParameter attributes into properties and check the
attribute shapes and values.

.. autoclass:: pyuvdata.parameter.UVParameter

.. autoclass:: pyuvdata.parameter.AngleParameter

.. autoclass:: pyuvdata.parameter.LocationParameter

.. autoclass:: pyuvdata.uvbase.UVBase

File Type Specific Classes
These classes inherit from pyuvdata's user classes and hold the file type
specific code. The read and write methods on the user classes convert between
the user classes and the file-specific classes automatically as needed, so users
generally do not need to interact with these classes, but developers may need to.

.. autoclass:: pyuvdata.uvdata.fhd.FHD

.. autoclass:: pyuvdata.uvdata.mir.Mir

.. autoclass:: pyuvdata.uvdata.miriad.Miriad

.. autoclass::

.. autoclass:: pyuvdata.uvdata.mwa_corr_fits.MWACorrFITS

.. autoclass:: pyuvdata.uvdata.uvfits.UVFITS

.. autoclass:: pyuvdata.uvdata.uvh5.UVH5

.. autoclass:: pyuvdata.uvcal.calfits.CALFITS

.. autoclass:: pyuvdata.uvcal.fhd_cal.FHDCal

.. autoclass:: pyuvdata.uvbeam.beamfits.BeamFITS

.. autoclass:: pyuvdata.uvbeam.cst_beam.CSTBeam

.. autoclass:: pyuvdata.uvbeam.mwa_beam.MWABeam

Mir Parser
.. automodule:: pyuvdata.uvdata.mir_parser


.. autofunction:: pyuvdata.uvdata.fhd.get_fhd_history

.. autofunction:: pyuvdata.uvbeam.mwa_beam.P1sin

.. autofunction:: pyuvdata.uvbeam.mwa_beam.P1sin_array

.. autofunction:: pyuvdata.uvflag.uvflag.and_rows_cols

.. autofunction:: pyuvdata.uvflag.uvflag.lst_from_uv

.. autofunction:: pyuvdata.uvflag.uvflag.flags2waterfall

aipy extracts

.. automodule:: pyuvdata.uvdata.aipy_extracts
back to top