pleiades.sammy.parameters.background module

Parsers and containers for SAMMY’s Card Set 13 background function parameters.

This module implements parsers and containers for Card Set 13 background parameters which can appear in either the PARameter or INPut file.

Format specification from Table VI B.2: Card Set 13 contains background function parameters with distinct formats: 1. CONST - Constant background 2. EXPON - Exponential background 3. POWER - Power law background 4. EXPLN - Exponential with logarithmic terms 5. T-PNT - Point-wise linear function of time 6. E-PNT - Point-wise linear function of energy 7. TFILE - File-based time function 8. EFILE - File-based energy function 9. AETOB - Power of energy

Currently unimplemented - placeholder for future development.

class pleiades.sammy.parameters.background.BackgroundType(value)

Bases: str, Enum

Types of background functions available.

CONST = 'CONST'

EXPON = 'EXPON'

POWER = 'POWER'

EXPLN = 'EXPLN'

T_PNT = 'T-PNT'

E_PNT = 'E-PNT'

TFILE = 'TFILE'

EFILE = 'EFILE'

AETOB = 'AETOB'

class pleiades.sammy.parameters.background.BackgroundParameters(*, type: BackgroundType)

Bases: BaseModel

Container for Card Set 13 background function parameters.

Currently unimplemented - placeholder for future development.

Format specification from Table VI B.2: Cols Format Variable Description 1-80 A WHAT “BACKGround functions”

Followed by one or more background function definitions.

type: BackgroundType

classmethod from_lines(lines: List[str]) → BackgroundParameters

Parse background parameters from fixed-width format lines.

Parameters:

lines – List of input lines for background parameters

Raises:

NotImplementedError – This class is not yet implemented

to_lines() → List[str]

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].