Calibration Constant
This module contains functions and classes for managing calibration constants in pipelines that are intended to be modifiable by RiskEffect components. Population attributable fractions (PAFs) can often be used interchangeably with calibration constants.
- vivarium_public_health.causal_factor.calibration_constant.get_calibration_constant_pipeline_name(target_pipeline_name)[source]
Return the calibration constant pipeline name for a target pipeline.
- vivarium_public_health.causal_factor.calibration_constant.register_risk_affected_attribute_producer(builder, name, source, required_resources=(), additional_post_processors=())[source]
Helper function to register a pipeline that can be modified by RiskEffect components.
- Parameters:
builder (
Builder) – The Builder object to use for registration.name (
str) – The name of the pipeline to register.source (
Callable[...,Series]) – The source for the attribute pipeline. This can be a callable or a list of column names. If a list of column names is provided, the component that is registering this attribute producer must be the one that creates those columns.required_resources (
Sequence[str]) – A list of resources that the producer requires. A string represents a population attribute.additional_post_processors (
AttributePostProcessor|Sequence[AttributePostProcessor]) – An AttributePostProcessor or list of AttributePostProcessors to apply in addition to the calibration constant post-processor. These will be applied after the calibration constant post-processor.
- Return type:
- vivarium_public_health.causal_factor.calibration_constant.register_risk_affected_rate_producer(builder, name, source, required_resources=(), additional_post_processors=())[source]
Helper function to register a rate pipeline that can be modified by RiskEffect components.
- Parameters:
builder (
Builder) – The Builder object to use for registration.name (
str) – The name of the pipeline to register.source (
Callable[...,Series]) – The source for the rate pipeline. This can be a callable or a list of column names. If a list of column names is provided, the component that is registering this rate producer must be the one that creates those columns.required_resources (
Sequence[str]) – A list of resources that the producer requires. A string represents a population attribute.additional_post_processors (
AttributePostProcessor|Sequence[AttributePostProcessor]) – An AttributePostProcessor or list of AttributePostProcessors to apply in addition to the calibration constant post-processor. These will be applied after the calibration constant post-processor.
- Return type: