Uniform2dModel

jeanspy.model.Uniform2dModel

See methods and properties for individual lookup pages, or the alphabetical API dictionary to search all classes. The full class contract and existing member anchors are retained below.

class jeanspy.model.Uniform2dModel(show_init=False, submodels=None, **params)

Bases: jeanspy.model.StellarModel

Unit-integral uniform projected disk with radius Rmax_pc in pc.

density_2d(R_pc) returns 1/(pi*Rmax_pc**2) for 0 <= R <= Rmax_pc and zero outside; cdf_R returns the clipped dimensionless radial CDF. Outputs follow the scalar/array radius shape. The inherited density_2d_truncated can normalize an aperture inside the disk.

The disk radius must be positive and finite; NaN radii raise ValueError. There is no three-dimensional tracer: density_3d raises NotImplementedError, so this profile cannot feed a 3-D Jeans solver. Half-light, mean-density and log-density methods are not provided. This is a stateful NumPy/SciPy model without JAX differentiation. See examples/docs_profiles.py.

cdf_R(R_pc)

Evaluate projected probability inside a circular radius.

Notes

Inputs and units. R_pc is a scalar or NumPy array of projected radii in pc.

Returns and shape. Dimensionless cumulative probability with input radius shape.

density(distance_from_center, dimension)

Dispatch to the projected or intrinsic normalized tracer density.

distance_from_center is a radius in pc. dimension must be ‘2d’ or ‘3d’, returning pc^-2 or pc^-3 respectively with the concrete profile’s input shape. An unsupported dimension raises ValueError.

density_2d(R_pc)

Evaluate normalized projected tracer density.

Notes

Inputs and units. R_pc is a scalar or NumPy array of projected radii in pc.

Returns and shape. pc^-2 with input radius shape.

density_2d_truncated(R_pc, R_trunc_pc)

Return the normalized 2-D density truncated at R_trunc_pc.

The normalization satisfies

\[\int_0^{R_\mathrm{trunc}} 2\pi R\,\Sigma_\mathrm{trunc}(R)\,dR = 1.\]

Notes

Inputs and units. R_pc is a nonnegative finite scalar/array in pc; R_trunc_pc is a positive finite scalar cutoff in pc.

Returns and shape. Normalized surface density in pc^-2 with radius shape, zero for R>``R_trunc_pc``.

Validity. Requires a concrete density_2d and cdf_R with positive CDF at the cutoff.

density_3d(r_pc)

This projected uniform-disk model has no implemented 3-D density.

The radius argument r_pc is in pc but is not evaluated. Every call raises NotImplementedError; there is no numerical return value.

is_required_param_names(param_names_candidates)

Test a sequence of names against this component’s required parameters.

Returns a list of bool with the same length and order as param_names_candidates. Submodel requirements are not included.

name = 'uniform Model'

property params_all

Return a flattened Parameters copy of this model and its submodels.

Values retain their physical units. Later submodels overwrite duplicate names; use params_all_with_model_name to retain role-qualified names.

property params_all_with_model_name

Return a new Parameters mapping with submodel-role prefixes.

Nested names use role:parameter notation. Values retain their physical units; this operation copies the mapping, not nested mutable values.

required_models = {}

required_param_names = ['Rmax_pc']

property required_param_names_combined

Return this model’s and all nested submodels’ required parameter names.

The result is a list in traversal order; duplicate names are retained.

sampling_identity(sampled_names=())

Configuration and fixed parameters, excluding changing MCMC coordinates.

update(new_params=None, **kwargs)

Replace named parameters in the owning components.

Notes

Inputs and units. new_params is an optional mapping/Parameters/Series; keyword values are additional replacements. Names are physical names declared by this model and its components. Unknown names raise ValueError before any parameters are changed.

Returns and shape. None; mutates component parameters. params_all returns the resulting flattened copy.