Skip to content

Conversation

@atsuch
Copy link

@atsuch atsuch commented Feb 27, 2025

Type of improvement

If submitting a new module or fixing a bug, please use the appropriate template.

  • Documentation
  • Development tools (e.g. linter, formatter, etc.)
  • Development container
  • Global update (please specify)
  • Other (please specify)

Describe your improvement

Add a module to create tensor ratio map for DTI-ALPS computation.

Describe how to test your improvement

to be tested with a tensor image (DTI or FW-DTI) as the input

Checklist before requesting a review

  • Ensure the syntax is correct (EditorConfig and Prettier must pass)
  • Run the test suites if your changes affect any module
  • Regenerate the Poetry lock file if you have updated the dependencies
  • Ensure the documentation is up-to-date

Copy link
Contributor

@AlexVCaron AlexVCaron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A great start for your first module, some minor things to adjust and it'll be perfect !

---
# yaml-language-server: $schema=https://raw.githubusercontent.com/nf-core/modules/master/modules/meta-schema.json
name: "tensor_ratio"
description: Split the tensor image and compute the ratio of Dxx to Dyy and Dxx to Dzz for ALPS.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Specify to which convention the tensor image must abide to (I assume it's FSL). Something like :

The tensor elements must be ordered following convention, that is : Dxx, Dxy, Dxz, Dyy, Dyz, Dzz.

Comment on lines +13 to +14
tuple val(meta), path("*_Dxx_to_Dyy.nii.gz") , emit: tensor_x_to_y
tuple val(meta), path("*_Dxx_to_Dzz.nii.gz") , emit: tensor_x_to_z
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel the names ratio_x_on_y or eval_x_on_y (same for x on z) would convey a better meaning. If you agree, please adjust, here and in the meta.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This snapshot will have to be updated

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the TODO comments in this file.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think the ratio of y on z could be interesting for someone ? If so, please add it to the module.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants