pyhs3.axes.DomainCoordinateAxis

class pyhs3.axes.DomainCoordinateAxis(**data)

Axis for domain coordinates with optional bounds.

Represents a coordinate axis in a parameter domain, where bounds may be fully specified, partially specified, or unbounded (infinite).

name

Name of the axis/variable

min

Minimum value (optional, defaults to -inf)

max

Maximum value (optional, defaults to +inf)

Examples

Create an unbounded domain axis:

>>> from pyhs3.axes import DomainCoordinateAxis
>>> axis = DomainCoordinateAxis(name="x")
>>> axis
DomainCoordinateAxis(x ∈ (-∞, +∞))

Create a lower-bounded domain:

>>> axis = DomainCoordinateAxis(name="x", min=-5)
>>> axis
DomainCoordinateAxis(x ∈ [-5, +∞))

Create an upper-bounded domain:

>>> axis = DomainCoordinateAxis(name="x", max=10)
>>> axis
DomainCoordinateAxis(x ∈ (-∞, 10])

Create a fully bounded domain:

>>> axis = DomainCoordinateAxis(name="x", min=0, max=1)
>>> axis
DomainCoordinateAxis(x ∈ [0, 1])

Integers are displayed without trailing .0:

>>> axis = DomainCoordinateAxis(name="x", min=0.0, max=5.0)
>>> axis
DomainCoordinateAxis(x ∈ [0, 5])

Parameters:

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.
check_min_le_max()	Validate that max >= min when both are provided.
construct([_fields_set])
copy(*[, include, exclude, update, deep])	Returns a copy of the model.
dict(*[, include, exclude, by_alias, ...])
from_orm(obj)
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, /)	Override this method to perform additional initialization after __init__ and model_construct.
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)

Attributes

max	Returns defined maximum or (positive) np.inf
min	Returns defined minimum or (negative) np.inf
model_computed_fields
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_extra	Get extra fields set during validation.
model_fields
model_fields_set	Returns the set of fields that have been explicitly set on this model instance.
v_min
v_max
name