neclib.coordinates.path_finder module#

Aliases#

CoordCalculator

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

Bases: object

Parameters:

  • az (Quantity)

  • el (Quantity)

  • dAz (Quantity)

  • dEl (Quantity)

  • time (List[float])

  • context (ControlContext)

az: Quantity#

Azimuth angle.

el: Quantity#

Elevation angle.

dAz: Quantity#

delta Azimuth angle.

dEl: Quantity#

delta 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 (PathLike | str | None)

  • direct_mode (bool)

  • direct_before (bool)

from_function(lon: Callable[[Index], T], lat: Callable[[Index], T], frame: str | BaseCoordinateFrame | Type[BaseCoordinateFrame], /, *, unit: UnitBase | str | None = None, n_cmd: int | float, context: ControlContext) → Generator[ApparentAltAzCoordinate, Literal[True], None][source]#
from_function(lon_lat: Callable[[Index], Tuple[T, T]], frame: str | BaseCoordinateFrame | Type[BaseCoordinateFrame], /, *, unit: UnitBase | str | None = None, n_cmd: 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 (int | Sequence[int])

Return type:

Generator[ApparentAltAzCoordinate, Literal[True], None]

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

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

  • unit (UnitBase | str | None)

  • start (Tuple[T, T])

  • stop (Tuple[T, T])

  • scan_frame (str | BaseCoordinateFrame | Type[BaseCoordinateFrame])

  • speed (T)

  • margin (T | None)

  • offset (Tuple[T, T, str | BaseCoordinateFrame | Type[BaseCoordinateFrame]] | None)

  • cos_correction (bool)

Return type:

Generator[ApparentAltAzCoordinate, Literal[True], None]

scan_block(*target, unit=None, scan_frame, sections, offset=None, cos_correction=False)[source]#
Parameters:

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

  • unit (UnitBase | str | None)

  • scan_frame (str | BaseCoordinateFrame | Type[BaseCoordinateFrame])

  • sections (Sequence[ScanBlockSection])

  • offset (Tuple[T, T, str | BaseCoordinateFrame | Type[BaseCoordinateFrame]] | None)

  • cos_correction (bool)

Return type:

Generator[ApparentAltAzCoordinate, Literal[True], None]

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

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

  • unit (UnitBase | str | None)

  • offset (Tuple[T, T, str | BaseCoordinateFrame | Type[BaseCoordinateFrame]] | None)

  • cos_correction (bool)

  • ctx_kw (Any)

Return type:

Generator[ApparentAltAzCoordinate, Literal[True], None]

class CoordinateGeneratorManager(generator=None)[source]#

Bases: object

Parameters:

generator (Generator[ApparentAltAzCoordinate, Literal[True], None] | 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:

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