ostk.astrodynamics.eclipse.Generator¶

class Generator(*args, **kwargs)¶

Bases: pybind11_object

An eclipse generator.

Overloaded function.

__init__(self: ostk.astrodynamics.eclipse.Generator, environment: ostk.physics.Environment = -- Environment ------------------------------------------------------------------------------------- Instant: 2000-01-01 11:58:55.816 [UTC] Objects: -- Object ------------------------------------------------------------------------------------------ Name: Earth ---------------------------------------------------------------------------------------------------- -- Object ------------------------------------------------------------------------------------------ Name: Sun ---------------------------------------------------------------------------------------------------- -- Object ------------------------------------------------------------------------------------------ Name: Moon ---------------------------------------------------------------------------------------------------- Central celestial object: -- Object ------------------------------------------------------------------------------------------ Name: Earth ---------------------------------------------------------------------------------------------------- ----------------------------------------------------------------------------------------------------, search_step_size: ostk.physics.time.Duration = 01:00.000.000.000, search_tolerance: ostk.physics.time.Duration = 00.001.000.000) -> None

Constructor.

Args:
environment (Environment): The Environment to use during the search. Defaults to the Environment.default(). search_step_size (Duration): The step size to use during the search. Defaults to Duration.seconds(60.0). search_tolerance (Duration): The tolerance to use during the search. Defaults to Duration.milliseconds(1.0).
__init__(self: ostk.astrodynamics.eclipse.Generator) -> None

Default constructor with default parameters.

Methods

`generate`	Generate eclipses for a given trajectory over the provided analysis interval.
`get_environment`	Get the environment.
`get_search_step_size`	Get the search step size.
`get_search_tolerance`	Get the search tolerance.
`is_defined`	Check if eclipse generator is defined.

generate( self: ostk.astrodynamics.eclipse.Generator, trajectory: ostk.astrodynamics.Trajectory, analysis_interval: ostk.physics.time.Interval, occulted_celestial_object_name: ostk.core.type.String = 'Sun', occulting_celestial_object_name: ostk.core.type.String = 'Earth', ) → list[ostk.physics.environment.utility.Eclipse]¶

Generate eclipses for a given trajectory over the provided analysis interval.

Parameters:

trajectory (Trajectory) -- The trajectory to search for eclipses.
analysis_interval (Interval) -- The analysis interval.
occulted_celestial_object_name (str) -- The name of the occulted celestial object. Defaults to "Sun".
occulting_celestial_object_name (str) -- The name of the occulting celestial object. Defaults to "Earth".

Returns: