Probe

Probe

Probe()

A probe that is used to access the Jacobian weight of a point or region of interest.

For continuous probes, None skips that dimension and includes the full range of the dimension (Jacobian weight of 1).

For discrete probes, the first vector specifies a path through nested discrete grids, and the second vector specifies the final continuous probe. The path may stop before the full grid depth, in which case the remaining sub-Jacobian weight is 1 and the continuous probe must be empty.

For uniform probes, None in the discrete indices skips that discrete dimension and includes its full range (Jacobian weight of 1).

Attributes

Name Description
c A sample in the continuous layer
d A sample point per (nested) discrete layer
u A sample in the uniform layer

c

c: list[float | None]

A sample in the continuous layer. Empty if not present.

d

d: list[int]

A sample point per (nested) discrete layer. Empty if not present.

u

u: list[int | None]

A sample in the uniform layer. Empty if not present.

Methods

Name Description
continuous Create a probe with the given continuous sample
discrete Create a probe with the given discrete indices and optional continuous sample
uniform Create a probe with the given uniform indices and optional continuous sample

continuous

Probe.continuous(c: list[float | None]) -> Probe

Create a probe with the given continuous sample. Entering None skips that dimension and includes the full range of the dimension (Jacobian weight of 1).

Parameters

  • c (list[float | None]) The continuous probe coordinates; use None to include the full range of a dimension.

discrete

Probe.discrete(d: list[int], c: list[float | None] | None = None) -> Probe

Create a probe with the given discrete indices and optional continuous sample. The discrete indices are allowed to be less deep than the grid depth.

Parameters

  • d (list[int]) The discrete probe indices for each nested discrete layer.
  • c (list[float | None] | None) The continuous probe coordinates; use None to include the full range of a dimension.

uniform

Probe.uniform(u: list[int | None], c: list[float | None] | None = None) -> Probe

Create a probe with the given uniform indices and optional continuous sample. Entering None skips that dimension and includes the full range of the dimension (Jacobian weight of 1).

Parameters

  • u (list[int | None]) The uniform discrete probe indices; use None to include the full range of a layer.
  • c (list[float | None] | None) The continuous probe coordinates; use None to include the full range of a dimension.