across.tools.footprint

Submodules

• across.tools.footprint.footprint
• across.tools.footprint.healpix_joins
• across.tools.footprint.projection
• across.tools.footprint.schemas

Classes

Footprint	Class to represent a astronomical instrument's imaging footprint
Pointing	Class describing an astronomical pointing

Functions

inner(footprints[, order])	Computes the inner join from a list of footprints.
outer(footprints[, order])	Computes the outer join from a list of footprints
union(footprints[, order])	Computes the union of a list of footprints

Package Contents

class Footprint(/, **data)

Bases: across.tools.core.schemas.BaseSchema

Class to represent a astronomical instrument’s imaging footprint

detectors: list[across.tools.core.schemas.Polygon]

__repr__()

Overrides the print statement

__eq__(other)

Overrides the Footprint equals

_to_moc(order=10)

Convert a Footprint into a MOC object.

Parameters:

order (int, optional) – HEALPix order (10 = NSIDE 1024), by default 10

Returns:

MOC object representing the footprint.

Return type:

list[MOC]

project(coordinate, roll_angle)

Projects the footprint to a new coordinate with a given roll angle.

Parameters:

• coordinate (Coordinate) – The new center coordinate to project to.

• roll_angle (float) – The roll angle in degrees to apply during projection.

Returns:

The projected footprint.

Return type:

Footprint

query_pixels(order=10)

Queries the healpix pixels of a footprint at a given order.

Parameters:

order (int, optional) – HEALPix order (10 = NSIDE 1024), by default 10

Returns:

HEALPix NESTED pixel indices at requested order.

Return type:

list[int]

contains(coordinate, order=10)

Tests if a point exists in a footprint.

Parameters:

• coordinate (Coordinate) – The coordinate to check for containment.

• order (int, optional) – HEALPix order (10 = NSIDE 1024), by default 10

Returns:

True if the coordinate is contained within the footprint, False otherwise.

Return type:

bool

plot(fig=None, name=None, color=None, lat_axis_tick=30, lon_axis_tick=60)

Method to plot the footprint using plotly. Calls the across-tools plotting core functionality and configures the plot layout to user specifications.

Parameters:

• fig (go.Figure, optional) – An existing plotly figure to add the footprint to, by default None

• name (str | None, optional) – The name to assign to the detector traces, by default None

• color (str | None, optional) – The color to assign to the detector traces, by default None

• lat_axis_tick (int, optional) – The latitude axis tick interval, by default 30

• lon_axis_tick (int, optional) – The longitude axis tick interval, by default 60

Returns:

The plotly figure containing the footprint plot

Return type:

go.Figure

inner(footprints, order=10)

Computes the inner join from a list of footprints. Returns the list of overlapping healpix-pixels (i.e. the duplicates)

outer(footprints, order=10)

Computes the outer join from a list of footprints Returns the list of non-over lapping healpix pixels (i.e. the non-duplicates)

union(footprints, order=10)

Computes the union of a list of footprints Returns the list of overlapping and non overlapping healpix pixels (i.e. all unique pixels)

class Pointing(/, **data)

Bases: across.tools.core.schemas.BaseSchema

Class describing an astronomical pointing A pointing is described as a footprint valid for a given time range

footprint: across.tools.footprint.footprint.Footprint

start_time: across.tools.core.schemas.AstropyDateTime

end_time: across.tools.core.schemas.AstropyDateTime