MRP.MRPMagnetTypes

collection of magnet specifications for different magnet types such as cubic n45,…

exception MRPMagnetTypes.MRPMagnetTypeException(message='MRPMagnetTypeException thrown')
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

class MRPMagnetTypes.MagnetType(value)

Enum class for holding some basic information about a measured magnet. Please add further magnet definition here.

get_dimension() -> (<class 'int'>, <class 'int'>, <class 'int'>)

Returns the dimension in mm from the selected magnet type

Returns:

Returns (x, y, z) on a cubic magnet, (d h, 0) on a cylindrical magnet

Return type:

tuple

get_height() int

Returns the maximum height of the selected magnet type. The function returns the max value of (x,y,z) or (d,h)

Returns:

max value of the dimension vector

Return type:

int