@@ -34,23 +34,26 @@ class MetisRecipeImpl(ABC):
3434 by particular pipeline recipe implementations.
3535 """
3636 InputSet : type [PipelineInputSet ] = None
37- Product : type [PipelineProduct ] = None
3837
3938 # Available parameters are a class variable. This must be present, even if empty.
4039 parameters = cpl .ui .ParameterList ([])
4140
4241 def __init__ (self , recipe : 'MetisRecipe' ) -> None :
42+ """
43+ Initializes the recipe implementation object with parameters from the recipe
44+ and sets internal attributes to None / empty as needed.
45+ """
4346 super ().__init__ ()
4447 self .name = recipe .name
4548 self .version = recipe .version
4649 self .parameters = recipe .parameters
4750
48- self .inputset : PipelineInputSet = None
51+ self .inputset : PipelineInputSet | None = None
4952 self .frameset : cpl .ui .FrameSet | None = None
5053 self .header : cpl .core .PropertyList | None = None
51- self .products : Dict [ str , PipelineProduct ] = {}
54+ self .products : [ PipelineProduct ] = {}
5255 self .product_frames = cpl .ui .FrameSet ()
53-
56+
5457 def run (self , frameset : cpl .ui .FrameSet , settings : Dict [str , Any ]) -> cpl .ui .FrameSet :
5558 """
5659 The main function of the recipe implementation. It mirrors the signature of `Recipe.run`
@@ -64,14 +67,14 @@ def run(self, frameset: cpl.ui.FrameSet, settings: Dict[str, Any]) -> cpl.ui.Fra
6467
6568 try :
6669 self .frameset = frameset
67- self .import_settings (settings ) # Import and process the provided settings dict
68- self .inputset = self .InputSet (frameset ) # Create an appropriate InputSet object
70+ self .import_settings (settings ) # Import and process the provided settings dict
71+ self .inputset = self .InputSet (frameset ) # Create an appropriate InputSet object
6972 self .inputset .print_debug ()
70- self .inputset .validate () # Verify that they are valid (maybe with `schema` too?)
71- products = self .process_images () # Do all the actual processing
72- self .save_products ( products ) # Save the output products
73+ self .inputset .validate () # Verify that they are valid (maybe with `schema` too?)
74+ self . products = self .process_images () # Do all the actual processing
75+ self ._save_products () # Save the output products
7376
74- return self .build_product_frameset (products ) # Return the output as a pycpl FrameSet
77+ return self .build_product_frameset () # Return the output as a pycpl FrameSet
7578 except cpl .core .DataNotFoundError as e :
7679 Msg .error (self .__class__ .__qualname__ , f"Data not found error: { e .message } )
7780 raise e
@@ -84,20 +87,20 @@ def import_settings(self, settings: Dict[str, Any]) -> None:
8487 self .parameters [key ].value = value
8588 except KeyError :
8689 Msg .warning (self .__class__ .__qualname__ ,
87- f"Settings includes '{ key } : { value }
90+ f"Settings include '{ key } = { value }
8891 f"but class { self .__class__ .__qualname__ }
8992 f"has no parameter named { key } )
9093
9194 @abstractmethod
92- def process_images (self ) -> Dict [ str , PipelineProduct ]:
95+ def process_images (self ) -> [ PipelineProduct ]:
9396 """
9497 The core method of the recipe implementation. It should contain all the processing logic.
9598 At its entry point the Input class must be already loaded and validated.
9699
97100 All pixel manipulation should happen inside this function (or something it calls from within).
98101 Put explicitly,
99- - no pixel manipulation before entering `process_images`,
100- - and no pixel manipulation after exiting `process_images`.
102+ - no pixel manipulation * before* entering `process_images`,
103+ - and no pixel manipulation * after* exiting `process_images`.
101104
102105 The basic workflow inside this function should be as follows:
103106
@@ -118,22 +121,24 @@ def process_images(self) -> Dict[str, PipelineProduct]:
118121 """
119122 return {}
120123
121- def save_products (self , products : Dict [ str , PipelineProduct ] ) -> None :
124+ def _save_products (self ) -> None :
122125 """
123126 Save and register the created products.
124127 """
125- for name , product in products .items ():
126- Msg .debug (self .__class__ .__qualname__ ,
127- f"Saving product { name } )
128+ assert self .products is not None , "Products have not been created yet!"
129+
130+ Msg .debug (self .__class__ .__qualname__ ,
131+ f"Saving { len (self .products )} { self .products } )
132+ for product in self .products :
128133 product .save ()
129134
130- def build_product_frameset (self , products : Dict [ str , PipelineProduct ] ) -> cpl .ui .FrameSet :
135+ def build_product_frameset (self ) -> cpl .ui .FrameSet :
131136 """
132137 Gather all the products and build a FrameSet from their frames so that it can be returned from `run`.
133138 """
134139 Msg .debug (self .__class__ .__qualname__ ,
135140 f"Building the product frameset" )
136- return cpl .ui .FrameSet ([product .as_frame () for product in products . values () ])
141+ return cpl .ui .FrameSet ([product .as_frame () for product in self . products ])
137142
138143 def as_dict (self ) -> dict [str , Any ]:
139144 """
@@ -147,7 +152,7 @@ def as_dict(self) -> dict[str, Any]:
147152 'title' : self .name ,
148153 'inputset' : self .inputset .as_dict (),
149154 'products' : {
150- product .tag : product .as_dict () for product in self .products . values ()
155+ str ( product .category ) : product .as_dict () for product in self .products
151156 }
152157 }
153158
0 commit comments