StepsAPI
====================================

.. py:class:: petpal.pipelines.steps_base.StepsAPI(skip_step: bool = False)

   StepsAPI provides an interface for defining steps in a processing pipeline.

   This class outlines methods that allow input and output management between different steps,
   and perform inference of output files based on input data and given parameters.



   .. py:method:: execute(*args, **kwargs)
      :abstractmethod:



   .. py:method:: set_input_as_output_from(*sending_steps)
      :abstractmethod:


      Sets the input of the current step as the output from a list of steps.

      :param \*sending_steps: The previous steps from which the output will be used as input for the current step.

      :raises NotImplementedError: This method should be implemented by subclasses.

      .. rubric:: Notes

      For a concrete example, take a look at:
      :meth:`TACsFromSegmentationStep<petpal.pipelines.preproc_steps.TACsFromSegmentationStep.set_input_as_output_from>`

      .. important::
         If a step takes multiple input steps. the implementation will have a defined order for steps.




   .. py:method:: infer_outputs_from_inputs(out_dir: str, der_type: str, suffix: str = None, ext: str = None, **extra_desc)
      :abstractmethod:


      Infers output files from input data based on the specified output directory,
      derivative type, optional suffix and extension, plus any extra descriptions.

      :param out_dir: The directory where the output files will be saved.
      :type out_dir: str
      :param der_type: The type of derivative being produced.
      :type der_type: str
      :param suffix: An optional suffix for the output files.
      :type suffix: str, optional
      :param ext: An optional extension for the output files.
      :type ext: str, optional
      :param \*\*extra_desc: Additional keyword arguments for extra descriptions to be included.

      :raises NotImplementedError: This method should be implemented by subclasses.

      .. rubric:: Notes

      For a concrete example, take a look at:
      :meth:`TACsFromSegmentationStep<petpal.pipelines.preproc_steps.TACsFromSegmentationStep.infer_outputs_from_inputs>`



   .. py:method:: __call__(*args, **kwargs)