Parameter

class cosmic.sample.stroopwafel.Parameter(name: str, min_value: float, max_value: float, dist: str | Distribution = 'uniform')[source]

Bases: object

A single dimension in the parameter space.

Parameters:
namestr

Name of the parameter (used for column ordering).

min_valuefloat

Lower bound, always in physical space (e.g. solar masses for 'kroupa', days for 'sana', km/s for 'disberg'). The parameter’s distribution maps this into sampling space via its transform.

max_valuefloat

Upper bound, in physical space (same convention as min_value).

diststr or ~cosmic.sample.stroopwafel.distributions.Distribution, optional

The prior distribution, given either as a name registered in DISTRIBUTIONS (e.g. 'kroupa', 'sana', 'flat_in_log') or as a Distribution instance for custom priors. By default 'uniform'.

Attributes:
distributionDistribution

The resolved distribution instance.

lo, hifloat

The bounds in sampling space (min_value/max_value passed through distribution.transform).

Attributes Summary

Attributes Documentation

dist: str | Distribution = 'uniform'[source]
max_value: float = <dataclasses._MISSING_TYPE object>[source]
min_value: float = <dataclasses._MISSING_TYPE object>[source]
name: str = <dataclasses._MISSING_TYPE object>[source]