pleiades.processing.normalization module

Router for facility-specific normalization implementations.

This module provides the main entry point for neutron imaging normalization, delegating to appropriate facility-specific implementations based on the facility parameter.

pleiades.processing.normalization.normalization(list_sample_folders: List[str] | str, list_obs_folders: List[str] | str, nexus_path: str | None = None, roi: Roi | None = None, facility: Facility = 'ornl', combine_mode: bool = False, output_folder: str | None = None, **kwargs) → List[Transmission][source]

Main entry point for neutron imaging normalization.

Routes to facility-specific implementations based on the facility parameter.

Parameters:

  • list_sample_folders – List of sample folders or single folder path

  • list_obs_folders – List of open beam folders or single folder path

  • nexus_path – Path to nexus directory (for ORNL)

  • roi – Optional region of interest

  • facility – Facility identifier (ornl, lanl, etc.)

  • combine_mode – If True, combine all runs before processing

  • output_folder – Optional folder to save results

  • **kwargs – Additional facility-specific parameters

Returns:

Transmission objects containing normalized data

Return type:

List[Transmission]

Raises:

NotImplementedError – If facility is not supported

Example

>>> from pleiades.processing import normalization, Facility, Roi
>>>
>>> # Use ORNL implementation
>>> results = normalization(
...     list_sample_folders=["sample1", "sample2"],
...     list_obs_folders=["ob1", "ob2"],
...     facility=Facility.ornl
... )