Make the base module a ABC

Author: gijzelaerr

.gitignore

@@ -7,6 +7,5 @@ casa.log
 .virtualenv*/
 *.egg-info/
 .eggs/
-data/small.tgz
-data/small/
+data/
 cwl/outdir/

apercal/modules/base.py

@@ -1,15 +1,33 @@
 from glob import glob
 from os import path
+from apercal.libs.lib import show
 from typing import List, Tuple, Any
 
+from abc import abstractproperty, ABCMeta
+
 
 class BaseModule:
-    subdirification = None
-    basedir = None
-    rawsubdir = None
+
+    __metaclass__ = ABCMeta
+
+    @abstractproperty
+    def module_name(self):
+        pass
+
     fluxcal = None
     polcal = None
     target = None
+    basedir = None
+    beam = None
+    rawsubdir = None
+    crosscalsubdir = None
+    selfcalsubdir = None
+    linesubdir = None
+    contsubdir = None
+    polsubdir = None
+    mossubdir = None
+    transfersubdir = None
+    subdirification = True
 
     def get_fluxcal_path(self):
         if self.subdirification:
@@ -35,3 +53,6 @@ def get_datasets(self, beams=None):
         else:
             # TODO: (gijs) is it okay to just always set this to 0?
             return [(self.target, '00')]
+
+    def show(self, showall=False):
+        show(self, self.module_name, showall)

apercal/modules/ccal.py

@@ -25,6 +25,8 @@ class ccal(BaseModule):
     Crosscal class to handle applying the calibrator gains and prepare the dataset for self-calibration.
     """
 
+    module_name = 'CROSSCALL'
+
     fluxcal = None
     polcal = None
     target = None
@@ -87,9 +89,6 @@ def go(self):
         self.transfer_to_target()
         logger.info("CROSS CALIBRATION done ")
 
-    def show(self, showall=False):
-        lib.show(self, 'CROSSCALL', showall)
-
     def TEC(self):
         """
         Creates the TEC correction images and TEC calibration tables for all datasets

apercal/modules/continuum.py

@@ -4,6 +4,7 @@
 import pandas as pd
 import os
 
+from apercal.modules.base import BaseModule
 from apercal.libs.calculations import calc_dr_maj, calc_theoretical_noise, calc_theoretical_noise_threshold, \
     calc_dynamic_range_threshold, calc_clean_cutoff, calc_noise_threshold, calc_mask_threshold
 from apercal.subs import setinit as subs_setinit
@@ -19,24 +20,12 @@
 logger = logging.getLogger(__name__)
 
 
-class continuum:
+class continuum(BaseModule):
     """
     Continuum class to produce continuum data products (Deep continuum images of individual frequency chunks and
     stacked continuum image).
     """
-    fluxcal = None
-    polcal = None
-    target = None
-    basedir = None
-    beam = None
-    rawsubdir = None
-    crosscalsubdir = None
-    selfcalsubdir = None
-    linesubdir = None
-    contsubdir = None
-    polsubdir = None
-    mossubdir = None
-    transfersubdir = None
+    module_name = 'CONTINUUM'
 
     contdir = None
     selfcaldir = None
@@ -995,9 +984,6 @@ def detailed_summary(self):
 
         return df
 
-    def show(self, showall=False):
-        lib.show(self, 'CONTINUUM', showall)
-
     def reset(self):
         """
         Function to reset the current step and remove all generated data including continuum parameters in the

apercal/modules/convert.py

@@ -6,6 +6,7 @@
 import drivecasa
 import os
 
+from apercal.modules.base import BaseModule
 from apercal.subs import setinit as subs_setinit
 from apercal.subs import managefiles as subs_managefiles
 from apercal.subs.param import get_param_def
@@ -16,24 +17,12 @@
 logger = logging.getLogger(__name__)
 
 
-class convert:
+class convert(BaseModule):
     """
     Class to convert data from MS-format into UVFITS, and from UVFITS into MIRIAD format. Resulting datasets will
     have the endings .MS, .UVFITS, and .mir.
     """
-    fluxcal = None
-    polcal = None
-    target = None
-    basedir = None
-    beam = None
-    rawsubdir = None
-    crosscalsubdir = None
-    selfcalsubdir = None
-    linesubdir = None
-    contsubdir = None
-    polsubdir = None
-    mossubdir = None
-    transfersubdir = None
+    module_name = 'CONVERT'
 
     convert_fluxcal = True  # Convert the flux calibrator dataset
     convert_polcal = True  # Convert the polarised calibrator dataset
@@ -489,9 +478,6 @@ def summary(self):
 
         return df
 
-    def show(self, showall=False):
-        lib.show(self, 'CONVERT', showall)
-
     def reset(self):
         """
         Function to reset the current step and remove all generated data. Be careful! Deletes all data generated in

apercal/modules/line.py

@@ -6,6 +6,7 @@
 import numpy as np
 import os
 
+from apercal.modules.base import BaseModule
 from apercal.libs.calculations import calc_dr_maj, calc_theoretical_noise, calc_theoretical_noise_threshold, \
     calc_dynamic_range_threshold, calc_clean_cutoff, calc_noise_threshold, calc_mask_threshold, get_freqstart, \
     calc_dr_min, calc_line_masklevel, calc_miniter
@@ -16,23 +17,12 @@
 logger = logging.getLogger(__name__)
 
 
-class line:
+class line(BaseModule):
     """
     Line class to do continuum subtraction and prepare data for line imaging.
     """
-    fluxcal = None
-    polcal = None
-    target = None
-    basedir = None
-    beam = None
-    rawsubdir = None
-    crosscalsubdir = None
-    selfcalsubdir = None
-    linesubdir = None
-    contsubdir = None
-    polsubdir = None
-    mossubdir = None
-    transfersubdir = None
+    module_name = 'LINE'
+
 
     line_splitdata = None
     line_splitdata_chunkbandwidth = None
@@ -765,9 +755,6 @@ def get_last_major_iteration(self, chunk):
         lastmajor = n
         return lastmajor
 
-    def show(self, showall=False):
-        lib.show(self, 'LINE', showall)
-
     def reset(self):
         """
         Function to reset the current step and remove all generated data. Be careful! Deletes all data generated in

apercal/modules/line_parallel.py

@@ -10,6 +10,7 @@
 import time
 import timeit
 
+from apercal.modules.base import BaseModule
 from apercal.libs.calculations import calc_dr_maj, calc_theoretical_noise, calc_theoretical_noise_threshold, \
     calc_dynamic_range_threshold, calc_clean_cutoff, calc_noise_threshold, calc_mask_threshold, get_freqstart, \
     calc_dr_min, calc_line_masklevel, calc_miniter
@@ -21,23 +22,11 @@
 logger = logging.getLogger(__name__)
 
 
-class line_parallel:
+class line_parallel(BaseModule):
     """
     Line class to do continuum subtraction and prepare data for line imaging.
     """
-    fluxcal = None
-    polcal = None
-    target = None
-    basedir = None
-    beam = None
-    rawsubdir = None
-    crosscalsubdir = None
-    selfcalsubdir = None
-    linesubdir = None
-    contsubdir = None
-    polsubdir = None
-    mossubdir = None
-    transfersubdir = None
+    module_name = 'LINE'
 
     line_splitdata = None
     line_splitdata_chunkbandwidth = None
@@ -1905,9 +1894,6 @@ def get_last_major_iteration(self, chunk):
         lastmajor = n
         return lastmajor
 
-    def show(self, showall=False):
-        lib.show(self, 'LINE', showall)
-
     def reset(self):
         """
         Function to reset the current step and remove all generated data. Be careful! Deletes all data generated in

apercal/modules/mosaic.py

@@ -4,6 +4,7 @@
 import pandas as pd
 import os
 
+from apercal.modules.base import BaseModule
 from apercal.subs import setinit as subs_setinit
 from apercal.subs import managefiles as subs_managefiles
 from apercal.subs import readmirhead as subs_readmirhead
@@ -16,23 +17,11 @@
 logger = logging.getLogger(__name__)
 
 
-class mosaic:
+class mosaic(BaseModule):
     """
     Mosaic class to produce mosaics of continuum, line and polarisation images.
     """
-    fluxcal = None
-    polcal = None
-    target = None
-    basedir = None
-    beam = None
-    rawsubdir = None
-    crosscalsubdir = None
-    selfcalsubdir = None
-    linesubdir = None
-    contsubdir = None
-    polsubdir = None
-    mossubdir = None
-    transfersubdir = None
+    module_name = 'MOSAIC'
 
     mosdir = None
     mosaic_continuum_stack = None
@@ -774,9 +763,6 @@ def detailed_summary_continuumchunks(self, chunk=None):
 
         return df
 
-    def show(self, showall=False):
-        lib.show(self, 'MOSAIC', showall)
-
     def reset(self):
         """
         Function to reset the current step and remove all generated data. Be careful! Deletes all data generated in

apercal/modules/polarisation.py

@@ -1,16 +1,17 @@
 import logging
 from apercal.subs import setinit as subs_setinit
 from apercal.libs import lib
-
+from apercal.modules.base import BaseModule
 
 logger = logging.getLogger(__name__)
 
 
-class polarisation:
+class polarisation(BaseModule):
     """
     Final class to produce final data products (Deep continuum images, line cubes, and polairsation images and
     Faraday-cubes).
     """
+    module_name = 'POLARISATION'
 
     def __init__(self, file_=None, **kwargs):
         self.default = lib.load_config(self, file_)

apercal/modules/preflag.py

@@ -26,6 +26,8 @@ class preflag(BaseModule):
     """
     Preflagging class. Used to automatically flag data and apply preknown flags.
     """
+    module_name = 'PREFLAG'
+
     fluxcal = None
     polcal = None
     target = None
@@ -1214,9 +1216,6 @@ def summary(self):
 
         return df
 
-    def show(self, showall=False):
-        lib.show(self, 'PREFLAG', showall)
-
     def reset(self):
         """
         Function to reset the current step and remove all generated data. Be careful! Deletes all data generated in

apercal/modules/prepare.py

@@ -1,10 +1,10 @@
-import ConfigParser
 import glob
 import logging
 import pandas as pd
 import os
 import numpy as np
 
+from apercal.modules.base import BaseModule
 from apercal.subs import irods as subs_irods
 from apercal.subs import setinit as subs_setinit
 from apercal.subs import managefiles as subs_managefiles
@@ -16,23 +16,11 @@
 logger = logging.getLogger(__name__)
 
 
-class prepare:
+class prepare(BaseModule):
     """
     Prepare class. Automatically copies the datasets into the directories and selects valid data (in case of multi-element observations)
     """
-    fluxcal = None
-    polcal = None
-    target = None
-    basedir = None
-    beam = None
-    rawsubdir = None
-    crosscalsubdir = None
-    selfcalsubdir = None
-    linesubdir = None
-    contsubdir = None
-    polsubdir = None
-    mossubdir = None
-    transfersubdir = None
+    module_name = 'PREPARE'
 
     prepare_date = None
     prepare_obsnum_fluxcal = None
@@ -374,9 +362,6 @@ def summary(self):
 
         return df
 
-    def show(self, showall=False):
-        lib.show(self, 'PREPARE', showall)
-
     def reset(self):
         """
         Function to reset the current step and remove all generated data. Be careful! Deletes all data generated in this step!