neuralib.registration.coordinates.get_field_of_view

neuralib.registration.coordinates.get_field_of_view(am, pm, pl, al, *, rotation_ml=0, rotation_ap=0, unit='mm', perpendicular=True, region_name=None)[source]

Construct a FieldOfView from four corner coordinates.

Parameters:

  • am (Sequence[float]) – anteromedial corner coordinate [x, y] in mm or µm.

  • pm (Sequence[float]) – posteromedial corner coordinate [x, y] in mm or µm.

  • pl (Sequence[float]) – posterolateral corner coordinate [x, y] in mm or µm.

  • al (Sequence[float]) – anterolateral corner coordinate [x, y] in mm or µm.

  • rotation_ml (float) – in-plane rotation (CCW) around the ML axis, in degrees.

  • rotation_ap (float) – tilt around the AP axis (foreshortening), in degrees.

  • unit (Literal['mm', 'um']) – unit of the corners value

  • perpendicular (bool) – imaging objective is perpendicular to the cranial windows. if True, skip rotation and tilt transforms.

  • region_name (str | None) – optional identifier for this FOV region.

Returns:

FieldOfView instance with corners stacked and optionally transformed.

Return type:

FieldOfView