across.tools.core.schemas.visibility

Classes

ConstrainedDate

Represents a constrained date with associated constraint information.

Window

Represents a time window bounded by constrained dates.

ConstraintReason

Represents the reasons for constraints at the boundaries of a visibility window.

VisibilityWindow

Represents a visibility window with duration and constraint information.

VisibilityComputedValues

A class to hold computed values used in constraint calculations.

Module Contents

class ConstrainedDate(/, **data)[source]

Bases: across.tools.core.schemas.base.BaseSchema

Represents a constrained date with associated constraint information.

datetime[source]

The time of the constrained date.

constraint[source]

The type of constraint active at this time.

observatory_id[source]

UUID of the observatory or instrument associated with this constraint.

datetime: across.tools.core.schemas.custom_types.AstropyDateTime[source]
constraint: across.tools.core.enums.constraint_type.ConstraintType[source]
observatory_id: uuid.UUID[source]
class Window(/, **data)[source]

Bases: across.tools.core.schemas.base.BaseSchema

Represents a time window bounded by constrained dates.

begin[source]

The start of the window with its associated constraint.

end[source]

The end of the window with its associated constraint.

begin: ConstrainedDate[source]
end: ConstrainedDate[source]
class ConstraintReason(/, **data)[source]

Bases: across.tools.core.schemas.base.BaseSchema

Represents the reasons for constraints at the boundaries of a visibility window.

start_reason[source]

Human-readable description of the constraint that ends before the window starts.

end_reason[source]

Human-readable description of the constraint that begins after the window ends.

start_reason: str[source]
end_reason: str[source]
class VisibilityWindow(/, **data)[source]

Bases: across.tools.core.schemas.base.BaseSchema

Represents a visibility window with duration and constraint information.

window[source]

The time window defining the start and end of the visibility period.

max_visibility_duration[source]

Maximum visibility duration in seconds for this window.

constraint_reason[source]

The reasons for constraints at the window boundaries.

window: Window[source]
max_visibility_duration: int[source]
constraint_reason: ConstraintReason[source]
class VisibilityComputedValues(/, **data)[source]

Bases: across.tools.core.schemas.base.BaseSchema

A class to hold computed values used in constraint calculations.

sun_angle[source]

Angular distance between the Sun and the target coordinate.

moon_angle[source]

Angular distance between the Moon and the target coordinate.

earth_angle[source]

Angular distance between the Earth limb and the target coordinate.

alt_az[source]

Altitude-azimuth coordinates of the target from the observatory.

sun_angle: across.tools.core.schemas.custom_types.AstropyAngles | None = None[source]
moon_angle: across.tools.core.schemas.custom_types.AstropyAngles | None = None[source]
earth_angle: across.tools.core.schemas.custom_types.AstropyAngles | None = None[source]
alt_az: across.tools.core.schemas.custom_types.AstropyAltAz | None = None[source]
air_mass: across.tools.core.schemas.custom_types.NumpyArray | None = None[source]
sun_altitude: across.tools.core.schemas.custom_types.AstropyAngles | None = None[source]
body_separation: dict[str, across.tools.core.schemas.custom_types.AstropyAngles] | None = None[source]
body_coordinates: dict[str, across.tools.core.schemas.custom_types.AstropySkyCoords] | None = None[source]
body_magnitude: dict[str, across.tools.core.schemas.custom_types.NumpyArray] | None = None[source]
galactic_bulge_separation: across.tools.core.schemas.custom_types.AstropyAngles | None = None[source]
merge(other)[source]

Merge another VisibilityComputedValues into this one.

Always updates values from the other object if they are not None.

Parameters:

other (VisibilityComputedValues) – Another VisibilityComputedValues instance to merge from.