Companion#

class phise.Companion(
c: float,
ρ: Quantity,
θ: Quantity,
name: str = 'Unnamed Companion',
)[source]#

Bases: object

Point-like astronomical companion.

Parameters:

  • c (float) – Contrast relative to the host star (must be >= 0).

  • ρ (u.Quantity) – Angular separation (e.g., 100 * u.mas).

  • θ (u.Quantity) – Parallactic angle (e.g., 0.1 * u.rad).

  • name (str, optional) – Readable companion name.

Raises:

  • TypeError – If provided types are not as expected.

  • ValueError – If invalid physical values are supplied (e.g., negative contrast).

property c: float#

Companion contrast (dimensionless).

Returns:

Positive contrast value.

Return type:

float

property ρ: Quantity#

Angular separation (u.Quantity in mas).

Returns:

Separation in milliarcseconds (mas).

Return type:

u.Quantity

property θ: Quantity#

Parallactic angle (u.Quantity in radians).

Returns:

Angle in radians.

Return type:

u.Quantity

property parent_target: Target#

Read-only reference to the parent Target object.

Any direct assignment attempts will raise; the relation is set by the parent.

property name: str#

Readable companion name.

Returns:

Name of the companion.

Return type:

str