snapred.meta.mantid package

Submodules

snapred.meta.mantid.AllowedPeakTypes module

class snapred.meta.mantid.AllowedPeakTypes.PeakFunctionEnum(value)

Bases: StrEnum

ASYMMETRICPEARSONVII = 'AsymmetricPearsonVII'

BACKTOBACKEXPONENTIAL = 'BackToBackExponential'

BK2BKEXPCONVPV = 'Bk2BkExpConvPV'

DELTAFUNCTION = 'DeltaFunction'

ELASTICDIFFROTDISCRETECIRCLE = 'ElasticDiffRotDiscreteCircle'

ELASTICDIFFSPHERE = 'ElasticDiffSphere'

ELASTICISOROTDIFF = 'ElasticIsoRotDiff'

EXAMPLEPEAKFUNCTION = 'ExamplePeakFunction'

GAUSSIAN = 'Gaussian'

IKEDACARPENTERPV = 'IkedaCarpenterPV'

LORENTZIAN = 'Lorentzian'

PSEUDOVOIGT = 'PseudoVoigt'

VOIGT = 'Voigt'

class snapred.meta.mantid.AllowedPeakTypes.SymmetricPeakEnum(value)

Bases: StrEnum

GAUSSIAN = 'Gaussian'

LORENTZIAN = 'Lorentzian'

PSEUDOVOIGT = 'PseudoVoigt'

snapred.meta.mantid.WorkspaceNameGenerator module

class snapred.meta.mantid.WorkspaceNameGenerator.NameBuilder(wsType: WorkspaceType, template: str, keys: List[str], delimiter: str, **kwargs)

Bases: object

build()

tokens(*args: Tuple[str])

class snapred.meta.mantid.WorkspaceNameGenerator.ValueFormat

Bases: object

class FormatTuple(WORKSPACE, PATH)

Bases: NamedTuple

PATH: str

Alias for field number 1

WORKSPACE: str

Alias for field number 0

numberTagFormat = ('{number}', '{number}')

runNumberFormat = ('{runNumber:>06}', '{runNumber:>06}')

stateIdFormat = ('{stateId:8.8}', '{stateId}')

timestampFormat = ('%Y-%m-%dT%H%M%S%z', '%Y-%m-%dT%H%M%S%z')

versionFormat = ('v{version:04d}', 'v_{version:04d}')

class snapred.meta.mantid.WorkspaceNameGenerator.ValueFormatter

Bases: object

classmethod formatNumberTag(number: int, fmt='{number}')

classmethod formatRunNumber(runNumber: str, fmt='{runNumber:>06}')

classmethod formatStateId(stateId: str, fmt='{stateId:8.8}')

classmethod formatTimestamp(timestamp: float | None, fmt='%Y-%m-%dT%H%M%S%z')

static formatValueByKey(key: str, value: any)

classmethod formatVersion(version: int | None, fmt='v{version:04d}')

classmethod pathNumberTag(number: int)

classmethod pathRunNumber(runNumber: str)

classmethod pathStateId(stateId: str)

classmethod pathTimestamp(timestamp: float)

classmethod pathVersion(version: int)

class snapred.meta.mantid.WorkspaceNameGenerator.WorkspaceName(value: Any)

Bases: str

property builder: NameBuilder | None

classmethod instance(value, builder: NameBuilder | None = None)

toString() → str

tokens(*args: Tuple[str])

class snapred.meta.mantid.WorkspaceNameGenerator.WorkspaceType(value)

Bases: StrEnum

ARTIFICIAL_NORMALIZATION_PREVIEW = 'artificialNormalizationPreview'

DIFFCAL_DIAG = 'diffCalDiagnostic'

DIFFCAL_INPUT = 'diffCalInput'

DIFFCAL_MASK = 'diffCalMask'

DIFFCAL_METRIC = 'diffCalMetric'

DIFFCAL_OUTPUT = 'diffCalOutput'

DIFFCAL_TABLE = 'diffCalTable'

DIFFCAL_TIMED_METRIC = 'diffCalTimedMetric'

FOCUSED_RAW_VANADIUM = 'focusedRawVanadium'

GROUPING = 'grouping'

LITE_DATA_MAP = 'liteDataMap'

MONITOR = 'monitor'

RAW_VANADIUM = 'rawVanadium'

REDUCTION_DIAGNOSTIC_OUTPUT = 'reductionDiagnosticOutput'

REDUCTION_OUTPUT = 'reductionOutput'

REDUCTION_OUTPUT_GROUP = 'reductionOutputGroup'

REDUCTION_PIXEL_MASK = 'reductionPixelMask'

REDUCTION_USER_PIXEL_MASK = 'userPixelMask'

RESIDUAL = 'normCalResidual'

RUN = 'run'

SMOOTHED_FOCUSED_RAW_VANADIUM = 'smoothedFocusedRawVanadium'

Module contents