deploy: 6bc9f3a

.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 32f5ec22bdc02363c360048bdab62c1f
+config: 027d0cc596ac1fdce9d13d057862f205
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/autoapi/solpolpy/alpha/index.rst.txt

@@ -1,5 +1,5 @@
-:py:mod:`solpolpy.alpha`
-========================
+solpolpy.alpha
+==============
 
 .. py:module:: solpolpy.alpha
 
@@ -9,27 +9,25 @@
 
 
 
-Module Contents
----------------
-
-
-Functions
-~~~~~~~~~
+Attributes
+----------
 
 .. autoapisummary::
 
-   solpolpy.alpha.radial_north
-
+   solpolpy.alpha.ALPHA_FUNCTIONS
 
 
-Attributes
-~~~~~~~~~~
+Functions
+---------
 
 .. autoapisummary::
 
-   solpolpy.alpha.ALPHA_FUNCTIONS
+   solpolpy.alpha.radial_north
 
 
+Module Contents
+---------------
+
 .. py:function:: radial_north(shape)
 
    An alpha array oriented west
@@ -50,5 +48,3 @@ Attributes
 
 .. py:data:: ALPHA_FUNCTIONS
 
-   
-

_sources/autoapi/solpolpy/constants/index.rst.txt

@@ -1,5 +1,5 @@
-:py:mod:`solpolpy.constants`
-============================
+solpolpy.constants
+==================
 
 .. py:module:: solpolpy.constants
 
@@ -9,10 +9,16 @@
 
 
 
+Attributes
+----------
+
+.. autoapisummary::
+
+   solpolpy.constants.VALID_KINDS
+
+
 Module Contents
 ---------------
 
 .. py:data:: VALID_KINDS
 
-   
-

_sources/autoapi/solpolpy/core/index.rst.txt

@@ -1,5 +1,5 @@
-:py:mod:`solpolpy.core`
-=======================
+solpolpy.core
+=============
 
 .. py:module:: solpolpy.core
 
@@ -9,15 +9,31 @@
 
 
 
-Module Contents
----------------
+Attributes
+----------
+
+.. autoapisummary::
+
+   solpolpy.core.VALID_KINDS
+   solpolpy.core.transform_graph
+
+
+Exceptions
+----------
+
+.. autoapisummary::
+
+   solpolpy.core.UnsupportedTransformationError
 
 
 Functions
-~~~~~~~~~
+---------
 
 .. autoapisummary::
 
+   solpolpy.core.radial_north
+   solpolpy.core.load_data
+   solpolpy.core.npol_to_mzp
    solpolpy.core.resolve
    solpolpy.core.determine_input_kind
    solpolpy.core.get_transform_path
@@ -31,6 +47,60 @@ Functions
    solpolpy.core.identity
 
 
+Module Contents
+---------------
+
+.. py:function:: radial_north(shape)
+
+   An alpha array oriented west
+
+   :param shape: how big the array should be
+   :type shape: tuple[int, int]
+
+   :returns: alpha array used in calculations
+   :rtype: np.ndarray
+
+   .. rubric:: Notes
+
+   - assumes solar north is up
+   - assumes polarizer 0 is along solar north axis
+   - creates radial polarization map
+   - angles increase in counterclockwise direction
+
+
+.. py:data:: VALID_KINDS
+
+.. py:exception:: UnsupportedTransformationError
+
+   Bases: :py:obj:`Exception`
+
+
+   Common base class for all non-exit exceptions.
+
+
+.. py:data:: transform_graph
+
+.. py:function:: load_data(path_list: List[str], mask: Optional[numpy.ndarray] = None, use_instrument_mask: bool = False) -> ndcube.NDCollection
+
+   Basic loading function. See `load_with_occulter_mask`.
+   :param path_list: list of paths to FITS files to be loaded
+   :type path_list: List[str]
+   :param mask: An optional mask to couple with images. Overrides any mask computed when use_instrument_mask=True.
+   :type mask: Optional[np.ndarray]
+   :param use_instrument_mask: If true, loads an instrument mask for common instruments defined in `get_instrument_mask`.
+   :type use_instrument_mask: bool
+
+   :returns: The data are loaded as NDCollection object with WCS and header information available.
+             The keys are labeled as 'angle_1', 'angle_2, 'angle_3', ...
+   :rtype: NDCollection
+
+
+.. py:function:: npol_to_mzp(input_collection)
+
+   .. rubric:: Notes
+
+   Equation 44 in DeForest et al. 2022.
+
 
 .. py:function:: resolve(input_data: Union[List[str], ndcube.NDCollection], out_system: str, imax_effect: bool = False) -> ndcube.NDCollection
 

_sources/autoapi/solpolpy/errors/index.rst.txt

@@ -1,33 +1,43 @@
-:py:mod:`solpolpy.errors`
-=========================
+solpolpy.errors
+===============
 
 .. py:module:: solpolpy.errors
 
 
+Exceptions
+----------
+
+.. autoapisummary::
+
+   solpolpy.errors.TooFewFilesError
+   solpolpy.errors.UnsupportedInstrumentError
+   solpolpy.errors.UnsupportedTransformationError
+
+
 Module Contents
 ---------------
 
 .. py:exception:: TooFewFilesError
 
-
    Bases: :py:obj:`Exception`
 
+
    Common base class for all non-exit exceptions.
 
 
 .. py:exception:: UnsupportedInstrumentError
 
-
    Bases: :py:obj:`Exception`
 
+
    Common base class for all non-exit exceptions.
 
 
 .. py:exception:: UnsupportedTransformationError
 
-
    Bases: :py:obj:`Exception`
 
+
    Common base class for all non-exit exceptions.
 
 

_sources/autoapi/solpolpy/graph/index.rst.txt

@@ -1,5 +1,5 @@
-:py:mod:`solpolpy.graph`
-========================
+solpolpy.graph
+==============
 
 .. py:module:: solpolpy.graph
 
@@ -9,10 +9,128 @@
 
 
 
+Attributes
+----------
+
+.. autoapisummary::
+
+   solpolpy.graph.transform_graph
+
+
+Functions
+---------
+
+.. autoapisummary::
+
+   solpolpy.graph.bp3_to_bthp
+   solpolpy.graph.bp3_to_mzp
+   solpolpy.graph.bpb_to_btbr
+   solpolpy.graph.bpb_to_mzp
+   solpolpy.graph.btbr_to_bpb
+   solpolpy.graph.btbr_to_mzp
+   solpolpy.graph.btbr_to_npol
+   solpolpy.graph.fourpol_to_stokes
+   solpolpy.graph.mzp_to_bp3
+   solpolpy.graph.mzp_to_bpb
+   solpolpy.graph.mzp_to_stokes
+   solpolpy.graph.npol_to_mzp
+   solpolpy.graph.stokes_to_mzp
+
+
 Module Contents
 ---------------
 
-.. py:data:: transform_graph
+.. py:function:: bp3_to_bthp(input_collection)
+
+   .. rubric:: Notes
+
+   Equations 9, 15, 16 in DeForest et al. 2022.
+
+
+.. py:function:: bp3_to_mzp(input_collection)
+
+   .. rubric:: Notes
+
+   Equation 11 in DeForest et al. 2022.
+
+
+.. py:function:: bpb_to_btbr(input_collection)
+
+   .. rubric:: Notes
+
+   Equation 1 and 2 in DeForest et al. 2022.
+
+
+.. py:function:: bpb_to_mzp(input_collection)
+
+   .. rubric:: Notes
+
+   Equation 4 in DeForest et al. 2022.
+
+
+.. py:function:: btbr_to_bpb(input_collection)
+
+   .. rubric:: Notes
+
+   Equation in Table 1 in DeForest et al. 2022.
+
+
+.. py:function:: btbr_to_mzp(input_collection)
+
+   .. rubric:: Notes
+
+   Equation 3 in DeForest et al. 2022.
 
-   
+
+.. py:function:: btbr_to_npol(input_collection, angles)
+
+   .. rubric:: Notes
+
+   Equation 3 in DeForest et al. 2022.
+   angles: list of input angles in degree
+
+
+.. py:function:: fourpol_to_stokes(input_collection)
+
+   .. rubric:: Notes
+
+   Table 1 in DeForest et al. 2022.
+
+
+.. py:function:: mzp_to_bp3(input_collection)
+
+   .. rubric:: Notes
+
+   Equation 7, 9 and 10 in DeForest et al. 2022.
+
+
+.. py:function:: mzp_to_bpb(input_collection)
+
+   .. rubric:: Notes
+
+   Equation 7 and 9 in DeForest et al. 2022.
+
+
+.. py:function:: mzp_to_stokes(input_collection)
+
+   .. rubric:: Notes
+
+   Equation 9, 12 and 13 in DeForest et al. 2022.
+
+
+.. py:function:: npol_to_mzp(input_collection)
+
+   .. rubric:: Notes
+
+   Equation 44 in DeForest et al. 2022.
+
+
+.. py:function:: stokes_to_mzp(input_collection)
+
+   .. rubric:: Notes
+
+   Equation 11 in DeForest et al. 2022. with alpha = np.pi/2
+
+
+.. py:data:: transform_graph