httomo.method_wrappers.distortion_correction.DistortionCorrectionWrapper

class httomo.method_wrappers.distortion_correction.DistortionCorrectionWrapper(method_repository: MethodRepository, module_path: str, method_name: str, comm: mpi4py.MPI.Comm, preview_config: PreviewConfig, save_result: bool | None = None, output_mapping: Dict[str, str] = {}, **kwargs)

Wrapper for distortion correction methods.

Methods

__init__(method_repository, module_path, ...)	Constructs a MethodWrapper for a method located in module_path with the name method_name.
requires_preview()	Whether the wrapper class needs the preview information from the loader to execute the methods it wraps or not.
should_select_this_class(module_path, ...)	Method to dermine if this class should be used for wrapper instantiation, given the module path and method name.

Attributes

task_id
pattern

classmethod requires_preview() → bool

Whether the wrapper class needs the preview information from the loader to execute the methods it wraps or not.

classmethod should_select_this_class(module_path: str, method_name: str) → bool

Method to dermine if this class should be used for wrapper instantiation, given the module path and method name.

The make_method_wrapper function will iterate through all subclasses and evaluate this condition in the order of declaration, falling back to GenericMethodWrapper if all evaluate to False.

Therefore, deriving classes should override this method to indicate the criteria when they should be instantiated.