gwkokab.parameters

Classes

Parameters	Enumeration of common parameter names used in GWKokab.
RelationMesh

Functions

default_relation_mesh(→ RelationMesh)

Constructs the default relation mesh with common gravitational wave parameter

Module Contents

class gwkokab.parameters.Parameters

Bases: str, enum.Enum

Enumeration of common parameter names used in GWKokab.

Initialize self. See help(type(self)) for accurate signature.

CHIRP_MASS = 'chirp_mass'

CHIRP_MASS_DETECTOR = 'chirp_mass_detector'

CHIRP_MASS_SOURCE = 'chirp_mass_source'

CHI_1 = 'chi_1'

CHI_2 = 'chi_2'

CHI_MINUS = 'chiminus'

COS_IOTA = 'cos_iota'

COS_TILT_1 = 'cos_tilt_1'

COS_TILT_2 = 'cos_tilt_2'

DELTA_M = 'delta_m'

DETECTION_TIME = 'detection_time'

ECCENTRICITY = 'eccentricity'

EFFECTIVE_SPIN = 'chi_eff'

LUMINOSITY_DISTANCE = 'luminosity_distance'

MASS_RATIO = 'mass_ratio'

MEAN_ANOMALY = 'mean_anomaly'

PHI_1 = 'phi_1'

PHI_12 = 'phi_12'

PHI_2 = 'phi_2'

PHI_ORB = 'phi_orb'

POLARIZATION_ANGLE = 'psi'

PRECESSING_SPIN = 'chi_p'

PRIMARY_MASS_DETECTED = 'mass_1'

PRIMARY_MASS_SOURCE = 'mass_1_source'

PRIMARY_SPIN_MAGNITUDE = 'a_1'

PRIMARY_SPIN_X = 'spin_1x'

PRIMARY_SPIN_Y = 'spin_1y'

PRIMARY_SPIN_Z = 'spin_1z'

REDSHIFT = 'redshift'

REDUCED_MASS = 'reduced_mass'

RIGHT_ASCENSION = 'ra'

SECONDARY_MASS_DETECTED = 'mass_2'

SECONDARY_MASS_SOURCE = 'mass_2_source'

SECONDARY_SPIN_MAGNITUDE = 'a_2'

SECONDARY_SPIN_X = 'spin_2x'

SECONDARY_SPIN_Y = 'spin_2y'

SECONDARY_SPIN_Z = 'spin_2z'

SIN_DECLINATION = 'dec'

SYMMETRIC_MASS_RATIO = 'symmetric_mass_ratio'

TOTAL_MASS = 'total_mass'

class gwkokab.parameters.RelationMesh

add_rule(inputs: Tuple[Any, Ellipsis], output: Any, func: Callable)

Adds a rule.

Multiple rules can target the same output.

derive_only(initial_state: Dict[Any, Any], targets: Set[Any]) → Dict[Any, Any]

Derives specified targets, allowing intermediate parameters to be computed as needed.

resolve(initial_state: Dict[Any, Any]) → Dict[Any, Any]

resolve_from_arrays(initial_state: numpy.ndarray, param_order: Tuple[Any, Ellipsis]) → Tuple[numpy.ndarray, Tuple[Any, Ellipsis]]

rules = []

gwkokab.parameters.default_relation_mesh() → RelationMesh

Constructs the default relation mesh with common gravitational wave parameter relations.