Record the image ROI convention for operations taking ROI parameters

doc/contributing/guidelines.rst

@@ -127,7 +127,8 @@ Follow these rules when you add or change a computation function:
 - Rules that apply to every operation are recorded in the execution context
   rather than in each contract: the selection of image pixels by regions of
   interest (:data:`sigima.proc.contracts.IMAGE_ROI_CONVENTION`, recorded when an
-  input image carries regions of interest) and the X-alignment policies (see
+  input image carries regions of interest or when the operation takes image
+  regions of interest as parameters) and the X-alignment policies (see
   below). Increase the version of such a rule, not the contract versions, when
   it changes: a replay refuses the calls recorded with another version.
 

doc/locale/fr/LC_MESSAGES/contributing/guidelines.po

@@ -112,8 +112,8 @@ msgstr "Liste de contrôle pour toute modification d'une fonction de calcul exis
 msgid "Historical exception: the contracts were published with Sigima 1.3.0 and kept version 1 in Sigima 1.4.0 although several results changed, because they had just been published and were not used yet. This one-off decision does not apply to later changes."
 msgstr "Exception historique : les contrats, publiés avec Sigima 1.3.0, ont conservé la version 1 dans Sigima 1.4.0 bien que plusieurs résultats aient changé, car ils venaient d'être publiés et n'étaient pas encore exploités. Cette décision ponctuelle ne s'applique pas aux modifications ultérieures."
 
-msgid "Rules that apply to every operation are recorded in the execution context rather than in each contract: the selection of image pixels by regions of interest (:data:`sigima.proc.contracts.IMAGE_ROI_CONVENTION`, recorded when an input image carries regions of interest) and the X-alignment policies (see below). Increase the version of such a rule, not the contract versions, when it changes: a replay refuses the calls recorded with another version."
-msgstr "Les règles qui s'appliquent à toutes les opérations sont enregistrées dans le contexte d'exécution plutôt que dans chaque contrat : la sélection des pixels d'une image par les régions d'intérêt (:data:`sigima.proc.contracts.IMAGE_ROI_CONVENTION`, enregistrée lorsqu'une image d'entrée porte des régions d'intérêt) et les politiques d'alignement en X (voir ci-dessous). Augmentez la version d'une telle règle, et non les versions des contrats, lorsqu'elle change : un rejeu refuse les appels enregistrés avec une autre version."
+msgid "Rules that apply to every operation are recorded in the execution context rather than in each contract: the selection of image pixels by regions of interest (:data:`sigima.proc.contracts.IMAGE_ROI_CONVENTION`, recorded when an input image carries regions of interest or when the operation takes image regions of interest as parameters) and the X-alignment policies (see below). Increase the version of such a rule, not the contract versions, when it changes: a replay refuses the calls recorded with another version."
+msgstr "Les règles qui s'appliquent à toutes les opérations sont enregistrées dans le contexte d'exécution plutôt que dans chaque contrat : la sélection des pixels d'une image par les régions d'intérêt (:data:`sigima.proc.contracts.IMAGE_ROI_CONVENTION`, enregistrée lorsqu'une image d'entrée porte des régions d'intérêt ou lorsque l'opération prend des régions d'intérêt d'image en paramètres) et les politiques d'alignement en X (voir ci-dessous). Augmentez la version d'une telle règle, et non les versions des contrats, lorsqu'elle change : un rejeu refuse les appels enregistrés avec une autre version."
 
 msgid "The structure of the contract (input roles, parameter arguments, outputs) is inferred from the annotations. Annotate every argument and the return value with names imported at runtime (not only under ``TYPE_CHECKING``). When roles cannot be inferred (more than two input objects), declare them with ``roles=(...)``."
 msgstr "La structure du contrat (rôles des entrées, arguments de paramètres, sorties) est déduite des annotations. Annotez chaque argument et la valeur de retour avec des noms importés à l'exécution (pas seulement sous ``TYPE_CHECKING``). Lorsque les rôles ne peuvent pas être déduits (plus de deux objets en entrée), déclarez-les avec ``roles=(...)``."

doc/locale/fr/LC_MESSAGES/release_notes/release_1.04.po

@@ -67,8 +67,8 @@ msgstr "**ROI rectangulaires en indices de pixels** : le rectangle physique d'un
 msgid "**ROIs saved with earlier versions**: The ROIs of objects saved with earlier versions are not converted: they select pixels according to the rules above, so that processing and analysis in these ROIs may give different results when they are recomputed."
 msgstr "**ROI enregistrées avec des versions antérieures** : les ROI des objets enregistrés avec des versions antérieures ne sont pas converties : elles sélectionnent les pixels selon les règles ci-dessus, de sorte que les traitements et analyses dans ces ROI peuvent donner des résultats différents lorsqu'ils sont recalculés."
 
-msgid "**Replay of processing in image ROIs**: The selection of image pixels by regions of interest is now recorded with each call on images carrying regions of interest (rule `sigima.image.roi.pixel_centers`, `sigima.proc.contracts.IMAGE_ROI_CONVENTION`, in the execution context described by `describe_call` and `prepare_execution`). Applications that replay recorded processing (e.g. DataLab capsules) refuse to replay such calls recorded with earlier versions, which selected other pixels, instead of reporting a different result. Calls on images without regions of interest are not concerned."
-msgstr "**Rejeu des traitements dans les ROI d'images** : la sélection des pixels d'une image par les régions d'intérêt est désormais enregistrée avec chaque appel sur des images portant des régions d'intérêt (règle `sigima.image.roi.pixel_centers`, `sigima.proc.contracts.IMAGE_ROI_CONVENTION`, dans le contexte d'exécution décrit par `describe_call` et `prepare_execution`). Les applications qui rejouent des traitements enregistrés (par exemple les capsules DataLab) refusent de rejouer de tels appels enregistrés avec des versions antérieures, qui sélectionnaient d'autres pixels, au lieu de signaler un résultat différent. Les appels sur des images sans région d'intérêt ne sont pas concernés."
+msgid "**Replay of processing in image ROIs**: The selection of image pixels by regions of interest is now recorded with each call on images carrying regions of interest, and with each call of the operations taking image regions of interest as parameters (`extract_roi`, `extract_rois`, `erase` and `offset_correction`), whatever their input (rule `sigima.image.roi.pixel_centers`, `sigima.proc.contracts.IMAGE_ROI_CONVENTION`, in the execution context described by `describe_call` and `prepare_execution`). Applications that replay recorded processing (e.g. DataLab capsules) refuse to replay such calls recorded with earlier versions, which selected other pixels, instead of reporting a different result. Other calls on images without regions of interest are not concerned."
+msgstr "**Rejeu des traitements dans les ROI d'images** : la sélection des pixels d'une image par les régions d'intérêt est désormais enregistrée avec chaque appel sur des images portant des régions d'intérêt, et avec chaque appel des opérations qui prennent des régions d'intérêt d'image en paramètres (`extract_roi`, `extract_rois`, `erase` et `offset_correction`), quelle que soit leur entrée (règle `sigima.image.roi.pixel_centers`, `sigima.proc.contracts.IMAGE_ROI_CONVENTION`, dans le contexte d'exécution décrit par `describe_call` et `prepare_execution`). Les applications qui rejouent des traitements enregistrés (par exemple les capsules DataLab) refusent de rejouer de tels appels enregistrés avec des versions antérieures, qui sélectionnaient d'autres pixels, au lieu de signaler un résultat différent. Les autres appels sur des images sans région d'intérêt ne sont pas concernés."
 
 msgid "**Image center**: `ImageObj.xc` and `ImageObj.yc` are now the center of the pixel grid (halfway between the centers of the first and last pixels), for uniform and non-uniform coordinates: they were half a pixel off for uniform coordinates. `width` and `height` are unchanged."
 msgstr "**Centre de l'image** : `ImageObj.xc` et `ImageObj.yc` sont désormais le centre de la grille de pixels (à mi-chemin entre les centres du premier et du dernier pixel), pour des coordonnées uniformes ou non : ils étaient décalés d'un demi-pixel pour des coordonnées uniformes. `width` et `height` sont inchangés."

doc/locale/fr/LC_MESSAGES/user_guide/contracts.po

@@ -51,8 +51,8 @@ msgstr "Règles du contexte d'exécution"
 msgid "Some rules apply to every operation, or to a family of operations, and are recorded with each call rather than in each contract, with their own identifier and version:"
 msgstr "Certaines règles s'appliquent à toutes les opérations, ou à une famille d'opérations, et sont enregistrées avec chaque appel plutôt que dans chaque contrat, avec leurs propres identifiant et version :"
 
-msgid "the selection of image pixels by regions of interest (``sigima.image.roi.pixel_centers``, :data:`sigima.proc.contracts.IMAGE_ROI_CONVENTION`), recorded when an input image carries regions of interest;"
-msgstr "la sélection des pixels d'une image par les régions d'intérêt (``sigima.image.roi.pixel_centers``, :data:`sigima.proc.contracts.IMAGE_ROI_CONVENTION`), enregistrée lorsqu'une image d'entrée porte des régions d'intérêt ;"
+msgid "the selection of image pixels by regions of interest (``sigima.image.roi.pixel_centers``, :data:`sigima.proc.contracts.IMAGE_ROI_CONVENTION`), recorded when an input image carries regions of interest or when the operation takes image regions of interest as parameters (ROI extraction, erasing, offset correction);"
+msgstr "la sélection des pixels d'une image par les régions d'intérêt (``sigima.image.roi.pixel_centers``, :data:`sigima.proc.contracts.IMAGE_ROI_CONVENTION`), enregistrée lorsqu'une image d'entrée porte des régions d'intérêt ou lorsque l'opération prend des régions d'intérêt d'image en paramètres (extraction de ROI, effacement, correction d'offset) ;"
 
 msgid "the alignment of signals on a common X grid, for operations combining several signals (``sigima.signal.x_alignment.*`` policies);"
 msgstr "l'alignement des signaux sur une grille X commune, pour les opérations combinant plusieurs signaux (politiques ``sigima.signal.x_alignment.*``) ;"

doc/release_notes/release_1.04.md

@@ -23,7 +23,7 @@ The [user guide](../user_guide/overview.rst) shows how readers and connectors at
 * **Grids of ROIs**: The cells of ROI grids are now made of whole pixels: each cell holds the pixels whose centers lie in it, from its start included to its end excluded, and its ROI goes from the outer edges of these pixels. Adjacent cells thus never share a pixel, and the cells of a grid with 100 % sizes and steps tile the image exactly; cell positions are rounded to whole pixels. The grid of an image with non-uniform coordinates now spans the actual extent of its axes: its last rows and columns were left out.
 * **Rectangular ROIs in pixel indices**: The physical rectangle of a ROI defined in pixel indices now goes from the outer edges of its pixels, half a pixel before the center of the first pixel and half a pixel after the center of the last one. Converting a ROI between pixel indices and physical coordinates keeps the same pixels.
 * **ROIs saved with earlier versions**: The ROIs of objects saved with earlier versions are not converted: they select pixels according to the rules above, so that processing and analysis in these ROIs may give different results when they are recomputed.
-* **Replay of processing in image ROIs**: The selection of image pixels by regions of interest is now recorded with each call on images carrying regions of interest (rule `sigima.image.roi.pixel_centers`, `sigima.proc.contracts.IMAGE_ROI_CONVENTION`, in the execution context described by `describe_call` and `prepare_execution`). Applications that replay recorded processing (e.g. DataLab capsules) refuse to replay such calls recorded with earlier versions, which selected other pixels, instead of reporting a different result. Calls on images without regions of interest are not concerned.
+* **Replay of processing in image ROIs**: The selection of image pixels by regions of interest is now recorded with each call on images carrying regions of interest, and with each call of the operations taking image regions of interest as parameters (`extract_roi`, `extract_rois`, `erase` and `offset_correction`), whatever their input (rule `sigima.image.roi.pixel_centers`, `sigima.proc.contracts.IMAGE_ROI_CONVENTION`, in the execution context described by `describe_call` and `prepare_execution`). Applications that replay recorded processing (e.g. DataLab capsules) refuse to replay such calls recorded with earlier versions, which selected other pixels, instead of reporting a different result. Other calls on images without regions of interest are not concerned.
 * **Image center**: `ImageObj.xc` and `ImageObj.yc` are now the center of the pixel grid (halfway between the centers of the first and last pixels), for uniform and non-uniform coordinates: they were half a pixel off for uniform coordinates. `width` and `height` are unchanged.
 * **Ellipse coordinates**: `EllipseCoordinates` (`sigima.objects.shape`) now holds the 5 values `(x, y, a, b, theta)` of ellipse geometry results, which can thus be transformed.
 * **Operation contract versions**: The operation contracts keep version 1 in this release, although the result of some operations changed since 1.3.0 (for example `resampling`, `extract_roi` and the product of signals): the contracts had just been published with Sigima 1.3.0 and were not used yet. This one-off exception does not apply to later changes: from now on, the version of a contract is increased whenever a change of the computation changes its result, whatever the releases of the applications using Sigima, and calls recorded with an earlier version are refused instead of being replayed (see [Operation contracts and versions](../user_guide/contracts.rst)). The image profiles, changed afterwards (see below), are thus at version 2.

doc/user_guide/contracts.rst

@@ -60,7 +60,8 @@ and version:
 - the selection of image pixels by regions of interest
   (``sigima.image.roi.pixel_centers``,
   :data:`sigima.proc.contracts.IMAGE_ROI_CONVENTION`), recorded when an input
-  image carries regions of interest;
+  image carries regions of interest or when the operation takes image regions of
+  interest as parameters (ROI extraction, erasing, offset correction);
 - the alignment of signals on a common X grid, for operations combining several
   signals (``sigima.signal.x_alignment.*`` policies);
 - the global options read by a computation and the metadata of its inputs it