Conversion
Conversion functions for parameters.
Functions¶
compute_chirp_mass_from_mass_1_mass_2(mass_1: Array, mass_2: Array) -> Array
Compute the chirp mass from the component masses of the binary.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mass_1
|
Array
|
The mass of the first component object in the binary (in solar masses). |
required |
mass_2
|
Array
|
The mass of the second component object in the binary (in solar masses). |
required |
Returns:
| Type | Description |
|---|---|
Array
|
The chirp mass of the binary (in solar masses). |
compute_mass_ratio_from_mass_1_mass_2(mass_1: Array, mass_2: Array) -> Array
Compute the mass ratio from the component masses of the binary.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mass_1
|
Array
|
The mass of the first component object in the binary (in solar masses). |
required |
mass_2
|
Array
|
The mass of the second component object in the binary (in solar masses). |
required |
Returns:
| Type | Description |
|---|---|
Array
|
The mass ratio, m2/m1, where m2 <= m1. |
compute_source_frame_mass_from_detector_frame_mass(detector_frame_mass: Array, redshift: Array) -> Array
Compute the source frame mass from the detector frame mass.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
detector_frame_mass
|
Array
|
Detector frame mass (in solar mass). |
required |
redshift
|
Array
|
Redshift. |
required |
Returns:
| Type | Description |
|---|---|
Array
|
Source frame mass (in solar mass). |
compute_symmetric_mass_ratio_from_mass_1_mass_2(mass_1: Array, mass_2: Array) -> Array
Compute the symmetric mass ratio from the component masses of the binary.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mass_1
|
Array
|
The mass of the first component object in the binary (in solar masses). |
required |
mass_2
|
Array
|
The mass of the second component object in the binary (in solar masses). |
required |
Returns:
| Type | Description |
|---|---|
Array
|
The symmetric mass ratio of the binary. |
compute_total_mass_from_mass_1_mass_2(mass_1: Array, mass_2: Array) -> Array
Compute the total mass from the component masses of the binary.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mass_1
|
Array
|
The mass of the first component object in the binary (in solar masses). |
required |
mass_2
|
Array
|
The mass of the second component object in the binary (in solar masses). |
required |
Returns:
| Type | Description |
|---|---|
Array
|
The total mass of the binary (in solar masses). |