malcolm.modules.scanning.hooks

class malcolm.modules.scanning.hooks.ValidateHook(part: Anno(name='APart', typ=<class 'malcolm.core.part.Part'>, description='The part that has attached to the Hook'), context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), part_info: Union[Anno(name='APartInfo', typ=(<class 'str'>, annotypes._array.Array[malcolm.core.info.Info]), description='The Infos returned from other Parts'), Mapping[str, Sequence[malcolm.core.info.Info]]], generator: Anno(name='AGenerator', typ=<MagicMock name='mock.CompoundGenerator' id='139916666047248'>, description='Generator instance providing specification for scan'), axesToMove: Anno(name='AAxesToMove', typ=<class 'str'>, description='List of axes in inner dimension of generator that should be moved'), breakpoints: Anno(name='ABreakpoints', typ=<class 'numpy.int32'>, description='List of points at which the run will return in Armed state'), **kwargs)[source]

Called at validate() to check parameters are valid

Parameters:
  • part (Part) – The part that has attached to the Hook
  • context (Context) – Context that should be used to perform operations on child blocks
  • part_info – The Infos returned from other Parts
  • generator – Generator instance providing specification for scan
  • axesToMove (str) – List of axes in inner dimension of generator that should be moved
  • breakpoints (int32) – List of points at which the run will return in Armed state
validate_return(ret: Union[Anno(name='AParameterTweakInfos', typ=<class 'malcolm.modules.scanning.infos.ParameterTweakInfo'>, description='Parameters that need to be changed to make them compatible'), Sequence[malcolm.modules.scanning.infos.ParameterTweakInfo], malcolm.modules.scanning.infos.ParameterTweakInfo, None]) -> Anno(name='AParameterTweakInfos', typ=<class 'malcolm.modules.scanning.infos.ParameterTweakInfo'>, description='Parameters that need to be changed to make them compatible')[source]

Check that all returned infos are ParameterTweakInfo that list the parameters that need to be changed to make them compatible with this part. ValidateHook will be re-run with the modified parameters.

class malcolm.modules.scanning.hooks.ReportStatusHook(part: Anno(name='APart', typ=<class 'malcolm.core.part.Part'>, description='The part that has attached to the Hook'), context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), **kwargs)[source]

Called before Validate, Configure, PostRunArmed and Seek hooks to report the current configuration of all parts

Parameters:
  • part (Part) – The part that has attached to the Hook
  • context (Context) – Context that should be used to perform operations on child blocks
validate_return(ret: Union[Anno(name='AInfos', typ=<class 'malcolm.core.info.Info'>, description='Infos about current Part status to be passed to other parts'), Sequence[malcolm.core.info.Info], malcolm.core.info.Info, None]) -> Anno(name='AInfos', typ=<class 'malcolm.core.info.Info'>, description='Infos about current Part status to be passed to other parts')[source]

Check that all parts return Info objects relevant to other parts

class malcolm.modules.scanning.hooks.PreConfigureHook(part: Anno(name='APart', typ=<class 'malcolm.core.part.Part'>, description='The part that has attached to the Hook'), context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), **kwargs)[source]

Called before configure() to get the device into a suitable state to report status and run configure. Typically will load a saved design.

Parameters:
  • part (Part) – The part that has attached to the Hook
  • context (Context) – Context that should be used to perform operations on child blocks
class malcolm.modules.scanning.hooks.ConfigureHook(part: Anno(name='APart', typ=<class 'malcolm.core.part.Part'>, description='The part that has attached to the Hook'), context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), completed_steps: Anno(name='ACompletedSteps', typ=<class 'int'>, description='Number of steps already completed'), steps_to_do: Anno(name='AStepsToDo', typ=<class 'int'>, description='Number of steps we should configure for'), part_info: Anno(name='APartInfo', typ=(<class 'str'>, annotypes._array.Array[malcolm.core.info.Info]), description='The Infos returned from other Parts'), generator: Anno(name='AGenerator', typ=<MagicMock name='mock.CompoundGenerator' id='139916666047248'>, description='Generator instance providing specification for scan'), axesToMove: Anno(name='AAxesToMove', typ=<class 'str'>, description='List of axes in inner dimension of generator that should be moved'), breakpoints: Anno(name='ABreakpoints', typ=<class 'numpy.int32'>, description='List of points at which the run will return in Armed state'), **kwargs)[source]

Called at configure() to configure child block for a run

Parameters:
  • part (Part) – The part that has attached to the Hook
  • context (Context) – Context that should be used to perform operations on child blocks
  • completed_steps (int) – Number of steps already completed
  • steps_to_do (int) – Number of steps we should configure for
  • part_info – The Infos returned from other Parts
  • generator – Generator instance providing specification for scan
  • axesToMove (str) – List of axes in inner dimension of generator that should be moved
  • breakpoints (int32) – List of points at which the run will return in Armed state
classmethod create_info(configure_func: Callable) → malcolm.modules.scanning.infos.ConfigureParamsInfo[source]

Create a ConfigureParamsInfo describing the extra parameters that should be passed at configure

validate_return(ret: Union[Anno(name='AInfos', typ=<class 'malcolm.core.info.Info'>, description='Infos about current Part status to be passed to other parts'), Sequence[malcolm.core.info.Info], malcolm.core.info.Info, None]) -> Anno(name='AInfos', typ=<class 'malcolm.core.info.Info'>, description='Infos about current Part status to be passed to other parts')[source]

Check that all parts return Info objects for storing as attributes

class malcolm.modules.scanning.hooks.PostConfigureHook(part: Anno(name='APart', typ=<class 'malcolm.core.part.Part'>, description='The part that has attached to the Hook'), context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), part_info: Anno(name='APartInfo', typ=(<class 'str'>, annotypes._array.Array[malcolm.core.info.Info]), description='The Infos returned from other Parts'))[source]

Called at the end of configure() to store configuration info calculated in the Configure hook

Parameters:
  • part (Part) – The part that has attached to the Hook
  • context (Context) – Context that should be used to perform operations on child blocks
  • part_info – The Infos returned from other Parts
class malcolm.modules.scanning.hooks.PreRunHook(part: Anno(name='APart', typ=<class 'malcolm.core.part.Part'>, description='The part that has attached to the Hook'), context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), **kwargs)[source]

Called at the start of run()

Parameters:
  • part (Part) – The part that has attached to the Hook
  • context (Context) – Context that should be used to perform operations on child blocks
class malcolm.modules.scanning.hooks.RunHook(part: Anno(name='APart', typ=<class 'malcolm.core.part.Part'>, description='The part that has attached to the Hook'), context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), **kwargs)[source]

Called at run() to start the configured steps running

Parameters:
  • part (Part) – The part that has attached to the Hook
  • context (Context) – Context that should be used to perform operations on child blocks
class malcolm.modules.scanning.hooks.PostRunArmedHook(part: Anno(name='APart', typ=<class 'malcolm.core.part.Part'>, description='The part that has attached to the Hook'), context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), completed_steps: Anno(name='ACompletedSteps', typ=<class 'int'>, description='Number of steps already completed'), steps_to_do: Anno(name='AStepsToDo', typ=<class 'int'>, description='Number of steps we should configure for'), part_info: Union[Anno(name='APartInfo', typ=(<class 'str'>, annotypes._array.Array[malcolm.core.info.Info]), description='The Infos returned from other Parts'), Mapping[str, Sequence[malcolm.core.info.Info]]], generator: Anno(name='AGenerator', typ=<MagicMock name='mock.CompoundGenerator' id='139916666047248'>, description='Generator instance providing specification for scan'), axesToMove: Anno(name='AAxesToMove', typ=<class 'str'>, description='List of axes in inner dimension of generator that should be moved'), **kwargs)[source]

Called at the end of run() when there are more steps to be run

Parameters:
  • part (Part) – The part that has attached to the Hook
  • context (Context) – Context that should be used to perform operations on child blocks
  • completed_steps (int) – Number of steps already completed
  • steps_to_do (int) – Number of steps we should configure for
  • part_info – The Infos returned from other Parts
  • generator – Generator instance providing specification for scan
  • axesToMove (str) – List of axes in inner dimension of generator that should be moved
class malcolm.modules.scanning.hooks.PostRunReadyHook(part: Anno(name='APart', typ=<class 'malcolm.core.part.Part'>, description='The part that has attached to the Hook'), context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), **kwargs)[source]

Called at the end of run() when there are no more steps to be run

Parameters:
  • part (Part) – The part that has attached to the Hook
  • context (Context) – Context that should be used to perform operations on child blocks
class malcolm.modules.scanning.hooks.PauseHook(part: Anno(name='APart', typ=<class 'malcolm.core.part.Part'>, description='The part that has attached to the Hook'), context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), **kwargs)[source]

Called at pause() to pause the current scan before Seek is called

Parameters:
  • part (Part) – The part that has attached to the Hook
  • context (Context) – Context that should be used to perform operations on child blocks
class malcolm.modules.scanning.hooks.SeekHook(part: Anno(name='APart', typ=<class 'malcolm.core.part.Part'>, description='The part that has attached to the Hook'), context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), completed_steps: Anno(name='ACompletedSteps', typ=<class 'int'>, description='Number of steps already completed'), steps_to_do: Anno(name='AStepsToDo', typ=<class 'int'>, description='Number of steps we should configure for'), part_info: Anno(name='APartInfo', typ=(<class 'str'>, annotypes._array.Array[malcolm.core.info.Info]), description='The Infos returned from other Parts'), generator: Anno(name='AGenerator', typ=<MagicMock name='mock.CompoundGenerator' id='139916666047248'>, description='Generator instance providing specification for scan'), axesToMove: Anno(name='AAxesToMove', typ=<class 'str'>, description='List of axes in inner dimension of generator that should be moved'), **kwargs)[source]

Called at seek() or at the end of pause() to reconfigure for a different number of completed_steps

Parameters:
  • part (Part) – The part that has attached to the Hook
  • context (Context) – Context that should be used to perform operations on child blocks
  • completed_steps (int) – Number of steps already completed
  • steps_to_do (int) – Number of steps we should configure for
  • part_info – The Infos returned from other Parts
  • generator – Generator instance providing specification for scan
  • axesToMove (str) – List of axes in inner dimension of generator that should be moved
class malcolm.modules.scanning.hooks.AbortHook(part: Anno(name='APart', typ=<class 'malcolm.core.part.Part'>, description='The part that has attached to the Hook'), context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), **kwargs)[source]

Called at abort() to stop the current scan

Parameters:
  • part (Part) – The part that has attached to the Hook
  • context (Context) – Context that should be used to perform operations on child blocks