Access Windows¶

Access windows represent time periods when satellites can access ground locations.

AccessWindow¶

AccessWindow ¶

AccessWindow(window_open: Epoch, window_close: Epoch)

An access window representing a period of time when access constraints are satisfied.

AccessWindow stores the opening and closing times of an access period, along with computed properties for that window.

Parameters:

Name	Type	Description	Default
`window_open`	`Epoch`	Opening time of the access window	required
`window_close`	`Epoch`	Closing time of the access window	required

Example

import brahe as bh

# Create an access window
t_open = bh.Epoch(2024, 1, 1, 12, 0, 0.0)
t_close = bh.Epoch(2024, 1, 1, 12, 10, 0.0)
window = bh.AccessWindow(t_open, t_close)

# Access window properties
print(f"Duration: {window.duration()} seconds")
print(f"Midpoint: {window.midtime()}")

Initialize instance.

doc `class-attribute` ¶

__doc__ = 'An access window representing a period of time when access constraints are satisfied.\n\nAccessWindow stores the opening and closing times of an access period, along with\ncomputed properties for that window.\n\nArgs:\n    window_open (Epoch): Opening time of the access window\n    window_close (Epoch): Closing time of the access window\n\nExample:\n    ```python\n    import brahe as bh\n\n    # Create an access window\n    t_open = bh.Epoch(2024, 1, 1, 12, 0, 0.0)\n    t_close = bh.Epoch(2024, 1, 1, 12, 10, 0.0)\n    window = bh.AccessWindow(t_open, t_close)\n\n    # Access window properties\n    print(f"Duration: {window.duration()} seconds")\n    print(f"Midpoint: {window.midtime()}")\n    ```'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'.

module `class-attribute` ¶

__module__ = 'brahe._brahe'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'.

asc_dsc `property` ¶

asc_dsc: AscDsc

Get ascending/descending pass type.

Returns:

Name	Type	Description
`AscDsc`	`AscDsc`	Pass type enum value

azimuth_close `property` ¶

azimuth_close: float

Get azimuth angle at window closing (degrees, 0-360).

Returns:

Name	Type	Description
`float`	`float`	Azimuth at window close

azimuth_open `property` ¶

azimuth_open: float

Get azimuth angle at window opening (degrees, 0-360).

Returns:

Name	Type	Description
`float`	`float`	Azimuth at window open

duration `property` ¶

duration: float

Get the duration of the access window in seconds.

Returns:

Name	Type	Description
`float`	`float`	Duration in seconds

elevation_max `property` ¶

elevation_max: float

Get maximum elevation angle during access (degrees).

Returns:

Name	Type	Description
`float`	`float`	Maximum elevation angle

elevation_min `property` ¶

elevation_min: float

Get minimum elevation angle during access (degrees).

Returns:

Name	Type	Description
`float`	`float`	Minimum elevation angle

end `property` ¶

end: Epoch

Get the end time of the access window (alias for window_close).

Returns:

Name	Type	Description
`Epoch`	`Epoch`	Closing time of the window

id `property` ¶

id: Optional[int]

Get the access window numeric ID.

Returns:

Type	Description
`Optional[int]`	Optional[int]: Window ID, or None if not set

local_time `property` ¶

local_time: float

Get local solar time at window midpoint (seconds since midnight, 0-86400).

Returns:

Name	Type	Description
`float`	`float`	Local time in seconds

location_id `property` ¶

location_id: Optional[int]

Get the location ID if available.

Returns:

Type	Description
`Optional[int]`	Optional[int]: ID of the location, or None if not set

location_name `property` ¶

location_name: Optional[str]

Get the location name if available.

Returns:

Type	Description
`Optional[str]`	Optional[str]: Name of the location, or None if not set

location_uuid `property` ¶

location_uuid: Optional[str]

Get the location UUID if available.

Returns:

Type	Description
`Optional[str]`	Optional[str]: UUID of the location as string, or None if not set

look_direction `property` ¶

look_direction: LookDirection

Get look direction (Left or Right).

Returns:

Name	Type	Description
`LookDirection`	`LookDirection`	Look direction enum value

midtime `property` ¶

midtime: Epoch

Get the midpoint time of the access window.

Returns:

Name	Type	Description
`Epoch`	`Epoch`	Midpoint time (average of start and end)

name `property` ¶

name: Optional[str]

Get the access window name (auto-generated or user-set).

Returns:

Type	Description
`Optional[str]`	Optional[str]: Window name, or None if not set

off_nadir_max `property` ¶

off_nadir_max: float

Get maximum off-nadir angle during access (degrees).

Returns:

Name	Type	Description
`float`	`float`	Maximum off-nadir angle

off_nadir_min `property` ¶

off_nadir_min: float

Get minimum off-nadir angle during access (degrees).

Returns:

Name	Type	Description
`float`	`float`	Minimum off-nadir angle

properties `property` ¶

properties: AccessProperties

Get the access properties object.

Returns:

Name	Type	Description
`AccessProperties`	`AccessProperties`	Computed properties for this access window

satellite_id `property` ¶

satellite_id: Optional[int]

Get the satellite/object ID if available.

Returns:

Type	Description
`Optional[int]`	Optional[int]: ID of the satellite, or None if not set

satellite_name `property` ¶

satellite_name: Optional[str]

Get the satellite/object name if available.

Returns:

Type	Description
`Optional[str]`	Optional[str]: Name of the satellite, or None if not set

satellite_uuid `property` ¶

satellite_uuid: Optional[str]

Get the satellite UUID if available.

Returns:

Type	Description
`Optional[str]`	Optional[str]: UUID of the satellite as string, or None if not set

start `property` ¶

start: Epoch

Get the start time of the access window (alias for window_open).

Returns:

Name	Type	Description
`Epoch`	`Epoch`	Opening time of the window

uuid `property` ¶

uuid: Optional[str]

Get the access window UUID.

Returns:

Type	Description
`Optional[str]`	Optional[str]: UUID as string, or None if not set

window_close `property` ¶

window_close: Epoch

Get the window closing time.

Returns:

Name	Type	Description
`Epoch`	`Epoch`	Window closing time

window_open `property` ¶

window_open: Epoch

Get the window opening time.

Returns:

Name	Type	Description
`Epoch`	`Epoch`	Window opening time

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

str ¶

__str__() -> str

Return str(self).

AccessProperties¶

AccessProperties ¶

AccessProperties()

Properties computed for an access window.

AccessProperties contains geometric properties (azimuth, elevation, off-nadir angles, local time, look direction, ascending/descending) computed over an access window, plus a dictionary of additional custom properties.

Attributes:

Name	Type	Description
`azimuth_open`	`float`	Azimuth angle at window opening (degrees, 0-360)
`azimuth_close`	`float`	Azimuth angle at window closing (degrees, 0-360)
`elevation_min`	`float`	Minimum elevation angle (degrees)
`elevation_max`	`float`	Maximum elevation angle (degrees)
`off_nadir_min`	`float`	Minimum off-nadir angle (degrees)
`off_nadir_max`	`float`	Maximum off-nadir angle (degrees)
`local_time`	`float`	Local solar time (seconds since midnight, 0-86400)
`look_direction`	`LookDirection`	Required look direction (Left or Right)
`asc_dsc`	`AscDsc`	Pass type (Ascending or Descending)

Example

import brahe as bh

# Access properties are typically computed by the access computation system
# This example shows accessing the properties
props = ...  # From access computation

print(f"Azimuth at open: {props.azimuth_open}°")
print(f"Max elevation: {props.elevation_max}°")
print(f"Look direction: {props.look_direction}")

# Access additional custom properties
if "signal_strength" in props.additional:
    print(f"Signal: {props.additional['signal_strength']}")

Initialize instance.

doc `class-attribute` ¶

__doc__ = 'Properties computed for an access window.\n\nAccessProperties contains geometric properties (azimuth, elevation, off-nadir angles,\nlocal time, look direction, ascending/descending) computed over an access window,\nplus a dictionary of additional custom properties.\n\nAttributes:\n    azimuth_open (float): Azimuth angle at window opening (degrees, 0-360)\n    azimuth_close (float): Azimuth angle at window closing (degrees, 0-360)\n    elevation_min (float): Minimum elevation angle (degrees)\n    elevation_max (float): Maximum elevation angle (degrees)\n    off_nadir_min (float): Minimum off-nadir angle (degrees)\n    off_nadir_max (float): Maximum off-nadir angle (degrees)\n    local_time (float): Local solar time (seconds since midnight, 0-86400)\n    look_direction (LookDirection): Required look direction (Left or Right)\n    asc_dsc (AscDsc): Pass type (Ascending or Descending)\n\nExample:\n    ```python\n    import brahe as bh\n\n    # Access properties are typically computed by the access computation system\n    # This example shows accessing the properties\n    props = ...  # From access computation\n\n    print(f"Azimuth at open: {props.azimuth_open}°")\n    print(f"Max elevation: {props.elevation_max}°")\n    print(f"Look direction: {props.look_direction}")\n\n    # Access additional custom properties\n    if "signal_strength" in props.additional:\n        print(f"Signal: {props.additional[\'signal_strength\']}")\n    ```'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'.

module `class-attribute` ¶

__module__ = 'brahe._brahe'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'.

additional `property` ¶

additional: AdditionalPropertiesDict

Get additional properties as a dict-like wrapper.

Returns a dictionary-like object that automatically converts between Python types and internal PropertyValue representation.

Supported Python types: - float -> Scalar - list[float] -> Vector - bool -> Boolean - str -> String - dict -> Json

Returns:

Name	Type	Description
`AdditionalPropertiesDict`	`AdditionalPropertiesDict`	Dict-like wrapper for additional properties

Example

# Dict-style assignment
props.additional["doppler_shift"] = 2500.0
props.additional["snr_values"] = [10.5, 12.3, 15.1]
props.additional["has_eclipse"] = False

# Dict-style access
print(props.additional["doppler_shift"])  # 2500.0

# Dict methods
if "doppler_shift" in props.additional:
    del props.additional["doppler_shift"]

# Iteration
for key in props.additional.keys():
    print(key, props.additional[key])

asc_dsc `property` ¶

asc_dsc: Any

azimuth_close `property` ¶

azimuth_close: Any

azimuth_open `property` ¶

azimuth_open: Any

elevation_max `property` ¶

elevation_max: Any

elevation_min `property` ¶

elevation_min: Any

local_time `property` ¶

local_time: Any

look_direction `property` ¶

look_direction: Any

off_nadir_max `property` ¶

off_nadir_max: Any

off_nadir_min `property` ¶

off_nadir_min: Any

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

str ¶

__str__() -> str

Return str(self).

Access Windows¶

AccessWindow¶

AccessWindow ¶

__doc__ class-attribute ¶

__module__ class-attribute ¶

asc_dsc property ¶

azimuth_close property ¶

azimuth_open property ¶

duration property ¶

elevation_max property ¶

elevation_min property ¶

end property ¶

id property ¶

local_time property ¶

location_id property ¶

location_name property ¶

location_uuid property ¶

look_direction property ¶

midtime property ¶

name property ¶

off_nadir_max property ¶

off_nadir_min property ¶

properties property ¶

satellite_id property ¶

satellite_name property ¶

satellite_uuid property ¶

start property ¶

uuid property ¶

window_close property ¶

window_open property ¶

__new__ builtin ¶

__repr__ method descriptor ¶

__str__ ¶

AccessProperties¶

AccessProperties ¶

__doc__ class-attribute ¶

__module__ class-attribute ¶

additional property ¶

asc_dsc property ¶

azimuth_close property ¶

azimuth_open property ¶

elevation_max property ¶

elevation_min property ¶

local_time property ¶

look_direction property ¶

off_nadir_max property ¶

off_nadir_min property ¶

__new__ builtin ¶

__repr__ method descriptor ¶

__str__ ¶

doc `class-attribute` ¶

module `class-attribute` ¶

asc_dsc `property` ¶

azimuth_close `property` ¶

azimuth_open `property` ¶

duration `property` ¶

elevation_max `property` ¶

elevation_min `property` ¶

end `property` ¶

id `property` ¶

local_time `property` ¶

location_id `property` ¶

location_name `property` ¶

location_uuid `property` ¶

look_direction `property` ¶

midtime `property` ¶

name `property` ¶

off_nadir_max `property` ¶

off_nadir_min `property` ¶

properties `property` ¶

satellite_id `property` ¶

satellite_name `property` ¶

satellite_uuid `property` ¶

start `property` ¶

uuid `property` ¶

window_close `property` ¶

window_open `property` ¶

new `builtin` ¶

repr `method descriptor` ¶

str ¶

doc `class-attribute` ¶

module `class-attribute` ¶

additional `property` ¶

asc_dsc `property` ¶

azimuth_close `property` ¶

azimuth_open `property` ¶

elevation_max `property` ¶

elevation_min `property` ¶

local_time `property` ¶

look_direction `property` ¶

off_nadir_max `property` ¶

off_nadir_min `property` ¶

new `builtin` ¶

repr `method descriptor` ¶

str ¶