pleiades.sammy.parameters.resolution module
Parsers and containers for SAMMY’s Card Set 14 resolution function parameters.
This module implements parsers and containers for Card Set 14 resolution parameters which can appear in either the PARameter or INPut file.
Format specification from Table VI B.2: Card Set 14 contains resolution function parameters with distinct formats: 1. RPI Resolution function 2. GEEL resolution function 3. GELINA resolution function 4. NTOF resolution function 5. User-defined resolution function
Each type has its own multi-line parameter structure. Currently unimplemented - placeholder for future development.
- class pleiades.sammy.parameters.resolution.ResolutionType(value)[source]
-
Types of resolution functions available.
- RPI = 'RPI Resolution'
- GEEL = 'GEEL resolution'
- GELINA = 'GELINa resolution'
- NTOF = 'NTOF resolution'
- USER = 'USER-Defined resolution function'
- class pleiades.sammy.parameters.resolution.ResolutionParameters(*, type: ResolutionType)[source]
Bases:
BaseModelContainer for Card Set 14 resolution function parameters.
Currently unimplemented - placeholder for future development.
Format specification from Table VI B.2: Different resolution types have different parameter structures:
RPI Resolution: - Optional burst width - Optional tau parameters - Optional lambda parameters - Optional A1 parameters - Optional exponential parameters - Optional channel parameters
GEEL Resolution: - Similar structure with different defaults
GELINA Resolution: - Similar structure with different defaults
NTOF Resolution: - Similar structure with different defaults
User-Defined Resolution: - Custom file-based definition
- type: ResolutionType
- classmethod from_lines(lines: List[str]) ResolutionParameters[source]
Parse resolution parameters from fixed-width format lines.
- Parameters:
lines – List of input lines for resolution parameters
- Raises:
NotImplementedError – This class is not yet implemented
- to_lines() List[str][source]
Convert parameters to fixed-width format lines.
- Raises:
NotImplementedError – This class is not yet implemented
- model_config = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class pleiades.sammy.parameters.resolution.RPIResolutionParameters(*, type: ResolutionType = ResolutionType.RPI)[source]
Bases:
ResolutionParametersContainer for RPI resolution function parameters.
Currently unimplemented - placeholder for future development. Format includes burst width, tau, lambda, A1, exponential and channel parameters.
- type: ResolutionType
- model_config = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class pleiades.sammy.parameters.resolution.GEELResolutionParameters(*, type: ResolutionType = ResolutionType.GEEL)[source]
Bases:
ResolutionParametersContainer for GEEL resolution function parameters.
Currently unimplemented - placeholder for future development. Similar format to RPI with different defaults.
- type: ResolutionType
- model_config = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class pleiades.sammy.parameters.resolution.GELINAResolutionParameters(*, type: ResolutionType = ResolutionType.GELINA)[source]
Bases:
ResolutionParametersContainer for GELINA resolution function parameters.
Currently unimplemented - placeholder for future development. Similar format to RPI with different defaults.
- type: ResolutionType
- model_config = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class pleiades.sammy.parameters.resolution.NTOFResolutionParameters(*, type: ResolutionType = ResolutionType.NTOF)[source]
Bases:
ResolutionParametersContainer for NTOF resolution function parameters.
Currently unimplemented - placeholder for future development. Similar format to RPI with different defaults.
- type: ResolutionType
- model_config = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class pleiades.sammy.parameters.resolution.UserResolutionParameters(*, type: ResolutionType = ResolutionType.USER)[source]
Bases:
ResolutionParametersContainer for user-defined resolution function parameters.
Currently unimplemented - placeholder for future development. Includes file-based definition capability.
- type: ResolutionType
- model_config = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].