Access Enumerations

Enumeration types used in access computation.

LookDirection

LookDirection

LookDirection()

Look direction of a satellite relative to its velocity vector.

Indicates whether a satellite is looking to the left (counterclockwise from velocity), right (clockwise from velocity), or either direction.

This is commonly used for imaging satellites with side-looking sensors or SAR systems that have a preferred look direction.

Attributes:

Name	Type	Description
LEFT	Any	Left-looking (counterclockwise from velocity vector)
RIGHT	Any	Right-looking (clockwise from velocity vector)
EITHER	Any	Either left or right is acceptable

Example

import brahe as bh

# Create a constraint for right-looking only satellites
constraint = bh.LookDirectionConstraint(allowed=bh.LookDirection.RIGHT)

# Create a constraint accepting either direction
constraint = bh.LookDirectionConstraint(allowed=bh.LookDirection.EITHER)

# Compare look directions
assert bh.LookDirection.LEFT != bh.LookDirection.RIGHT
assert bh.LookDirection.LEFT == bh.LookDirection.LEFT

Initialize instance.

EITHER class-attribute

EITHER: Any = LookDirection.Either

Look direction of a satellite relative to its velocity vector.

Indicates whether a satellite is looking to the left (counterclockwise from velocity), right (clockwise from velocity), or either direction.

This is commonly used for imaging satellites with side-looking sensors or SAR systems that have a preferred look direction.

Attributes:

Name	Type	Description
LEFT		Left-looking (counterclockwise from velocity vector)
RIGHT		Right-looking (clockwise from velocity vector)
EITHER		Either left or right is acceptable

Example

import brahe as bh

# Create a constraint for right-looking only satellites
constraint = bh.LookDirectionConstraint(allowed=bh.LookDirection.RIGHT)

# Create a constraint accepting either direction
constraint = bh.LookDirectionConstraint(allowed=bh.LookDirection.EITHER)

# Compare look directions
assert bh.LookDirection.LEFT != bh.LookDirection.RIGHT
assert bh.LookDirection.LEFT == bh.LookDirection.LEFT

LEFT class-attribute

LEFT: Any = LookDirection.Left

Look direction of a satellite relative to its velocity vector.

Indicates whether a satellite is looking to the left (counterclockwise from velocity), right (clockwise from velocity), or either direction.

This is commonly used for imaging satellites with side-looking sensors or SAR systems that have a preferred look direction.

Attributes:

Name	Type	Description
LEFT		Left-looking (counterclockwise from velocity vector)
RIGHT		Right-looking (clockwise from velocity vector)
EITHER		Either left or right is acceptable

Example

import brahe as bh

# Create a constraint for right-looking only satellites
constraint = bh.LookDirectionConstraint(allowed=bh.LookDirection.RIGHT)

# Create a constraint accepting either direction
constraint = bh.LookDirectionConstraint(allowed=bh.LookDirection.EITHER)

# Compare look directions
assert bh.LookDirection.LEFT != bh.LookDirection.RIGHT
assert bh.LookDirection.LEFT == bh.LookDirection.LEFT

RIGHT class-attribute

RIGHT: Any = LookDirection.Right

Look direction of a satellite relative to its velocity vector.

Indicates whether a satellite is looking to the left (counterclockwise from velocity), right (clockwise from velocity), or either direction.

This is commonly used for imaging satellites with side-looking sensors or SAR systems that have a preferred look direction.

Attributes:

Name	Type	Description
LEFT		Left-looking (counterclockwise from velocity vector)
RIGHT		Right-looking (clockwise from velocity vector)
EITHER		Either left or right is acceptable

Example

import brahe as bh

# Create a constraint for right-looking only satellites
constraint = bh.LookDirectionConstraint(allowed=bh.LookDirection.RIGHT)

# Create a constraint accepting either direction
constraint = bh.LookDirectionConstraint(allowed=bh.LookDirection.EITHER)

# Compare look directions
assert bh.LookDirection.LEFT != bh.LookDirection.RIGHT
assert bh.LookDirection.LEFT == bh.LookDirection.LEFT

__doc__ class-attribute

__doc__ = 'Look direction of a satellite relative to its velocity vector.\n\nIndicates whether a satellite is looking to the left (counterclockwise from velocity),\nright (clockwise from velocity), or either direction.\n\nThis is commonly used for imaging satellites with side-looking sensors or SAR systems\nthat have a preferred look direction.\n\nAttributes:\n    LEFT: Left-looking (counterclockwise from velocity vector)\n    RIGHT: Right-looking (clockwise from velocity vector)\n    EITHER: Either left or right is acceptable\n\nExample:\n    ```python\n    import brahe as bh\n\n    # Create a constraint for right-looking only satellites\n    constraint = bh.LookDirectionConstraint(allowed=bh.LookDirection.RIGHT)\n\n    # Create a constraint accepting either direction\n    constraint = bh.LookDirectionConstraint(allowed=bh.LookDirection.EITHER)\n\n    # Compare look directions\n    assert bh.LookDirection.LEFT != bh.LookDirection.RIGHT\n    assert bh.LookDirection.LEFT == bh.LookDirection.LEFT\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'.

__eq__ method descriptor

__eq__(value)

Return self==value.

__ge__ method descriptor

__ge__(value)

Return self>=value.

__gt__ method descriptor

__gt__(value)

Return self>value.

__le__ method descriptor

__le__(value)

Return self<=value.

__lt__ method descriptor

__lt__(value)

Return self<value.

__ne__ method descriptor

__ne__(value)

Return self!=value.

__repr__ method descriptor

__repr__() -> str

Return repr(self).

__str__ method descriptor

__str__() -> str

Return str(self).

AscDsc

AscDsc

AscDsc()

Ascending or descending pass type for satellite orbits.

Indicates whether a satellite is moving from south to north (ascending) or north to south (descending) in its orbit. This is determined by the sign of the Z-component of the velocity vector in ECEF coordinates.

This is useful for: - Sun-synchronous orbits that prefer specific pass types - Minimizing lighting variation between passes - Coordinating multi-satellite observations

Attributes:

Name	Type	Description
ASCENDING	Any	Satellite moving from south to north (vz > 0 in ECEF)
DESCENDING	Any	Satellite moving from north to south (vz < 0 in ECEF)
EITHER	Any	Either ascending or descending is acceptable

Example

import brahe as bh

# Create a constraint for ascending passes only
constraint = bh.AscDscConstraint(allowed=bh.AscDsc.ASCENDING)

# Create a constraint for descending passes only
constraint = bh.AscDscConstraint(allowed=bh.AscDsc.DESCENDING)

# Accept either type
constraint = bh.AscDscConstraint(allowed=bh.AscDsc.EITHER)

# Compare pass types
assert bh.AscDsc.ASCENDING != bh.AscDsc.DESCENDING
assert bh.AscDsc.ASCENDING == bh.AscDsc.ASCENDING

Initialize instance.

ASCENDING class-attribute

ASCENDING: Any = AscDsc.Ascending

Ascending or descending pass type for satellite orbits.

Indicates whether a satellite is moving from south to north (ascending) or north to south (descending) in its orbit. This is determined by the sign of the Z-component of the velocity vector in ECEF coordinates.

This is useful for: - Sun-synchronous orbits that prefer specific pass types - Minimizing lighting variation between passes - Coordinating multi-satellite observations

Attributes:

Name	Type	Description
ASCENDING		Satellite moving from south to north (vz > 0 in ECEF)
DESCENDING		Satellite moving from north to south (vz < 0 in ECEF)
EITHER		Either ascending or descending is acceptable

Example

import brahe as bh

# Create a constraint for ascending passes only
constraint = bh.AscDscConstraint(allowed=bh.AscDsc.ASCENDING)

# Create a constraint for descending passes only
constraint = bh.AscDscConstraint(allowed=bh.AscDsc.DESCENDING)

# Accept either type
constraint = bh.AscDscConstraint(allowed=bh.AscDsc.EITHER)

# Compare pass types
assert bh.AscDsc.ASCENDING != bh.AscDsc.DESCENDING
assert bh.AscDsc.ASCENDING == bh.AscDsc.ASCENDING

DESCENDING class-attribute

DESCENDING: Any = AscDsc.Descending

Ascending or descending pass type for satellite orbits.

Indicates whether a satellite is moving from south to north (ascending) or north to south (descending) in its orbit. This is determined by the sign of the Z-component of the velocity vector in ECEF coordinates.

This is useful for: - Sun-synchronous orbits that prefer specific pass types - Minimizing lighting variation between passes - Coordinating multi-satellite observations

Attributes:

Name	Type	Description
ASCENDING		Satellite moving from south to north (vz > 0 in ECEF)
DESCENDING		Satellite moving from north to south (vz < 0 in ECEF)
EITHER		Either ascending or descending is acceptable

Example

import brahe as bh

# Create a constraint for ascending passes only
constraint = bh.AscDscConstraint(allowed=bh.AscDsc.ASCENDING)

# Create a constraint for descending passes only
constraint = bh.AscDscConstraint(allowed=bh.AscDsc.DESCENDING)

# Accept either type
constraint = bh.AscDscConstraint(allowed=bh.AscDsc.EITHER)

# Compare pass types
assert bh.AscDsc.ASCENDING != bh.AscDsc.DESCENDING
assert bh.AscDsc.ASCENDING == bh.AscDsc.ASCENDING

EITHER class-attribute

EITHER: Any = AscDsc.Either

Ascending or descending pass type for satellite orbits.

Indicates whether a satellite is moving from south to north (ascending) or north to south (descending) in its orbit. This is determined by the sign of the Z-component of the velocity vector in ECEF coordinates.

This is useful for: - Sun-synchronous orbits that prefer specific pass types - Minimizing lighting variation between passes - Coordinating multi-satellite observations

Attributes:

Name	Type	Description
ASCENDING		Satellite moving from south to north (vz > 0 in ECEF)
DESCENDING		Satellite moving from north to south (vz < 0 in ECEF)
EITHER		Either ascending or descending is acceptable

Example

import brahe as bh

# Create a constraint for ascending passes only
constraint = bh.AscDscConstraint(allowed=bh.AscDsc.ASCENDING)

# Create a constraint for descending passes only
constraint = bh.AscDscConstraint(allowed=bh.AscDsc.DESCENDING)

# Accept either type
constraint = bh.AscDscConstraint(allowed=bh.AscDsc.EITHER)

# Compare pass types
assert bh.AscDsc.ASCENDING != bh.AscDsc.DESCENDING
assert bh.AscDsc.ASCENDING == bh.AscDsc.ASCENDING

__doc__ class-attribute

__doc__ = 'Ascending or descending pass type for satellite orbits.\n\nIndicates whether a satellite is moving from south to north (ascending) or\nnorth to south (descending) in its orbit. This is determined by the sign of\nthe Z-component of the velocity vector in ECEF coordinates.\n\nThis is useful for:\n- Sun-synchronous orbits that prefer specific pass types\n- Minimizing lighting variation between passes\n- Coordinating multi-satellite observations\n\nAttributes:\n    ASCENDING: Satellite moving from south to north (vz > 0 in ECEF)\n    DESCENDING: Satellite moving from north to south (vz < 0 in ECEF)\n    EITHER: Either ascending or descending is acceptable\n\nExample:\n    ```python\n    import brahe as bh\n\n    # Create a constraint for ascending passes only\n    constraint = bh.AscDscConstraint(allowed=bh.AscDsc.ASCENDING)\n\n    # Create a constraint for descending passes only\n    constraint = bh.AscDscConstraint(allowed=bh.AscDsc.DESCENDING)\n\n    # Accept either type\n    constraint = bh.AscDscConstraint(allowed=bh.AscDsc.EITHER)\n\n    # Compare pass types\n    assert bh.AscDsc.ASCENDING != bh.AscDsc.DESCENDING\n    assert bh.AscDsc.ASCENDING == bh.AscDsc.ASCENDING\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'.

__eq__ method descriptor

__eq__(value)

Return self==value.

__ge__ method descriptor

__ge__(value)

Return self>=value.

__gt__ method descriptor

__gt__(value)

Return self>value.

__le__ method descriptor

__le__(value)

Return self<=value.

__lt__ method descriptor

__lt__(value)

Return self<value.

__ne__ method descriptor

__ne__(value)

Return self!=value.

__repr__ method descriptor

__repr__() -> str

Return repr(self).

__str__ method descriptor

__str__() -> str

Return str(self).