pyRTX.classes.PixelPlane

Classes

PixelPlane([spacecraft, source, mode, ...])

A class to generate a rectangular grid of rays for ray-tracing.
class pyRTX.classes.PixelPlane.PixelPlane(spacecraft=None, source=None, mode='Fixed', distance=1.0, lon=None, lat=None, width=None, height=None, ray_spacing=0.1, packets=1, units='m')[source]

A class to generate a rectangular grid of rays for ray-tracing.

This class creates a planar grid of ray origins and directions, simulating a uniform, parallel light source. It can be configured in a fixed orientation or dynamically aligned with a celestial body (e.g., the Sun).

__init__(spacecraft=None, source=None, mode='Fixed', distance=1.0, lon=None, lat=None, width=None, height=None, ray_spacing=0.1, packets=1, units='m')[source]

Initializes the PixelPlane object.

Parameters:

  • spacecraft (object, optional) – The spacecraft object, used for dynamic positioning.

  • source (str, optional) – The name of the celestial body to track (e.g., ‘Sun’).

  • mode (str, default 'Fixed') – The operational mode (‘Fixed’ or ‘Dynamic’).

  • distance (float, default 1.0) – The distance of the plane from the origin.

  • lon (float, optional) – The longitude of the plane’s center in a fixed orientation.

  • lat (float, optional) – The latitude of the plane’s center in a fixed orientation.

  • width (float, optional) – The width of the ray grid.

  • height (float, optional) – The height of the ray grid.

  • ray_spacing (float, default 0.1) – The spacing between adjacent rays.

  • packets (int, default 1) – The number of packets to divide the rays into for processing.

  • units (str, default 'm') – The units for all dimensional parameters.

dump(epoch=None)[source]

Generate the ray origins and directions for a given epoch.

Parameters:

epoch (float, optional) – The SPICE ephemeris time for dynamic positioning.

Returns:

A tuple containing the ray origins and directions as numpy arrays.

Return type:

tuple

update_latlon(lon=None, lat=None)[source]

Update the latitude and longitude for a fixed orientation.

Parameters:

  • lon (float, optional) – The new longitude value.

  • lat (float, optional) – The new latitude value.