pyhs3.domains.ProductDomain¶
- class pyhs3.domains.ProductDomain(**data)[source]¶
Product domain specification for multi-dimensional parameter spaces.
Defines a Cartesian product of axes to create multi-dimensional parameter domains. Used for specifying integration regions, parameter constraints, and likelihood evaluation domains in HS3 specifications.
The domain represents the Cartesian product: axis₁ x axis₂ x … x axisₙ where each axis defines a one-dimensional range.
- Parameters:
name – Name identifier for the domain
type – Domain type identifier (always “product_domain”)
axes – List of Axis specifications defining each dimension
data (
Any)
- __init__(**data)¶
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- Parameters:
data (
Any)
Methods
__init__(**data)Create a new model by parsing and validating input data from keyword arguments.
construct([_fields_set])copy(*[, include, exclude, update, deep])Returns a copy of the model.
dict(*[, include, exclude, by_alias, ...])from_orm(obj)get(axis_name[, default])Get axis bounds for a parameter name.
initialize_axes_map()Initialize the internal axes mapping for fast lookup.
json(*[, include, exclude, by_alias, ...])model_construct([_fields_set])Creates a new instance of the Model class with validated data.
model_copy(*[, update, deep])!!! abstract "Usage Documentation"
model_dump(*[, mode, include, exclude, ...])!!! abstract "Usage Documentation"
model_dump_json(*[, indent, ensure_ascii, ...])!!! abstract "Usage Documentation"
model_json_schema([by_alias, ref_template, ...])Generates a JSON schema for a model class.
model_parametrized_name(params)Compute the class name for parametrizations of generic classes.
model_post_init(context, /)This function is meant to behave like a BaseModel method to initialise private attributes.
model_rebuild(*[, force, raise_errors, ...])Try to rebuild the pydantic-core schema for the model.
model_validate(obj, *[, strict, extra, ...])Validate a pydantic model instance.
model_validate_json(json_data, *[, strict, ...])!!! abstract "Usage Documentation"
model_validate_strings(obj, *[, strict, ...])Validate the given object with string data against the Pydantic model.
parse_file(path, *[, content_type, ...])parse_obj(obj)parse_raw(b, *[, content_type, encoding, ...])schema([by_alias, ref_template])schema_json(*[, by_alias, ref_template])update_forward_refs(**localns)validate(value)validate_unique_axis_names()Validate that all axis names are unique within the domain.
Attributes
axis_namesList of axis names in this domain.
dimensionNumber of dimensions (axes) in this domain.
model_computed_fieldsmodel_configConfiguration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_extraGet extra fields set during validation.
model_fieldsmodel_fields_setReturns the set of fields that have been explicitly set on this model instance.
typeaxesname