Scene View

class huira.rgb.SceneView
__init__(self: huira._huira.rgb.SceneView, scene: huira._huira.rgb.Scene, exposure_interval: huira._huira.Interval, camera_instance: huira._huira.rgb.InstanceHandle, observation_mode: huira._huira.ObservationMode = <ObservationMode.ABERRATED_STATE: 2>, num_temporal_samples: Optional[int] = None, motion_tolerance: float = 0.1) → None

A view of the scene over an exposure, from a camera. The observation mode says where each thing is seen: ABERRATED_STATE (the default), with light time and the aberration from the camera’s velocity, as a camera really sees it; GEOMETRIC_STATE, with light time alone; or TRUE_STATE, where it is at the instant. With num_temporal_samples None (the default), each thing in view is given as many temporal samples as its motion needs, to be drawn within motion_tolerance pixels of its path: one, a still frame, if it does not move in view. A number gives everything that many; 1 renders a still frame, as does turning the camera’s motion blur off (enable_motion_blur(False)), whatever the number.

duration(self: huira._huira.rgb.SceneView) → huira._huira.Second
evaluate_transmittance(self: huira._huira.rgb.SceneView, shadow_ray: huira._huira.rgb.Ray, t_far: float, time: float = 0.5, alpha_mode: huira._huira.AlphaMode = <AlphaMode.STOCHASTIC: 0>, seed: Optional[int] = None) → huira._huira.rgb.SpectralBins

The transmittance along a shadow ray, out to t_far, through participating media and partly transparent surfaces. The ray starts outside any medium. With AlphaMode.STOCHASTIC, partly transparent surfaces are sampled at random: give a seed to repeat the result.

get_end_time(self: huira._huira.rgb.SceneView) → huira._huira.Time
get_exposure_interval(self: huira._huira.rgb.SceneView) → huira._huira.Interval
get_start_time(self: huira._huira.rgb.SceneView) → huira._huira.Time
get_time(self: huira._huira.rgb.SceneView) → huira._huira.Time
has_motion_blur(self: huira._huira.rgb.SceneView) → bool

Whether anything rays can hit moves in view during the exposure, as sampled

intersect(self: huira._huira.rgb.SceneView, ray: huira._huira.rgb.Ray, time: float = 0.5, mask: int = 4294967295) → huira._huira.HitRecord

Trace a ray against the scene and return a HitRecord

intersect_batch(self: huira._huira.rgb.SceneView, rays: list[huira._huira.rgb.Ray], time: float = 0.5) → list[huira._huira.HitRecord]

Trace a batch of rays against the scene and return HitRecords

max_temporal_samples(self: huira._huira.rgb.SceneView) → int

The most temporal samples anything in the view was given

object_ids(self: huira._huira.rgb.SceneView, hit: huira._huira.HitRecord) → huira._huira.ObjectIds

The IDs of the geometry, model, instance and part a HitRecord landed on, as an ObjectIds: each NO_OBJECT_ID for a miss or a light

occupancy_bounds_complete(self: huira._huira.rgb.SceneView) → bool

False when the occupancy bounds are not usable for region culling

resolve_hit(self: huira._huira.rgb.SceneView, ray: huira._huira.rgb.Ray, hit: huira._huira.HitRecord) → huira._huira.rgb.Interaction

Resolve a HitRecord into a full Interaction

resolve_hits_batch(self: huira._huira.rgb.SceneView, rays: list[huira._huira.rgb.Ray], hits: list[huira._huira.HitRecord]) → list[huira._huira.rgb.Interaction]

Resolve batches of HitRecords into Interactions

skipped_satellites(self: huira._huira.rgb.SceneView) → list[huira._huira.SkippedSatellite]

The satellites of the scene’s constellations left out, as SGP4 can’t place them during the exposure (SkippedSatellite)

tlas_is_empty(self: huira._huira.rgb.SceneView) → bool

True when the TLAS contains nothing that a ray could ever hit

unresolved_instances(self: huira._huira.rgb.SceneView) → list[huira._huira.rgb.UnresolvedInstance]

The instances of unresolved objects collected (UnresolvedInstance): those the scene graph places, then the satellites of the scene’s constellations in front of the camera

unresolved_irradiance(self: huira._huira.rgb.SceneView, instance: huira._huira.rgb.InstanceHandle, time: huira._huira.Time) → huira._huira.rgb.SpectralBins

The irradiance an instance of an unresolved object gives the camera at a time, as this view resolved it

class huira.rgb.UnresolvedInstance

An instance of an unresolved object in a scene view, at its temporal samples: one an instance in the scene graph places, or a satellite of a constellation

__init__(*args, **kwargs)
property catalog_number

A satellite’s NORAD catalog number, or 0

property constellation_id

A satellite’s constellation’s id, or NO_OBJECT_ID

property instance_id

The instance that places it, or NO_OBJECT_ID for a satellite

property irradiances

one for each sample, or one for all

Type:

The irradiance it gives the camera

property positions

Where it is in the camera’s frame at each sample, in meters

property times

The times of its temporal samples