Skip to content

Parameters

parameters

Definition of parameters for different systems.

Classes

BBHParameters dataclass 

BBHParameters(mass_1: Array, mass_2: Array, spin_1x: Array, spin_1y: Array, spin_1z: Array, spin_2x: Array, spin_2y: Array, spin_2z: Array, eccentricity: Array, distance: Array, coa_phase: Array, inclination: Array, theta_jn: Array, long_asc_nodes: Array, mean_per_ano: Array, coa_time: Array, right_ascension: Array, declination: Array, polarization_angle: Array, redshift: Array, f_ref: Array, extra: Mapping[str, Any] = dict())

Parameters for binary black holes.

Attributes
mass_1 instance-attribute 
mass_1: Array

The mass of the first component object in the binary (in solar masses).

mass_2 instance-attribute 
mass_2: Array

The mass of the second component object in the binary (in solar masses).

spin_1x instance-attribute 
spin_1x: Array

The x component of the first binary component's dimensionless spin.

spin_1y instance-attribute 
spin_1y: Array

The y component of the first binary component's dimensionless spin.

spin_1z instance-attribute 
spin_1z: Array

The z component of the first binary component's dimensionless spin.

spin_2x instance-attribute 
spin_2x: Array

The x component of the second binary component's dimensionless spin.

spin_2y instance-attribute 
spin_2y: Array

The y component of the second binary component's dimensionless spin.

spin_2z instance-attribute 
spin_2z: Array

The z component of the second binary component's dimensionless spin.

eccentricity instance-attribute 
eccentricity: Array

Eccentricity.

distance instance-attribute 
distance: Array

Luminosity distance to the binary (in Mpc).

coa_phase instance-attribute 
coa_phase: Array

Coalescence phase of the binary (in rad).

inclination instance-attribute 
inclination: Array

Inclination (rad), defined as the angle between the orbital angular momentum L and the line-of-sight at the reference frequency.

theta_jn instance-attribute 
theta_jn: Array

The angle between the total angular momentum J and the line-of-sight.

long_asc_nodes instance-attribute 
long_asc_nodes: Array

Longitude of ascending nodes axis (rad).

mean_per_ano instance-attribute 
mean_per_ano: Array

Mean anomaly of the periastron (rad).

coa_time instance-attribute 
coa_time: Array

Coalescence time (s) is the time when a GW reaches the origin of a certain coordinate system.

right_ascension instance-attribute 
right_ascension: Array

Right ascension (rad).

declination instance-attribute 
declination: Array

Declination (rad).

polarization_angle instance-attribute 
polarization_angle: Array

Polarization angle (rad) in a certain coordinate system.

redshift instance-attribute 
redshift: Array

Redshift.

f_ref instance-attribute 
f_ref: Array

The reference frequency that defines the spin components.

extra class-attribute instance-attribute 
extra: Mapping[str, Any] = field(default_factory=dict, metadata={'static': True})

Extra parameters.

chirp_mass property 
chirp_mass: Array

Get the chirp mass from the component masses.

Returns:

Type Description
Array

The chirp mass of the binary (in solar masses).
symmetric_mass_ratio property 
symmetric_mass_ratio: Array

Get the symmetric mass ratio from the component masses.

Returns:

Type Description
Array

The symmetric mass ratio of the binary.
total_mass property 
total_mass: Array

Get the total mass from the component masses.

Returns:

Type Description
Array

The total mass of the binary (in solar masses).
mass_ratio property 
mass_ratio: Array

Get the mass ratio from the component masses.

Returns:

Type Description
Array

The mass ratio, mass_2 / mass_1, where mass_2 <= mass_1.
source_frame_mass_1 property 
source_frame_mass_1: Array

Get the source frame mass of the first component.

Returns:

Type Description
Array

The mass of the first component object in the source frame (in solar masses).
source_frame_mass_2 property 
source_frame_mass_2: Array

Get the source frame mass of the second component.

Returns:

Type Description
Array

The mass of the second component object in the source frame (in solar masses).
source_frame_chirp_mass property 
source_frame_chirp_mass: Array

Get the source frame chirp mass.

Returns:

Type Description
Array

The chirp mass of the binary in the source frame (in solar masses).
source_frame_total_mass property 
source_frame_total_mass: Array

Get the source frame total mass.

Returns:

Type Description
Array

The total mass of the binary in the source frame (in solar masses).