Scene

class huira.rgb.Scene

__init__(self: huira._huira.rgb.Scene) → None

delete_camera_model(self: huira._huira.rgb.Scene, camera_model_handle: huira._huira.rgb.CameraModelHandle) → None

delete_light(self: huira._huira.rgb.Scene, light_handle: huira._huira.rgb.LightHandle) → None

delete_unresolved_object(self: huira._huira.rgb.Scene, unresolved_object_handle: huira._huira.rgb.UnresolvedObjectHandle) → None

get_camera_model(self: huira._huira.rgb.Scene, name: str) → huira._huira.rgb.CameraModelHandle

Get a camera model handle by name

get_light(self: huira._huira.rgb.Scene, name: str) → huira._huira.rgb.LightHandle

Get a light handle by name

get_unresolved_object(self: huira._huira.rgb.Scene, name: str) → huira._huira.rgb.UnresolvedObjectHandle

Get an unresolved object handle by name

load_stars(self: huira._huira.rgb.Scene, star_catalog_path: os.PathLike, time: huira._huira.Time, min_magnitude: float = 100.0) → None

Load stars from a catalog file for the given observation time

new_camera_model(self: huira._huira.rgb.Scene, name: str = '') → huira._huira.rgb.CameraModelHandle

Create a new camera model and return its handle

new_point_light(*args, **kwargs)

Overloaded function.

1. new_point_light(self: huira._huira.rgb.Scene, spectral_power: huira._huira.rgb.SpectralWatts, name: str = ‘’) -> huira._huira.rgb.LightHandle

Create a point light from spectral power (SpectralWatts)

2. new_point_light(self: huira._huira.rgb.Scene, total_power: object, name: str = ‘’) -> huira._huira.rgb.LightHandle

Create a point light from total power (any power unit)

new_sun_light(self: huira._huira.rgb.Scene) → huira._huira.rgb.LightHandle

Create a sun light source

new_unresolved_asteroid(*args, **kwargs)

Overloaded function.

1. new_unresolved_asteroid(self: huira._huira.rgb.Scene, H: float, G: float, sun: huira._huira.rgb.InstanceHandle, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved asteroid from H, G magnitude parameters

2. new_unresolved_asteroid(self: huira._huira.rgb.Scene, H: float, G: float, sun: huira._huira.rgb.InstanceHandle, albedo: huira._huira.rgb.SpectralBins, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved asteroid with spectral albedo

3. new_unresolved_asteroid(self: huira._huira.rgb.Scene, H: float, G: float, sun: huira._huira.rgb.InstanceHandle, scalar_albedo: float, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved asteroid with scalar albedo

new_unresolved_emitter(*args, **kwargs)

Overloaded function.

1. new_unresolved_emitter(self: huira._huira.rgb.Scene, spectral_power: huira._huira.rgb.SpectralWatts, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved emitter from spectral power

2. new_unresolved_emitter(self: huira._huira.rgb.Scene, power: object, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved emitter from total power (any power unit)

new_unresolved_object(*args, **kwargs)

Overloaded function.

1. new_unresolved_object(self: huira._huira.rgb.Scene, spectral_irradiance: huira._huira.rgb.SpectralWattsPerMeterSquared, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved object from spectral irradiance

2. new_unresolved_object(self: huira._huira.rgb.Scene, irradiance: object, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved object from scalar irradiance (any irradiance unit)

new_unresolved_object_from_magnitude(*args, **kwargs)

Overloaded function.

1. new_unresolved_object_from_magnitude(self: huira._huira.rgb.Scene, visual_magnitude: float, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved object from visual magnitude

2. new_unresolved_object_from_magnitude(self: huira._huira.rgb.Scene, visual_magnitude: float, albedo: huira._huira.rgb.SpectralBins, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved object from visual magnitude with spectral albedo

new_unresolved_sphere(*args, **kwargs)

Overloaded function.

1. new_unresolved_sphere(self: huira._huira.rgb.Scene, radius: object, sun: huira._huira.rgb.InstanceHandle, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved sphere (accepts any distance unit for radius)

2. new_unresolved_sphere(self: huira._huira.rgb.Scene, radius: object, sun: huira._huira.rgb.InstanceHandle, albedo: huira._huira.rgb.SpectralBins, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved sphere with spectral albedo

3. new_unresolved_sphere(self: huira._huira.rgb.Scene, radius: object, sun: huira._huira.rgb.InstanceHandle, scalar_albedo: float, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved sphere with scalar albedo

print_contents(self: huira._huira.rgb.Scene) → None

print_graph(self: huira._huira.rgb.Scene) → None

property root

set_camera_model_name(self: huira._huira.rgb.Scene, camera_model_handle: huira._huira.rgb.CameraModelHandle, name: str) → None

Set the name of a camera model

set_light_name(self: huira._huira.rgb.Scene, light_handle: huira._huira.rgb.LightHandle, name: str) → None

Set the name of a light

set_unresolved_object_name(self: huira._huira.rgb.Scene, unresolved_object_handle: huira._huira.rgb.UnresolvedObjectHandle, name: str) → None

Set the name of an unresolved object

class huira.visible8.Scene

__init__(self: huira._huira.visible8.Scene) → None

delete_camera_model(self: huira._huira.visible8.Scene, camera_model_handle: huira._huira.visible8.CameraModelHandle) → None

delete_light(self: huira._huira.visible8.Scene, light_handle: huira._huira.visible8.LightHandle) → None

delete_unresolved_object(self: huira._huira.visible8.Scene, unresolved_object_handle: huira._huira.visible8.UnresolvedObjectHandle) → None

get_camera_model(self: huira._huira.visible8.Scene, name: str) → huira._huira.visible8.CameraModelHandle

Get a camera model handle by name

get_light(self: huira._huira.visible8.Scene, name: str) → huira._huira.visible8.LightHandle

Get a light handle by name

get_unresolved_object(self: huira._huira.visible8.Scene, name: str) → huira._huira.visible8.UnresolvedObjectHandle

Get an unresolved object handle by name

load_stars(self: huira._huira.visible8.Scene, star_catalog_path: os.PathLike, time: huira._huira.Time, min_magnitude: float = 100.0) → None

Load stars from a catalog file for the given observation time

new_camera_model(self: huira._huira.visible8.Scene, name: str = '') → huira._huira.visible8.CameraModelHandle

Create a new camera model and return its handle

new_point_light(*args, **kwargs)

Overloaded function.

1. new_point_light(self: huira._huira.visible8.Scene, spectral_power: huira._huira.visible8.SpectralWatts, name: str = ‘’) -> huira._huira.visible8.LightHandle

Create a point light from spectral power (SpectralWatts)

2. new_point_light(self: huira._huira.visible8.Scene, total_power: object, name: str = ‘’) -> huira._huira.visible8.LightHandle

Create a point light from total power (any power unit)

new_sun_light(self: huira._huira.visible8.Scene) → huira._huira.visible8.LightHandle

Create a sun light source

new_unresolved_asteroid(*args, **kwargs)

Overloaded function.

1. new_unresolved_asteroid(self: huira._huira.visible8.Scene, H: float, G: float, sun: huira._huira.visible8.InstanceHandle, name: str = ‘’) -> huira._huira.visible8.UnresolvedObjectHandle

Create an unresolved asteroid from H, G magnitude parameters

2. new_unresolved_asteroid(self: huira._huira.visible8.Scene, H: float, G: float, sun: huira._huira.visible8.InstanceHandle, albedo: huira._huira.visible8.SpectralBins, name: str = ‘’) -> huira._huira.visible8.UnresolvedObjectHandle

Create an unresolved asteroid with spectral albedo

3. new_unresolved_asteroid(self: huira._huira.visible8.Scene, H: float, G: float, sun: huira._huira.visible8.InstanceHandle, scalar_albedo: float, name: str = ‘’) -> huira._huira.visible8.UnresolvedObjectHandle

Create an unresolved asteroid with scalar albedo

new_unresolved_emitter(*args, **kwargs)

Overloaded function.

1. new_unresolved_emitter(self: huira._huira.visible8.Scene, spectral_power: huira._huira.visible8.SpectralWatts, name: str = ‘’) -> huira._huira.visible8.UnresolvedObjectHandle

Create an unresolved emitter from spectral power

2. new_unresolved_emitter(self: huira._huira.visible8.Scene, power: object, name: str = ‘’) -> huira._huira.visible8.UnresolvedObjectHandle

Create an unresolved emitter from total power (any power unit)

new_unresolved_object(*args, **kwargs)

Overloaded function.

1. new_unresolved_object(self: huira._huira.visible8.Scene, spectral_irradiance: huira._huira.visible8.SpectralWattsPerMeterSquared, name: str = ‘’) -> huira._huira.visible8.UnresolvedObjectHandle

Create an unresolved object from spectral irradiance

2. new_unresolved_object(self: huira._huira.visible8.Scene, irradiance: object, name: str = ‘’) -> huira._huira.visible8.UnresolvedObjectHandle

Create an unresolved object from scalar irradiance (any irradiance unit)

new_unresolved_object_from_magnitude(*args, **kwargs)

Overloaded function.

1. new_unresolved_object_from_magnitude(self: huira._huira.visible8.Scene, visual_magnitude: float, name: str = ‘’) -> huira._huira.visible8.UnresolvedObjectHandle

Create an unresolved object from visual magnitude

2. new_unresolved_object_from_magnitude(self: huira._huira.visible8.Scene, visual_magnitude: float, albedo: huira._huira.visible8.SpectralBins, name: str = ‘’) -> huira._huira.visible8.UnresolvedObjectHandle

Create an unresolved object from visual magnitude with spectral albedo

new_unresolved_sphere(*args, **kwargs)

Overloaded function.

1. new_unresolved_sphere(self: huira._huira.visible8.Scene, radius: object, sun: huira._huira.visible8.InstanceHandle, name: str = ‘’) -> huira._huira.visible8.UnresolvedObjectHandle

Create an unresolved sphere (accepts any distance unit for radius)

2. new_unresolved_sphere(self: huira._huira.visible8.Scene, radius: object, sun: huira._huira.visible8.InstanceHandle, albedo: huira._huira.visible8.SpectralBins, name: str = ‘’) -> huira._huira.visible8.UnresolvedObjectHandle

Create an unresolved sphere with spectral albedo

3. new_unresolved_sphere(self: huira._huira.visible8.Scene, radius: object, sun: huira._huira.visible8.InstanceHandle, scalar_albedo: float, name: str = ‘’) -> huira._huira.visible8.UnresolvedObjectHandle

Create an unresolved sphere with scalar albedo

print_contents(self: huira._huira.visible8.Scene) → None

print_graph(self: huira._huira.visible8.Scene) → None

property root

set_camera_model_name(self: huira._huira.visible8.Scene, camera_model_handle: huira._huira.visible8.CameraModelHandle, name: str) → None

Set the name of a camera model

set_light_name(self: huira._huira.visible8.Scene, light_handle: huira._huira.visible8.LightHandle, name: str) → None

Set the name of a light

set_unresolved_object_name(self: huira._huira.visible8.Scene, unresolved_object_handle: huira._huira.visible8.UnresolvedObjectHandle, name: str) → None

Set the name of an unresolved object