RMSF Mean Variant Facade

GitHub Link to Code.

Facade exposing per-atom and per-residue RMSF services using mean metric.

class mdxplain.analysis.structure.services.rmsf_mean_variant_facade.RMSFMeanVariantFacade(pipeline_data: PipelineData | None)

Expose per-atom and per-residue RMSF services using mean metric.

Lazily initialises the per-atom service and the residue aggregation facade, ensuring both reuse the same pipeline context and mean deviation metric.

Returns

RMSFMeanVariantFacade: Helper object that provides access to per-atom and per-residue RMSF services using the mean metric.

Examples

>>> facade = RMSFMeanVariantFacade(pipeline_data)
>>> isinstance(facade.per_atom, RMSFPerAtomService)
True

__init__(pipeline_data: PipelineData | None) → None

Store the pipeline context with mean metric for child services.

Ensures that pipeline data was injected prior to accessing RMSF services and records the mean metric shared by per-atom and per-residue computations.

Parameters

pipeline_dataPipelineData | None: Pipeline context injected by the analysis manager.

Returns

None: The initializer does not return anything.

Examples

>>> facade = RMSFMeanVariantFacade(pipeline_data)
>>> isinstance(facade, RMSFMeanVariantFacade)
True

property per_atom: RMSFPerAtomService

Access the per-atom RMSF service using the mean metric.

Lazily instantiates the per-atom RMSF service using the stored pipeline data and mean deviation metric.

Parameters

None: This property does not accept parameters.

Returns

RMSFPerAtomService: Mean-specific per-atom RMSF service exposing to_*_reference helper.

Examples

>>> facade = RMSFMeanVariantFacade(pipeline_data)
>>> service = facade.per_atom
>>> service.metric
'mean'

property per_residue: RMSFPerResidueAggregationSelectionFacade

Access the per-residue RMSF helper using the mean metric.

Lazily instantiates the residue aggregation selection facade using the stored pipeline data and mean deviation metric.

Parameters

None: This property does not accept parameters.

Returns

RMSFPerResidueAggregationSelectionFacade: Facade exposing residue-level RMSF aggregation selection for the mean metric.

Examples

>>> facade = RMSFMeanVariantFacade(pipeline_data)
>>> per_residue = facade.per_residue
>>> isinstance(per_residue, RMSFPerResidueAggregationSelectionFacade)
True