Allow to mirror datasets #8485
Allow to mirror datasets #8485
Conversation
📝 WalkthroughWalkthroughThe changes incorporate a new mirroring functionality into dataset rotation settings. A Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx (1)
79-96:⚠️ Potential issueBug in mirroring toggle handling.
When the
isMirroredparameter is false, it won't update the rotation values because of the conditionif (isMirrored). This means toggling mirroring off won't work correctly.Apply this fix:
-if (isMirrored) { - rotationValues.isMirrored = isMirrored; +if (isMirrored !== undefined) { + rotationValues.isMirrored = isMirrored; }
🧹 Nitpick comments (3)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx (1)
149-161: New checkbox for mirror functionality.The added checkbox component allows users to toggle mirroring for each axis. The label and formatting look good, but the comment is misleading.
-label={`Mirror ${axis.toUpperCase()} Axis`} /* Whitespace label is needed for correct formatting*/ +label={`Mirror ${axis.toUpperCase()} Axis`}Consider also adding a tooltip explaining what mirroring does:
<FormItem name={["datasetRotation", axis, "isMirrored"]} colon={false} valuePropName="checked" - label={`Mirror ${axis.toUpperCase()} Axis`} /* Whitespace label is needed for correct formatting*/ + label={`Mirror ${axis.toUpperCase()} Axis`} + tooltip="Mirror the dataset across this axis, flipping the image orientation" >frontend/javascripts/dashboard/dataset/dataset_settings_view.tsx (1)
212-213: Default initialization for rotation settings.The code initializes rotation settings with default values for both rotation degrees and mirroring state.
Consider adding a comment explaining the default values, especially for the
isMirroredproperty:-const nulledSetting = { rotationInDegrees: 0, isMirrored: false }; +// Initialize with no rotation and no mirroring by default +const nulledSetting = { rotationInDegrees: 0, isMirrored: false };frontend/javascripts/oxalis/model/accessors/dataset_layer_transformation_accessor.ts (1)
407-409: Updated comments to indicate mirroring possibility.The comments have been updated to indicate that the rotation transformations may include mirroring, which is helpful for understanding the transformation pipeline.
Consider adding a brief explanation of what mirroring means in this context:
-// 2. Rotation around x-axis (potentially mirrored) -// 3. Rotation around y-axis (potentially mirrored) -// 4. Rotation around z-axis (potentially mirrored) +// 2. Rotation around x-axis (potentially mirrored - flipping the axis orientation) +// 3. Rotation around y-axis (potentially mirrored - flipping the axis orientation) +// 4. Rotation around z-axis (potentially mirrored - flipping the axis orientation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx(7 hunks)frontend/javascripts/dashboard/dataset/dataset_settings_data_tab.tsx(1 hunks)frontend/javascripts/dashboard/dataset/dataset_settings_view.tsx(4 hunks)frontend/javascripts/oxalis/model/accessors/dataset_layer_transformation_accessor.ts(5 hunks)
🧰 Additional context used
🧬 Code Definitions (3)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx (1)
frontend/javascripts/oxalis/model/accessors/dataset_layer_transformation_accessor.ts (2)
RotationSetting(76-79)getRotationMatrixAroundAxis(123-144)
frontend/javascripts/oxalis/model/accessors/dataset_layer_transformation_accessor.ts (2)
frontend/javascripts/types/api_flow_types.ts (2)
CoordinateTransformation(74-74)AffineTransformation(64-67)frontend/javascripts/oxalis/model/helpers/transformation_helpers.ts (1)
nestedToFlatMatrix(7-9)
frontend/javascripts/dashboard/dataset/dataset_settings_view.tsx (2)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx (1)
DatasetRotationSettings(170-174)frontend/javascripts/oxalis/model/accessors/dataset_layer_transformation_accessor.ts (2)
EXPECTED_TRANSFORMATION_LENGTH(411-411)getRotationSettingsFromTransformationIn90DegreeSteps(82-105)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: circleci_build
🔇 Additional comments (11)
frontend/javascripts/dashboard/dataset/dataset_settings_data_tab.tsx (1)
304-305: Appropriate UI adjustment for new mirroring functionality.The column width has been increased from
xl={6}toxl={12}to accommodate the new mirroring controls in theAxisRotationSettingForDatasetcomponent. This layout change ensures that the rotation settings and mirroring checkboxes have sufficient space.frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx (3)
4-4: Added checkbox import for new mirroring functionality.The import of the Checkbox component is required for the newly added mirroring controls.
58-62: Updated rotation values structure to support mirroring.The rotation values structure now uses the
RotationSettingtype which includes both rotation degree and mirroring information.
170-174: Type renamed for better clarity.The type has been renamed from
DatasetRotationtoDatasetRotationSettingsto better represent its purpose, and its structure has been updated to use the newRotationSettingtype for each axis.frontend/javascripts/dashboard/dataset/dataset_settings_view.tsx (3)
31-31: Updated function name to reflect its expanded functionality.The function has been renamed from
getRotationFromTransformationIn90DegreeStepstogetRotationSettingsFromTransformationIn90DegreeStepsto reflect that it now returns both rotation degree and mirroring information.
85-85: Updated FormData type to use new DatasetRotationSettings.The FormData type has been updated to use the renamed and restructured
DatasetRotationSettingstype.
216-229: Updated to use new rotation settings structure.The code now correctly initializes rotation settings for each axis using the new
getRotationSettingsFromTransformationIn90DegreeStepsfunction, which returns both rotation degree and mirroring information.frontend/javascripts/oxalis/model/accessors/dataset_layer_transformation_accessor.ts (4)
74-74: Added helper constant for axis indexing.This new constant maps axis names to their corresponding positions in the transformation matrix, making the code more readable and maintainable.
76-79: New type to support mirroring functionality.The new
RotationSettingtype nicely encapsulates both the rotation angle and mirroring state, providing a clean way to handle these related properties together.
81-105: Updated rotation extraction function to include mirroring detection.The function now detects both rotation angle and whether mirroring is applied, returning this information as a
RotationSettingobject. The implementation correctly identifies mirroring by checking the sign of the diagonal matrix element corresponding to the axis.
123-144: Added mirroring support to rotation matrix generation.The function now handles mirroring by conditionally applying a scale transformation that flips the axis. The implementation correctly combines rotation and mirroring transformations.
frontend/javascripts/oxalis/model/accessors/dataset_layer_transformation_accessor.ts
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx (1)
4-4: Consider unifying your imports from Ant Design.Importing directly from "antd" rather than "antd/lib/checkbox/Checkbox" can help maintain consistency across your codebase:
- import Checkbox, { type CheckboxChangeEvent } from "antd/lib/checkbox/Checkbox"; + import { Checkbox, type CheckboxChangeEvent } from "antd";
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx(8 hunks)frontend/javascripts/oxalis/model/accessors/dataset_layer_transformation_accessor.ts(6 hunks)
🧰 Additional context used
🧬 Code Definitions (2)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx (1)
frontend/javascripts/oxalis/model/accessors/dataset_layer_transformation_accessor.ts (3)
RotationSetting(76-79)getRotationMatrixAroundAxis(123-144)transformationEqualsAffineIdentityTransform(463-483)
frontend/javascripts/oxalis/model/accessors/dataset_layer_transformation_accessor.ts (3)
frontend/javascripts/types/api_flow_types.ts (2)
CoordinateTransformation(74-74)AffineTransformation(64-67)frontend/javascripts/oxalis/model/helpers/transformation_helpers.ts (4)
nestedToFlatMatrix(7-9)chainTransforms(89-163)createAffineTransformFromMatrix(29-32)Transform(11-27)frontend/javascripts/oxalis/constants.ts (1)
IdentityTransform(385-389)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: circleci_build
🔇 Additional comments (18)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx (11)
9-9: The added import forRotationSettinglooks good.
14-14: ImportingtransformationEqualsAffineIdentityTransformis appropriate for pruning identity transformations.
59-63: Defining a structuredrotationValuesobject enhances clarity.
80-81: AllowingisMirroredas an optional parameter is a solid extension of the API.
110-116: Setting transformations tonullwhen they are effectively identity is a good space-saver.
125-125: Adjusting theCollayout span to 8 is a fine layout change.
127-127: Using["datasetRotation", axis, "rotationInDegrees"]aligns with your new rotation model.
137-137: Keeping the field name consistent for the InputNumber is correct.
153-153: Changing the layout span for the next column to 4 is consistent with the UI adjustments.
154-166: Adding theisMirroredcheckbox integrates well with the refined rotation logic.Though note that toggling from checked to unchecked depends on the fix suggested in lines 90-96 for properly clearing the flag.
175-178: Renaming and exportingDatasetRotationSettingsimproves type clarity for all axes.frontend/javascripts/oxalis/model/accessors/dataset_layer_transformation_accessor.ts (7)
74-74: IntroducingaxisPositionInMatrixclarifies index lookups for different axes.
76-79: DefiningRotationSettingas a distinct type is a clean approach to storing rotation angles and mirroring.
80-105:getRotationSettingsFromTransformationIn90DegreeStepsneatly extracts angle and mirroring details in 90° increments.
125-137:getRotationMatrixAroundAxiscorrectly applies both rotation and mirroring.
384-392: Mirroring check relies on vector length, which can miss negative scales.Use an absolute value approach per axis to accurately detect mirrored transformations:
- return translation.length() === 0 && scale.length() === NON_SCALED_VECTOR.length(); + return translation.length() === 0 && + Math.abs(scale.x) === 1 && Math.abs(scale.y) === 1 && Math.abs(scale.z) === 1;
407-409: These updated comments help clarify that each axis can be mirrored.
463-483:transformationEqualsAffineIdentityTransformis a thorough check for identity transformations.
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx (2)
81-81: Update function signature to handle degrees=0 case.The function signature has been updated to accept an optional
isMirroredboolean, butrotationInDegreesis typed asnumber | undefinedwhich is different from the previous type of justnumber.- (rotationInDegrees: number | undefined, isMirrored?: boolean): void => { + (rotationInDegrees: number | null | undefined, isMirrored?: boolean): void => {This would be more consistent with how you handle the InputNumber in lines 146-149 where
nullis a possible value.
153-166: Consider adding a tooltip to explain the mirror feature.The mirroring checkbox lacks additional explanation that would help users understand what mirroring does. Consider adding a tooltip similar to what you've done for the rotation slider.
<FormItem name={["datasetRotation", axis, "isMirrored"]} colon={false} valuePropName="checked" - label={`Mirror ${axis.toUpperCase()} Axis`} /* Whitespace label is needed for correct formatting*/ + label={`Mirror ${axis.toUpperCase()} Axis`} > <Checkbox onChange={(evt: CheckboxChangeEvent) => setMatrixRotationsForAllLayer(undefined, evt.target.checked) } + title={`Flip the dataset along the ${axis}-axis.`} /> </FormItem>Or, for consistency with the rotation controls, use the
FormItemWithInfocomponent:- <FormItem + <FormItemWithInfo name={["datasetRotation", axis, "isMirrored"]} colon={false} valuePropName="checked" label={`Mirror ${axis.toUpperCase()} Axis`} + info={`Flip the dataset along the ${axis}-axis.`} >
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
CHANGELOG.unreleased.md(1 hunks)frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx(8 hunks)
🧰 Additional context used
🧬 Code Definitions (1)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx (1)
frontend/javascripts/oxalis/model/accessors/dataset_layer_transformation_accessor.ts (3)
RotationSetting(76-79)getRotationMatrixAroundAxis(123-144)transformationEqualsAffineIdentityTransform(463-483)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: circleci_build
🔇 Additional comments (4)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx (3)
94-96: The isMirrored toggle issue has been properly fixed.The code now correctly handles toggling off the
isMirroredflag by checking if it's explicitly defined rather than truthy.
110-113: Good optimization for identity transforms.Setting transformations to
nullwhen they equal the identity transform is a smart optimization that avoids storing unnecessary data.
175-179: Good type renaming for clarity.Renaming
DatasetRotationtoDatasetRotationSettingsbetter reflects the purpose of this type, especially now that it encapsulates both rotation degrees and mirroring flags.CHANGELOG.unreleased.md (1)
16-16: LGTM! Clear and concise changelog entry.The changelog entry correctly documents the new mirroring feature and includes the PR reference.
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx (1)
146-149: Consider handling undefined values in the InputNumber onChange handler.While the handler correctly checks for null values, it might be worth explicitly handling undefined values as well for completeness.
- onChange={(value: number | null) => - // InputNumber might be called with null, so we need to check for that. - value != null && setMatrixRotationsForAllLayer(value) + onChange={(value: number | null) => + // InputNumber might be called with null or undefined, so we need to check for that. + value != null && setMatrixRotationsForAllLayer(value)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx(8 hunks)
🧰 Additional context used
🧬 Code Definitions (1)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx (1)
frontend/javascripts/oxalis/model/accessors/dataset_layer_transformation_accessor.ts (3)
RotationSetting(76-79)getRotationMatrixAroundAxis(123-144)transformationEqualsAffineIdentityTransform(463-483)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: circleci_build
🔇 Additional comments (7)
frontend/javascripts/dashboard/dataset/dataset_rotation_form_item.tsx (7)
4-4: Good addition of required imports for the new mirroring functionality.The necessary imports for Checkbox component, RotationSetting type, and the transformationEqualsAffineIdentityTransform function have been correctly added.
Also applies to: 9-9, 14-14
59-63: Well-structured implementation of the RotationSetting type.The rotation values structure has been properly updated to use the RotationSetting type for each axis, which supports the new mirroring functionality.
80-81: Good function signature update for mirroring support.The setMatrixRotationsForAllLayer function signature has been appropriately updated to support setting rotation degrees and mirroring independently.
90-97: Robust implementation for handling rotation and mirroring settings.The implementation correctly handles both rotation degrees and mirroring flags, with proper undefined checks to ensure values are only updated when explicitly set. This properly addresses the previous issues with toggling off mirroring and setting rotation to 0 degrees.
110-113: Excellent optimization for identity transformations.Setting coordinateTransformations to null when they equal the identity transform is a good optimization that prevents storing unnecessary identity transformations.
125-166: Well-designed UI layout for the mirroring functionality.The layout has been effectively reorganized to accommodate the new mirroring checkbox, with appropriate column spans and form item configurations. The connection between the UI and the underlying data model is well implemented.
175-179: Good type renaming for clarity.Renaming DatasetRotation to DatasetRotationSettings and updating its structure to use RotationSetting for each axis improves code clarity and better reflects the expanded functionality.
This is a follow up for #8159. The rotation feature now allows to mirror datasets along axes as well.
Moreover, the rotation settings no longer save a transformation in case it is "nulled" for every setting resulting in an identity transform.
URL of deployed dev instance (used for testing):
Steps to test:
Issues:
(Please delete unneeded items, merge only when none are left open)