Access Properties¶

Access properties are geometric and temporal measurements computed for each access window. Brahe automatically calculates core properties during access searches, and provides both built-in and custom property computers for mission-specific analysis.

Core Properties¶

Brahe automatically computes these temporal and geometric properties for every access window:

Name	Type	Description
`window_open`	`Epoch`	UTC time when access window starts
`window_close`	`Epoch`	UTC time when access window ends
`duration`	`float`	Total duration of access window in seconds
`midtime`	`Epoch`	UTC time at midpoint of access window
`azimuth_open`	`float`	Azimuth angle from location to satellite at window start (degrees)
`azimuth_close`	`float`	Azimuth angle from location to satellite at window end (degrees)
`elevation_min`	`float`	Minimum elevation angle during access window (degrees)
`elevation_max`	`float`	Maximum elevation angle during access window (degrees)
`local_time`	`float`	Local solar time at window midpoint in seconds \(\left[0, 86400\right)\)
`look_direction`	`LookDirection`	Satellite look direction relative to velocity
`asc_dsc`	`AscDsc`	Pass classification based on satellite motion

Core properties are attributes of the AccessWindow object returned by access computations and can be accessed directly like window.window_open or window.elevation_max.

Below are examples of accessing core properties in Python and Rust.

PythonRust

import brahe as bh

bh.initialize_eop()

# Create location (San Francisco area)
location = bh.PointLocation(-122.4194, 37.7749, 0.0)

# Create propagator from TLE (ISS example)
tle_line1 = "1 25544U 98067A   25306.42331346  .00010070  00000-0  18610-3 0  9999"
tle_line2 = "2 25544  51.6344 342.0717 0004969   8.9436 351.1640 15.49700017536601"
propagator = bh.SGPPropagator.from_tle(tle_line1, tle_line2, 60.0)

# Define time period (24 hours from epoch)
epoch_start = bh.Epoch.from_datetime(2025, 11, 2, 0, 0, 0.0, 0.0, bh.TimeSystem.UTC)
epoch_end = epoch_start + 86400.0

# Create elevation constraint
constraint = bh.ElevationConstraint(min_elevation_deg=10.0)

# Compute access windows
windows = bh.location_accesses(
    [location], [propagator], epoch_start, epoch_end, constraint
)

# Access core properties from first window
if windows:
    window = windows[0]
    props = window.properties

    print("Window ")
    t_start = window.window_open
    t_end = window.window_close
    print(f"  Start: {t_start}")
    print(f"  End:   {t_end}")
    print(f"  Duration: {window.duration:.1f} seconds")
    print(f"  Midtime: {window.midtime}")

    print("\nProperties:")

    # Azimuth values (open and close)
    az_open = props.azimuth_open
    az_close = props.azimuth_close
    print(f"  Azimuth - Min: {az_open:.1f}°, Max: {az_close:.1f}°")

    # Elevation range (min and max)
    elev_min = props.elevation_min
    elev_max = props.elevation_max
    print(f"  Elevation - Min: {elev_min:.1f}°, Max: {elev_max:.1f}°")

    # Off-nadir range (min and max)
    off_nadir_min = props.off_nadir_min
    off_nadir_max = props.off_nadir_max
    print(f"  Off-nadir - Min: {off_nadir_min:.1f}°, Max: {off_nadir_max:.1f}°")

    # Local solar time at midpoint
    local_time = props.local_time
    hours = int(local_time // 3600)
    minutes = (local_time - hours * 3600) / 60
    print(f"  Local time: {hours:02d}:{minutes:02.2f}")

    # Look direction
    look = props.look_direction
    print(f"  Look direction: {look}")

    # Ascending/Descending
    asc_dsc = props.asc_dsc
    print(f"  Ascending/Descending: {asc_dsc}")

use brahe as bh;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    bh::initialize_eop()?;

    // Create location (San Francisco area)
    let location = bh::PointLocation::new(
        -122.4194,
        37.7749,
        0.0
    ).unwrap();

    // Create propagator from TLE (ISS example)
    let tle_line1 = "1 25544U 98067A   25306.42331346  .00010070  00000-0  18610-3 0  9999";
    let tle_line2 = "2 25544  51.6344 342.0717 0004969   8.9436 351.1640 15.49700017536601";
    let propagator = bh::SGPPropagator::from_tle(tle_line1, tle_line2, 60.0)?;

    // Define time period (24 hours from epoch)
    let epoch_start = bh::Epoch::from_datetime(2025, 11, 2, 0, 0, 0.0, 0.0, bh::TimeSystem::UTC);
    let epoch_end = epoch_start + 86400.0;

    // Create elevation constraint
    let constraint = bh::ElevationConstraint::new(Some(10.0), None)?;

    // Compute access windows
    let windows = bh::location_accesses(
        &location,
        &propagator,
        epoch_start,
        epoch_end,
        &constraint,
        None,
        None,
    )?;

    // Access core properties from first window
    if !windows.is_empty() {
        let window = &windows[0];
        let props = &window.properties;

        println!("Window ");
        let t_start = window.window_open;
        let t_end = window.window_close;
        println!("  Start: {}", t_start);
        println!("  End:   {}", t_end);
        println!("  Duration: {:.1} seconds", window.duration());
        println!("  Midtime: {}", window.midtime());

        println!("\nProperties:");

        // Azimuth values (open and close)
        let az_open = props.azimuth_open;
        let az_close = props.azimuth_close;
        println!("  Azimuth - Min: {:.1}°, Max: {:.1}°", az_open, az_close);

        // Elevation range (min and max)
        let elev_min = props.elevation_min;
        let elev_max = props.elevation_max;
        println!("  Elevation - Min: {:.1}°, Max: {:.1}°", elev_min, elev_max);

        // Off-nadir range (min and max)
        let off_nadir_min = props.off_nadir_min;
        let off_nadir_max = props.off_nadir_max;
        println!("  Off-nadir - Min: {:.1}°, Max: {:.1}°", off_nadir_min, off_nadir_max);

        // Local solar time at midpoint (local_time is in seconds since midnight)
        let local_time = props.local_time;
        let hours = (local_time / 3600.0).floor() as i32;
        let minutes = (local_time - hours as f64 * 3600.0) / 60.0;
        println!("  Local time: {:02}:{:05.2}", hours, minutes);

        // Look direction
        let look = &props.look_direction;
        println!("  Look direction: {}", look);

        // Ascending/Descending
        let asc_dsc = &props.asc_dsc;
        println!("  Ascending/Descending: {}", asc_dsc);
    }

    Ok(())
}

Output

PythonRust

Window 
  Start: 2025-11-02 05:39:28.342 UTC
  End:   2025-11-02 05:44:19.001 UTC
  Duration: 290.7 seconds
  Midtime: 2025-11-02 05:41:53.671 UTC

Properties:
  Azimuth - Min: 177.0°, Max: 83.3°
  Elevation - Min: 10.0°, Max: 18.8°
  Off-nadir - Min: 62.6°, Max: 67.6°
  Local time: 05:37.40
  Look direction: Left
  Ascending/Descending: Ascending

Window 
  Start: 2025-11-02 05:39:28.342 UTC
  End:   2025-11-02 05:44:19.001 UTC
  Duration: 290.7 seconds
  Midtime: 2025-11-02 05:41:53.671 UTC

Properties:
  Azimuth - Min: 177.0°, Max: 83.3°
  Elevation - Min: 10.0°, Max: 18.8°
  Off-nadir - Min: 62.6°, Max: 67.6°
  Local time: 05:37.40
  Look direction: Left
  Ascending/Descending: Ascending

Property Computers¶

Property computers allow users to extend the access computation system to define and compute custom properties for each access window beyond the core set. These computations are performed after access windows are identified and refined.

Python users can implement property computers by subclassing AccessPropertyComputer, while in Rust you implement the AccessPropertyComputer trait. These traits require the implementation of the sampling_config and compute methods. sampling_config defines how satellite states are sampled during the access window, and compute performs the actual property calculation using those sampled states.

Brahe defines a few built-in property computers for common use cases, and users can create custom property computers for application-specific needs.

Sampling Configuration¶

Property computers use SamplingConfig to determine when satellite states are sampled within the access window. That is, what epoch, state pairs are provided to the computer for its calculations.

You can choose from several sampling modes:

relative_points([0.0, 0.5, 1.0]) - Samples at specified fractions of the window duration with 0.0 being the start and 1.0 being the end
fixed_count(n) - Samples a fixed number of evenly spaced points within the window
fixed_interval(interval, offset) - Samples at regular time intervals (defined by seconds between samples) throughout the window with an optional offset
midpoint - Samples only at the midpoint of the window

This allows you to compute time-series data at specific intervals or points.

Sampling Modes¶

PythonRust

import brahe as bh

# Single sample at window midpoint (default)
config = bh.SamplingConfig.midpoint()
print(f"Midpoint: {config}")

# Specific relative points [0.0, 1.0] from window start to end
config = bh.SamplingConfig.relative_points([0.0, 0.25, 0.5, 0.75, 1.0])
print(f"Relative points: {config}")

# Fixed time interval in seconds
config = bh.SamplingConfig.fixed_interval(1.0, offset=0.0)  # 1 second
print(f"Fixed interval (1s): {config}")

# Fixed number of evenly-spaced points
config = bh.SamplingConfig.fixed_count(50)
print(f"Fixed count (50): {config}")

//! ```

use brahe::access::SamplingConfig;

fn main() {
    // Single sample at window midpoint (default)
    let config = SamplingConfig::Midpoint;
    println!("Midpoint: {:?}", config);

    // Specific relative points [0.0, 1.0] from window start to end
    let config = SamplingConfig::RelativePoints(vec![0.0, 0.25, 0.5, 0.75, 1.0]);
    println!("Relative points: {:?}", config);

    // Fixed time interval in seconds
    let config = SamplingConfig::FixedInterval {
        interval: 1.0,  // 1 second
        offset: 0.0
    };
    println!("Fixed interval (1s): {:?}", config);

    // Fixed number of evenly-spaced points
    let config = SamplingConfig::FixedCount(50);
    println!("Fixed count (50): {:?}", config);
}

Output

PythonRust

Midpoint: SamplingConfig.midpoint()
Relative points: SamplingConfig.relative_points([0.0, 0.25, 0.5, 0.75, 1.0])
Fixed interval (1s): SamplingConfig.fixed_interval(interval=1, offset=0)
Fixed count (50): SamplingConfig.fixed_count(50)

Midpoint: Midpoint
Relative points: RelativePoints([0.0, 0.25, 0.5, 0.75, 1.0])
Fixed interval (1s): FixedInterval { interval: 1.0, offset: 0.0 }
Fixed count (50): FixedCount(50)

Built-in Property Computers¶

Brahe provides three commonly-used property computers optimized in Rust:

DopplerComputer¶

Computes Doppler frequency shifts for uplink and/or downlink communications:

PythonRust

import brahe as bh

bh.initialize_eop()

# S-band downlink only (8.4 GHz)
doppler = bh.DopplerComputer(
    uplink_frequency=None,
    downlink_frequency=8.4e9,
    sampling_config=bh.SamplingConfig.fixed_interval(0.1, 0.0),  # 0.1 seconds
)
print(f"Downlink only: {doppler}")

# Both uplink (2.0 GHz) and downlink (8.4 GHz)
doppler = bh.DopplerComputer(
    uplink_frequency=2.0e9,
    downlink_frequency=8.4e9,
    sampling_config=bh.SamplingConfig.fixed_count(100),
)
print(f"Both frequencies: {doppler}")

# Create a simple scenario to demonstrate usage
# ISS orbit
tle_line1 = "1 25544U 98067A   25306.42331346  .00010070  00000-0  18610-3 0  9999"
tle_line2 = "2 25544  51.6344 342.0717 0004969   8.9436 351.1640 15.49700017536601"
propagator = bh.SGPPropagator.from_tle(tle_line1, tle_line2, 60.0).with_name("ISS")

epoch_start = propagator.epoch
epoch_end = epoch_start + 24 * 3600.0  # 24 hours

# Ground station (lon, lat, alt)
location = bh.PointLocation(-74.0060, 40.7128, 0.0)

# Compute accesses with Doppler
constraint = bh.ElevationConstraint(min_elevation_deg=10.0)
windows = bh.location_accesses(
    location,
    propagator,
    epoch_start,
    epoch_end,
    constraint,
    property_computers=[doppler],
)

# Access computed properties
window = windows[0]
doppler_data = window.properties.additional["doppler_downlink"]
times = doppler_data["times"]  # Seconds from window start
values = doppler_data["values"]  # Hz
print(
    f"\nFirst pass downlink Doppler shift range: {min(values):.1f} to {max(values):.1f} Hz"
)

//! ```

#[allow(unused_imports)]
use brahe as bh;
use bh::access::{DopplerComputer, SamplingConfig, PropertyValue};
use bh::utils::Identifiable;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    bh::initialize_eop()?;

    // S-band downlink only (8.4 GHz)
    let _doppler = DopplerComputer::new(
        None,  // No uplink
        Some(8.4e9),  // Downlink frequency
        SamplingConfig::FixedInterval { interval: 0.1, offset: 0.0 }  // 0.1 seconds
    );
    println!("Downlink only: uplink=None, downlink=8.4e9 Hz");

    // Both uplink (2.0 GHz) and downlink (8.4 GHz)
    let doppler = DopplerComputer::new(
        Some(2.0e9),  // Uplink frequency
        Some(8.4e9),  // Downlink frequency
        SamplingConfig::FixedCount(100)
    );
    println!("Both frequencies: uplink=2.0e9 Hz, downlink=8.4e9 Hz");

    // ISS orbit
    let tle_line1 = "1 25544U 98067A   25306.42331346  .00010070  00000-0  18610-3 0  9999";
    let tle_line2 = "2 25544  51.6344 342.0717 0004969   8.9436 351.1640 15.49700017536601";
    let propagator = bh::SGPPropagator::from_tle(tle_line1, tle_line2, 60.0)?
        .with_name("ISS");

    let epoch_start = propagator.epoch;
    let epoch_end = epoch_start + 24.0 * 3600.0;

    // Ground station (lon, lat, alt)
    let location = bh::PointLocation::new(-74.0060, 40.7128, 0.0).unwrap();

    // Compute accesses with Doppler
    let constraint = bh::ElevationConstraint::new(Some(10.0), None)?;
    let windows = bh::location_accesses(
        &location,
        &propagator,
        epoch_start,
        epoch_end,
        &constraint,
        Some(&[&doppler]),  // Property computers
        None,  // Use default config
    )?;

    // Access computed properties
    let window = &windows[0];
    let doppler_data = window.properties.additional.get("doppler_downlink").unwrap();

    // Extract values from TimeSeries
    let values = match doppler_data {
        PropertyValue::TimeSeries { values, .. } => values,
        _ => panic!("Expected TimeSeries"),
    };

    let min_val = values.iter().fold(f64::INFINITY, |a: f64, &b| a.min(b));
    let max_val = values.iter().fold(f64::NEG_INFINITY, |a: f64, &b| a.max(b));

    println!("\nFirst pass downlink Doppler shift range: {:.1} to {:.1} Hz", min_val, max_val);

    Ok(())
}

Output

PythonRust

Downlink only: DopplerComputer(uplink_frequency=None, downlink_frequency=Some(8400000000.0))
Both frequencies: DopplerComputer(uplink_frequency=Some(2000000000.0), downlink_frequency=Some(8400000000.0))

First pass downlink Doppler shift range: -178593.2 to 178818.8 Hz

Downlink only: uplink=None, downlink=8.4e9 Hz
Both frequencies: uplink=2.0e9 Hz, downlink=8.4e9 Hz

First pass downlink Doppler shift range: -178593.2 to 178818.8 Hz

Doppler Physics:

Uplink: \(\Delta f = f_0\frac{v_{los}}{c - v_{los}}\) - Ground station pre-compensates transmit frequency
Downlink: \(\Delta f = -f_0\frac{v_{los}}{c}\) - Ground station adjusts receive frequency
Where \(v_{los}\) is the velocity of the object along the line of sight from the observer. With \(v_{los} < 0\) when approaching and \(v_{los} > 0\) when receding.

RangeComputer¶

Computes slant range (distance) from the location to the satellite:

PythonRust

import brahe as bh

bh.initialize_eop()

# Compute range at 50 evenly-spaced points
range_comp = bh.RangeComputer(sampling_config=bh.SamplingConfig.fixed_count(50))
print(f"Range computer: {range_comp}")


# Create a simple scenario to demonstrate usage
# ISS orbit
tle_line1 = "1 25544U 98067A   25306.42331346  .00010070  00000-0  18610-3 0  9999"
tle_line2 = "2 25544  51.6344 342.0717 0004969   8.9436 351.1640 15.49700017536601"
propagator = bh.SGPPropagator.from_tle(tle_line1, tle_line2, 60.0).with_name("ISS")

epoch_start = propagator.epoch
epoch_end = epoch_start + 24 * 3600.0  # 24 hours

# Ground station
location = bh.PointLocation(-74.0060, 40.7128, 0.0)

# Compute accesses with range
constraint = bh.ElevationConstraint(min_elevation_deg=10.0)
windows = bh.location_accesses(
    location,
    propagator,
    epoch_start,
    epoch_end,
    constraint,
    property_computers=[range_comp],
)

# Access computed properties
window = windows[0]
range_data = window.properties.additional["range"]
distances_m = range_data["values"]  # meters
distances_km = [d / 1000.0 for d in distances_m]
print(f"\nRange varies from {min(distances_km):.1f} to {max(distances_km):.1f} km")

//! ```

#[allow(unused_imports)]
use brahe as bh;
use bh::access::{RangeComputer, SamplingConfig, PropertyValue};
use bh::utils::Identifiable;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    bh::initialize_eop()?;

    // Compute range at 50 evenly-spaced points
    let range_comp = RangeComputer::new(
        SamplingConfig::FixedCount(50)
    );
    println!("Range computer: sampling=FixedCount(50)");

    // ISS orbit
    let tle_line1 = "1 25544U 98067A   25306.42331346  .00010070  00000-0  18610-3 0  9999";
    let tle_line2 = "2 25544  51.6344 342.0717 0004969   8.9436 351.1640 15.49700017536601";
    let propagator = bh::SGPPropagator::from_tle(tle_line1, tle_line2, 60.0)?
        .with_name("ISS");

    let epoch_start = propagator.epoch;
    let epoch_end = epoch_start + 24.0 * 3600.0;

    // Ground station
    let location = bh::PointLocation::new(-74.0060, 40.7128, 0.0).unwrap();

    // Compute accesses with range
    let constraint = bh::ElevationConstraint::new(Some(10.0), None)?;
    let windows = bh::location_accesses(
        &location,
        &propagator,
        epoch_start,
        epoch_end,
        &constraint,
        Some(&[&range_comp]),  // Property computers
        None,  // Use default config
    )?;

    // Access computed properties
    let window = &windows[0];
    let range_data = window.properties.additional.get("range").unwrap();

    // Extract values from TimeSeries
    let distances_m = match range_data {
        PropertyValue::TimeSeries { values, .. } => values,
        _ => panic!("Expected TimeSeries"),
    };

    // Convert to km
    let min_km = distances_m.iter().fold(f64::INFINITY, |a: f64, &b| a.min(b)) / 1000.0;
    let max_km = distances_m.iter().fold(f64::NEG_INFINITY, |a: f64, &b| a.max(b)) / 1000.0;

    println!("\nRange varies from {:.1} to {:.1} km", min_km, max_km);

    Ok(())
}

Output

PythonRust

1
2
3

Range computer: RangeComputer()

Range varies from 658.9 to 1501.0 km

1
2
3

Range computer: sampling=FixedCount(50)

Range varies from 658.9 to 1501.0 km

RangeRateComputer¶

Computes line-of-sight velocity (range rate) with the convention that positive values indicate increasing range (satellite receding) and negative values indicate decreasing range (satellite approaching):

PythonRust

import brahe as bh

bh.initialize_eop()

# Compute range rate every 0.5 seconds
range_rate = bh.RangeRateComputer(
    sampling_config=bh.SamplingConfig.fixed_interval(0.5, 0.0)  # 0.5 seconds
)
print(f"Range rate computer: {range_rate}")

# Create a simple scenario to demonstrate usage
# ISS orbit
tle_line1 = "1 25544U 98067A   25306.42331346  .00010070  00000-0  18610-3 0  9999"
tle_line2 = "2 25544  51.6344 342.0717 0004969   8.9436 351.1640 15.49700017536601"
propagator = bh.SGPPropagator.from_tle(tle_line1, tle_line2, 60.0).with_name("ISS")

epoch_start = propagator.epoch
epoch_end = epoch_start + 24 * 3600.0  # 24 hours

# Ground station
location = bh.PointLocation(-74.0060, 40.7128, 0.0)

# Compute accesses with range rate
constraint = bh.ElevationConstraint(min_elevation_deg=10.0)
windows = bh.location_accesses(
    location,
    propagator,
    epoch_start,
    epoch_end,
    constraint,
    property_computers=[range_rate],
)

# Access computed properties
window = windows[0]
rr_data = window.properties.additional["range_rate"]
velocities_mps = rr_data["values"]  # m/s (positive=receding)
print(
    f"\nRange rate varies from {min(velocities_mps):.1f} to {max(velocities_mps):.1f} m/s"
)
print("Negative = approaching (decreasing distance)")
print("Positive = receding (increasing distance)")

//! ```

#[allow(unused_imports)]
use brahe as bh;
use bh::access::{RangeRateComputer, SamplingConfig, PropertyValue};
use bh::utils::Identifiable;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    bh::initialize_eop()?;

    // Compute range rate every 0.5 seconds
    let range_rate = RangeRateComputer::new(
        SamplingConfig::FixedInterval { interval: 0.5, offset: 0.0 }  // 0.5 seconds
    );
    println!("Range rate computer: sampling=FixedInterval(0.5s)");

    // ISS orbit
    let tle_line1 = "1 25544U 98067A   25306.42331346  .00010070  00000-0  18610-3 0  9999";
    let tle_line2 = "2 25544  51.6344 342.0717 0004969   8.9436 351.1640 15.49700017536601";
    let propagator = bh::SGPPropagator::from_tle(tle_line1, tle_line2, 60.0)?
        .with_name("ISS");

    let epoch_start = propagator.epoch;
    let epoch_end = epoch_start + 24.0 * 3600.0;

    // Ground station
    let location = bh::PointLocation::new(-74.0060, 40.7128, 0.0).unwrap();

    // Compute accesses with range rate
    let constraint = bh::ElevationConstraint::new(Some(10.0), None)?;
    let windows = bh::location_accesses(
        &location,
        &propagator,
        epoch_start,
        epoch_end,
        &constraint,
        Some(&[&range_rate]),  // Property computers
        None,  // Use default config
    )?;

    // Access computed properties
    let window = &windows[0];
    let rr_data = window.properties.additional.get("range_rate").unwrap();

    // Extract values from TimeSeries
    let velocities_mps = match rr_data {
        PropertyValue::TimeSeries { values, .. } => values,
        _ => panic!("Expected TimeSeries"),
    };

    let min_vel = velocities_mps.iter().fold(f64::INFINITY, |a: f64, &b| a.min(b));
    let max_vel = velocities_mps.iter().fold(f64::NEG_INFINITY, |a: f64, &b| a.max(b));

    println!("\nRange rate varies from {:.1} to {:.1} m/s", min_vel, max_vel);
    println!("Negative = approaching (decreasing distance)");
    println!("Positive = receding (increasing distance)");

    Ok(())
}

Output

PythonRust

Range rate computer: RangeRateComputer()

Range rate varies from -6382.0 to 6372.9 m/s
Negative = approaching (decreasing distance)
Positive = receding (increasing distance)

Range rate computer: sampling=FixedInterval(0.5s)

Range rate varies from -6382.0 to 6372.9 m/s
Negative = approaching (decreasing distance)
Positive = receding (increasing distance)

Custom Property Computers¶

You can also create your own property computer to compute application-specific properties values. The system will pre-sample the satellite state at the specified times defined by your SamplingConfig, so you don't need to manually propagate the trajectory.

This section provides examples of custom property computers in both Python and Rust.

Python Implementation¶

In python you subclass AccessPropertyComputer and implement three methods:

Python

import numpy as np

import brahe as bh

bh.initialize_eop()


class MaxSpeedComputer(bh.AccessPropertyComputer):
    """Computes maximum ground speed during access."""

    def sampling_config(self):
        # Sample every 0.5 seconds
        return bh.SamplingConfig.fixed_interval(0.5, 0.0)

    def compute(
        self, window, sample_times, sample_states_ecef, location_ecef, location_geodetic
    ):
        # Extract velocities from states
        velocities = sample_states_ecef[:, 3:6]
        speeds = np.linalg.norm(velocities, axis=1)
        max_speed = np.max(speeds)

        # Single value -> returns as scalar
        return {
            "max_ground_speed": max_speed,  # Will be stored as Scalar
        }

    def property_names(self):
        return ["max_ground_speed"]


# ISS orbit
tle_line1 = "1 25544U 98067A   25306.42331346  .00010070  00000-0  18610-3 0  9999"
tle_line2 = "2 25544  51.6344 342.0717 0004969   8.9436 351.1640 15.49700017536601"
propagator = bh.SGPPropagator.from_tle(tle_line1, tle_line2, 60.0).with_name("ISS")

epoch_start = propagator.epoch
epoch_end = epoch_start + 24 * 3600.0  # 24 hours

# Ground station
location = bh.PointLocation(-74.0060, 40.7128, 0.0)

# Compute with custom property
max_speed = MaxSpeedComputer()
constraint = bh.ElevationConstraint(min_elevation_deg=10.0)
windows = bh.location_accesses(
    location,
    propagator,
    epoch_start,
    epoch_end,
    constraint,
    property_computers=[max_speed],
)

for window in windows:
    speed = window.properties.additional["max_ground_speed"]
    print(f"Max speed: {speed:.1f} m/s")

Combining Multiple Computers¶

Pass multiple computers to compute different properties simultaneously:

Python

import numpy as np

import brahe as bh

bh.initialize_eop()


class MaxSpeedComputer(bh.AccessPropertyComputer):
    """Computes maximum ground speed during access."""

    def sampling_config(self):
        return bh.SamplingConfig.fixed_interval(0.5, 0.0)

    def compute(
        self, window, sample_times, sample_states_ecef, location_ecef, location_geodetic
    ):
        velocities = sample_states_ecef[:, 3:6]
        speeds = np.linalg.norm(velocities, axis=1)
        max_speed = np.max(speeds)
        return {"max_ground_speed": max_speed}

    def property_names(self):
        return ["max_ground_speed"]


# Mix built-in and custom computers
doppler = bh.DopplerComputer(
    uplink_frequency=None,
    downlink_frequency=2.2e9,
    sampling_config=bh.SamplingConfig.fixed_interval(0.1, 0.0),
)

range_comp = bh.RangeComputer(sampling_config=bh.SamplingConfig.midpoint())

custom_comp = MaxSpeedComputer()

# Setup scenario
# ISS orbit
tle_line1 = "1 25544U 98067A   25306.42331346  .00010070  00000-0  18610-3 0  9999"
tle_line2 = "2 25544  51.6344 342.0717 0004969   8.9436 351.1640 15.49700017536601"
propagator = bh.SGPPropagator.from_tle(tle_line1, tle_line2, 60.0).with_name("ISS")

epoch_start = propagator.epoch
epoch_end = epoch_start + 24 * 3600.0  # 24 hours

# Ground station
location = bh.PointLocation(-74.0060, 40.7128, 0.0)

# Compute with all property computers
constraint = bh.ElevationConstraint(min_elevation_deg=10.0)
windows = bh.location_accesses(
    location,
    propagator,
    epoch_start,
    epoch_end,
    constraint,
    property_computers=[doppler, range_comp, custom_comp],
)

# All properties available in results
window = windows[0]
props = window.properties.additional

doppler_data = props["doppler_downlink"]
range_data = props["range"]
max_speed = props["max_ground_speed"]

print(f"Doppler: {len(doppler_data['values'])} samples")
print(f"Range: {range_data / 1000:.1f} km")
print(f"Max speed: {max_speed:.1f} m/s")

Rust Implementation¶

To implement a custom property computer in Rust, create a struct that implements the AccessPropertyComputer trait by defining the sampling_config and compute methods.

Rust

use brahe as bh;
use bh::access::{AccessPropertyComputer, AccessWindow, PropertyValue, SamplingConfig};
use bh::utils::{BraheError, Identifiable};
use std::collections::HashMap;

struct MaxSpeedComputer {
    sampling_config: SamplingConfig,
}

impl AccessPropertyComputer for MaxSpeedComputer {
    fn sampling_config(&self) -> SamplingConfig {
        self.sampling_config.clone()
    }

    fn compute(
        &self,
        _window: &AccessWindow,
        _sample_epochs: &[f64],
        sample_states_ecef: &[nalgebra::SVector<f64, 6>],
        _location_ecef: &nalgebra::Vector3<f64>,
        _location_geodetic: &nalgebra::Vector3<f64>,
    ) -> Result<HashMap<String, PropertyValue>, BraheError> {
        let mut max_speed = 0.0;

        for state in sample_states_ecef {
            let velocity = state.fixed_rows::<3>(3);
            let speed = velocity.norm();
            if speed > max_speed {
                max_speed = speed;
            }
        }

        let mut props = HashMap::new();
        props.insert("max_ground_speed".to_string(), PropertyValue::Scalar(max_speed));
        Ok(props)
    }

    fn property_names(&self) -> Vec<String> {
        vec!["max_ground_speed".to_string()]
    }
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    bh::initialize_eop()?;

    // ISS orbit
    let tle_line1 = "1 25544U 98067A   25306.42331346  .00010070  00000-0  18610-3 0  9999";
    let tle_line2 = "2 25544  51.6344 342.0717 0004969   8.9436 351.1640 15.49700017536601";
    let propagator = bh::SGPPropagator::from_tle(tle_line1, tle_line2, 60.0)?
        .with_name("ISS");

    let epoch_start = propagator.epoch;
    let epoch_end = epoch_start + 24.0 * 3600.0;

    // Ground station
    let location = bh::PointLocation::new(-74.0060, 40.7128, 0.0).unwrap();

    // Compute with custom property
    let max_speed = MaxSpeedComputer {
        sampling_config: SamplingConfig::FixedInterval {
            interval: 0.5,  // 0.5 seconds
            offset: 0.0,
        },
    };

    let constraint = bh::ElevationConstraint::new(Some(10.0), None)?;
    let windows = bh::location_accesses(
        &location,
        &propagator,
        epoch_start,
        epoch_end,
        &constraint,
        Some(&[&max_speed]),  // Property computers
        None,  // Use default config
    )?;

    for window in &windows {
        let speed = match window.properties.additional.get("max_ground_speed").unwrap() {
            PropertyValue::Scalar(s) => s,
            _ => panic!("Expected Scalar"),
        };
        println!("Max speed: {:.1} m/s", speed);
    }

    Ok(())
}

Output

PythonRust

1
2
3

Doppler: 3777 samples
Range: 658.4 km
Max speed: 7360.1 m/s

Max speed: 7360.1 m/s
Max speed: 7365.5 m/s
Max speed: 7361.2 m/s
Max speed: 7357.5 m/s
Max speed: 7357.8 m/s
Max speed: 7360.0 m/s

Constructing AccessProperties Directly¶

AccessProperties is normally produced by an access search rather than constructed directly. For tests or custom pipelines that feed geometry from another source, AccessProperties.builder() returns a builder with every field unset; each of the 15 fields is set through a chained named setter, and build() raises an error naming any field left unset instead of applying a default. The flat constructor takes the same 15 fields positionally as an alternative, without naming each one:

PythonRust

import brahe as bh

props = (
    bh.AccessProperties.builder()
    .azimuth_open(45.0)
    .azimuth_close(135.0)
    .elevation_min(10.0)
    .elevation_max(85.0)
    .elevation_open(12.0)
    .elevation_close(10.5)
    .off_nadir_min(5.0)
    .off_nadir_max(80.0)
    .local_time(43200.0)
    .look_direction(bh.LookDirection.RIGHT)
    .asc_dsc(bh.AscDsc.ASCENDING)
    .center_lon(0.0)
    .center_lat(45.0)
    .center_alt(0.0)
    .center_ecef([4517.59e3, 4517.59e3, 0.0])
    .build()
)

print(f"Azimuth open/close: {props.azimuth_open}, {props.azimuth_close} deg")
print(f"Elevation min/max: {props.elevation_min}, {props.elevation_max} deg")

# The flat constructor takes the same 15 fields positionally, without
# naming each one -- an alternative when all values are already at hand.
props_flat = bh.AccessProperties(
    45.0,
    135.0,
    10.0,
    85.0,
    12.0,
    10.5,
    5.0,
    80.0,
    43200.0,
    bh.LookDirection.RIGHT,
    bh.AscDsc.ASCENDING,
    0.0,
    45.0,
    0.0,
    [4517.59e3, 4517.59e3, 0.0],
)

assert props_flat.azimuth_open == props.azimuth_open
print("Example validated successfully!")

use brahe::access::{AccessProperties, AscDsc, LookDirection};

fn main() {
    let props = AccessProperties::builder()
        .azimuth_open(45.0)
        .azimuth_close(135.0)
        .elevation_min(10.0)
        .elevation_max(85.0)
        .elevation_open(12.0)
        .elevation_close(10.5)
        .off_nadir_min(5.0)
        .off_nadir_max(80.0)
        .local_time(43200.0)
        .look_direction(LookDirection::Right)
        .asc_dsc(AscDsc::Ascending)
        .center_lon(0.0)
        .center_lat(45.0)
        .center_alt(0.0)
        .center_ecef([4517.59e3, 4517.59e3, 0.0])
        .build()
        .unwrap();

    println!(
        "Azimuth open/close: {}, {} deg",
        props.azimuth_open, props.azimuth_close
    );
    println!(
        "Elevation min/max: {}, {} deg",
        props.elevation_min, props.elevation_max
    );

    // The flat constructor takes the same 15 fields positionally, without
    // naming each one -- an alternative when all values are already at hand.
    let props_flat = AccessProperties::new(
        45.0,
        135.0,
        10.0,
        85.0,
        12.0,
        10.5,
        5.0,
        80.0,
        43200.0,
        LookDirection::Right,
        AscDsc::Ascending,
        0.0,
        45.0,
        0.0,
        [4517.59e3, 4517.59e3, 0.0],
    );

    assert_eq!(props_flat.azimuth_open, props.azimuth_open);
    println!("Example validated successfully!");
}

Output

PythonRust

1
2
3

Azimuth open/close: 45.0, 135.0 deg
Elevation min/max: 10.0, 85.0 deg
Example validated successfully!

1
2
3

Azimuth open/close: 45, 135 deg
Elevation min/max: 10, 85 deg
Example validated successfully!

Access Properties¶

Core Properties¶

Property Computers¶

Sampling Configuration¶

Sampling Modes¶

Built-in Property Computers¶

DopplerComputer¶

RangeComputer¶

RangeRateComputer¶

Custom Property Computers¶

Python Implementation¶

Combining Multiple Computers¶

Rust Implementation¶

Constructing AccessProperties Directly¶

See Also¶