vipr_reflectometry.reflectorch.predict package

Submodules

vipr_reflectometry.reflectorch.predict.reflectorch_predictor module

class vipr_reflectometry.reflectorch.predict.reflectorch_predictor.ReflectorchPredictor(**kw: Any)

Bases: PredictorHandler

Predictor handler for Reflectorch models.

class Meta

Bases: object

label = 'reflectorch_predictor'

class vipr_reflectometry.reflectorch.predict.reflectorch_predictor.ReflectorchPredictorParams(*, calc_pred_curve: bool = True, clip_prediction: bool = True, polish_prediction: bool = True, upper_phase_sld: float = 0.0, q_resolution: float | None = None, use_q_shift: bool = False, calc_pred_sld_profile: bool = True, calc_polished_sld_profile: bool = True, sld_profile_padding_left: float = 0.4, sld_profile_padding_right: float = 1.3, prior_bounds: ~typing.Any = <factory>, number_top_to_bottom: bool = True)

Bases: BaseModel

Parameters for the reflectorch predictor.

calc_polished_sld_profile: bool

calc_pred_curve: bool

calc_pred_sld_profile: bool

clip_prediction: bool

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

number_top_to_bottom: bool

polish_prediction: bool

prior_bounds: Any

q_resolution: float | None

sld_profile_padding_left: float

sld_profile_padding_right: float

upper_phase_sld: float

use_q_shift: bool

vipr_reflectometry.reflectorch.predict.reflectorch_predictor.load(app)

Register the ReflectorchPredictor handler with the application.

Module contents