neclib.coordinates.path_finder#

Aliases#

CoordCalculator

Collection of basic methods for celestial coordinate calculation.
class ApparentAltAzCoordinate(az: astropy.units.quantity.Quantity, el: astropy.units.quantity.Quantity, time: List[float], context: neclib.coordinates.paths.path_base.ControlContext)[source]#

Bases: object

Parameters:

  • az (Quantity) –

  • el (Quantity) –

  • time (List[float]) –

  • context (ControlContext) –

az: Quantity#

Azimuth angle.

el: Quantity#

Elevation angle.

time: List[float]#

Time for each coordinate.

context: ControlContext#

Metadata of the control section this coordinate object is a part of.

class PathFinder(location=<EarthLocation (-3871165.06944156, 3428273.15427448, 3723695.62006595) m>, pointing_err_file=None, direct_mode=False, direct_before=None)[source]#

Bases: CoordCalculator

Parameters:

  • location (EarthLocation) –

  • pointing_err_file (Optional[Union[PathLike, str]]) –

  • direct_mode (bool) –

  • direct_before (bool) –

from_function(lon: Callable[[Index], T], lat: Callable[[Index], T], frame: Union[str, BaseCoordinateFrame, Type[BaseCoordinateFrame]], /, *, unit: Optional[Union[UnitBase, str]] = None, n_cmd: Union[int, float], context: ControlContext) → Generator[ApparentAltAzCoordinate, Literal[True], None][source]#
from_function(lon_lat: Callable[[Index], Tuple[T, T]], frame: Union[str, BaseCoordinateFrame, Type[BaseCoordinateFrame]], /, *, unit: Optional[Union[UnitBase, str]] = None, n_cmd: Union[int, float], context: ControlContext) → Generator[ApparentAltAzCoordinate, Literal[True], None]

Generate coordinate commands from arbitrary function.

sequential(*section_args, repeat=1)[source]#
Parameters:

  • section_args (Tuple[Sequence[Any], Dict[str, Any]]) –

  • repeat (Union[int, Sequence[int]]) –

Return type:

Generator[ApparentAltAzCoordinate, Literal[True], None]

linear(*target, unit=None, start, stop, scan_frame, speed, margin=None, offset=None)[source]#
Parameters:

  • target (Union[int, float, ndarray[Any, dtype[number]], Array[Union[int, float]], Quantity, str, BaseCoordinateFrame, Type[BaseCoordinateFrame]]) –

  • unit (Optional[Union[UnitBase, str]]) –

  • start (Tuple[T, T]) –

  • stop (Tuple[T, T]) –

  • scan_frame (Union[str, BaseCoordinateFrame, Type[BaseCoordinateFrame]]) –

  • speed (T) –

  • margin (Optional[T]) –

  • offset (Optional[Tuple[T, T, Union[str, BaseCoordinateFrame, Type[BaseCoordinateFrame]]]]) –

Return type:

Generator[ApparentAltAzCoordinate, Literal[True], None]

track(*target, unit=None, offset=None, **ctx_kw)[source]#
Parameters:

  • target (Union[int, float, ndarray[Any, dtype[number]], Array[Union[int, float]], Quantity, str, BaseCoordinateFrame, Type[BaseCoordinateFrame]]) –

  • unit (Optional[Union[UnitBase, str]]) –

  • offset (Optional[Tuple[T, T, Union[str, BaseCoordinateFrame, Type[BaseCoordinateFrame]]]]) –

  • ctx_kw (Any) –

Return type:

Generator[ApparentAltAzCoordinate, Literal[True], None]

class CoordinateGeneratorManager(generator=None)[source]#

Bases: object

Parameters:

generator (Optional[Generator[ApparentAltAzCoordinate, Literal[True], None]]) –

will_send(value)[source]#
Parameters:

value (Any) –

Return type:

None

attach(generator)[source]#
Parameters:

generator (Generator[ApparentAltAzCoordinate, Literal[True], None]) –

Return type:

None

clear()[source]#
Return type:

None

get()[source]#
Return type:

Optional[Generator[ApparentAltAzCoordinate, Literal[True], None]]