renamed DataLoader -> DataDeconvolutionAlgorithmInterface or DataIF

cosipy/image_deconvolution/__init__.py

@@ -1,5 +1,14 @@
-from .data_loader_DC2 import DataLoaderDC2
+from .image_deconvolution import ImageDeconvolution, model_classes, deconvolution_algorithm_classes 
+
+from .data_deconvolution_algorithm_interface_base import DataDeconvolutionAlgorithmInterfaceBase
+from .dataIF_COSI_DC2 import DataIF_COSI_DC2
+
+from .model_base import ModelBase
 from .allskyimage import AllSkyImageModel
-from .image_deconvolution import ImageDeconvolution
+
+from .deconvolution_algorithm_base import DeconvolutionAlgorithmBase
+from .RichardsonLucy import RichardsonLucy
+from .RichardsonLucySimple import RichardsonLucySimple
+
 from .exposure_table import SpacecraftAttitudeExposureTable
 from .coordsys_conversion_matrix import CoordsysConversionMatrix

cosipy/image_deconvolution/data_loader_DC2.py → cosipy/image_deconvolution/dataIF_COSI_DC2.py

@@ -8,19 +8,17 @@
 from histpy import Histogram, Axes
 
 from cosipy.response import FullDetectorResponse
-from cosipy.data_io import BinnedData
-from .coordsys_conversion_matrix import CoordsysConversionMatrix
 
-from .data_loader_base import DataLoaderBase
+from .data_deconvolution_algorithm_interface_base import DataDeconvolutionAlgorithmInterfaceBase
 
-class DataLoaderDC2(DataLoaderBase):
+class DataIF_COSI_DC2(DataDeconvolutionAlgorithmInterfaceBase):
     """
-    A subclass of DataLoaderBase for the COSI data challenge 2.
+    A subclass of DataDeconvolutionAlgorithmInterfaceBase for the COSI data challenge 2.
     """
 
     def __init__(self, name = None):
 
-        DataLoaderBase.__init__(self, name)
+        DataDeconvolutionAlgorithmInterfaceBase.__init__(self, name)
 
         self._image_response = None # histpy.Histogram (dense)
 
@@ -52,8 +50,8 @@ def load(cls, name, event_binned_data, dict_bkg_binned_data, rsp, coordsys_conv_
 
         Returns
         -------
-        :py:class:`cosipy.image_deconvolution.DataLoader`
-            An instance of DataLoader containing the input data set
+        :py:class:`cosipy.image_deconvolution.DataIF_COSI_DC2`
+            An instance of DataIF_COSI_DC2 containing the input data set
         """
 
         new = cls(name)
@@ -103,7 +101,7 @@ def _modify_axes(self):
         Modify the axes of data. This method will be removed in the future.
         """
 
-        logger.warning("Note that _modify_axes() in DataLoader was implemented for a temporary use. It will be removed in the future.")
+        logger.warning("Note that _modify_axes() in DataIF_COSI_DC2 was implemented for a temporary use. It will be removed in the future.")
 
         if self._coordsys_conv_matrix is None:
             axis_name = ['Em', 'Phi', 'PsiChi']

cosipy/image_deconvolution/data_loader_base.py → cosipy/image_deconvolution/data_deconvolution_algorithm_interface_base.py

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 
-class DataLoaderBase(ABC):
+class DataDeconvolutionAlgorithmInterfaceBase(ABC):
     """
     A base class for managing data for image analysis, i.e., 
     event data, background models, response, coordsys conversion matrix etc.

cosipy/image_deconvolution/deconvolution_algorithm_base.py

@@ -24,7 +24,7 @@ class DeconvolutionAlgorithmBase(ABC):
     Attributes
     ----------
     initial_model: :py:class:`cosipy.image_deconvolution.ModelMap`
-    dataset: list of :py:class:`cosipy.image_deconvolution.DataLoader`
+    dataset: list of :py:class:`cosipy.image_deconvolution.DataDeconvolutionAlgorithmInterfaceBase` or its subclass
     parameter : py:class:`yayc.Configurator`
     results: list of results
     dict_bkg_norm: the dictionary of background normalizations

cosipy/image_deconvolution/image_deconvolution.py

@@ -31,8 +31,8 @@ def set_dataset(self, dataset):
 
         Parameters
         ----------
-        dataset : list of :py:class:`cosipy.image_deconvolution.DataLoader`
-            Each data loader contaning an event histogram, a background model, a response matrix, and a coordsys_conversion_matrix.
+        dataset : list of :py:class:`cosipy.image_deconvolution.DataDeconvolutionAlgorithmInterfaceBase` or its subclass
+            Each component contaning an event histogram, a background model, a response matrix, and a coordsys_conversion_matrix.
         """
 
         self._dataset = dataset
@@ -75,7 +75,7 @@ def dataset(self):
     @property
     def parameter(self):
         """
-        Return the parameter set to DataLoader.
+        Return the registered parameter.
         """
         return self._parameter