malcolm.modules.adUtil.parts

class malcolm.modules.adUtil.parts.ReframePluginPart(name: Anno(name='APartName', typ=<class 'str'>, description='The name of the Part within the Controller'), mri: Anno(name='AMri', typ=<class 'str'>, description='Malcolm resource id of child object'), sample_freq: Anno(name='ASampleFreq', typ=<class 'float'>, description='Sample frequency of ADC signal in Hz') = 10000.0, gated_trigger: Anno(name='AGatedTrigger', typ=<class 'bool'>, description='Is the input trigger gated?') = False)[source]
Parameters

  • name (str) – The name of the Part within the Controller

  • mri (str) – Malcolm resource id of child object

  • sample_freq (float) – Sample frequency of ADC signal in Hz

  • gated_trigger (bool) – Is the input trigger gated?

on_validate(generator: Anno(name='AGenerator', typ=<class 'scanpointgenerator.core.compoundgenerator.CompoundGenerator'>, description='Generator instance providing specification for scan')) → Optional[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]][source]
Parameters

generator (CompoundGenerator) – Generator instance providing specification for scan

Returns

Parameters that need to be changed to make them compatible

Return type

ParameterTweakInfo