-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Add Fréchet Radiomics Distance (FRD) to MONAI metrics (#8643) #8769
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
AymanL
wants to merge
5
commits into
Project-MONAI:dev
Choose a base branch
from
AymanL:implement_frd_metric
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+152
−0
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
584cc87
feat(metrics): add Fréchet Radiomics Distance (FRD) (#8643)
AymanL 699c949
a new commit
AymanL 345ad07
DCO Remediation Commit for AymanL <40838419+AymanL@users.noreply.gith…
AymanL 20ab2bd
fix(frd): stricter input validation and clarified docstrings per review
ayman-lamdasni-shift 96c5fd0
DCO Remediation Commit for AymanL <40838419+AymanL@users.noreply.gith…
ayman-lamdasni-shift File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| # Copyright (c) MONAI Consortium | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import torch | ||
|
|
||
| from monai.metrics.fid import get_fid_score | ||
| from monai.metrics.metric import Metric | ||
|
|
||
| __all__ = ["FrechetRadiomicsDistance", "get_frd_score"] | ||
|
|
||
|
|
||
| class FrechetRadiomicsDistance(Metric): | ||
| """ | ||
| Fréchet Radiomics Distance (FRD). Computes the Fréchet distance between two | ||
| distributions of radiomic feature vectors, in the same way as the Fréchet | ||
| Inception Distance (FID) but applied to radiomics-based features instead of | ||
| deep-network embeddings. | ||
|
|
||
| Unlike FID, FRD uses interpretable, clinically relevant radiomic features | ||
| (e.g. extracted via PyRadiomics), which makes it directly applicable to both | ||
| 2D and 3D images and allows optional conditioning by anatomical masks — | ||
| all handled during upstream feature extraction, not by this class. See | ||
| Konz et al. "Fréchet Radiomic Distance (FRD): A Versatile Metric for | ||
| Comparing Medical Imaging Datasets." https://arxiv.org/abs/2412.01496 | ||
|
|
||
| This class accepts pre-extracted radiomic feature tensors of shape (N, F) | ||
| and applies the same Fréchet distance formula as FID to the empirical means | ||
| and covariances of those features. | ||
| """ | ||
|
|
||
| def __call__(self, y_pred: torch.Tensor, y: torch.Tensor) -> torch.Tensor: | ||
| """Compute FRD between two sets of pre-extracted radiomic feature vectors. | ||
|
|
||
| Args: | ||
| y_pred: Radiomic feature vectors for the first distribution (e.g. from | ||
| generated or reconstructed images), shape (N, F) with N >= 2. | ||
| y: Radiomic feature vectors for the second distribution (e.g. from real | ||
| images), shape (N, F) with N >= 2. | ||
|
|
||
| Returns: | ||
| Scalar tensor containing the FRD value. | ||
|
|
||
| Raises: | ||
| ValueError: When either tensor is not exactly 2-dimensional or has | ||
| fewer than 2 samples. | ||
| """ | ||
| return get_frd_score(y_pred, y) | ||
|
|
||
|
|
||
| def get_frd_score(y_pred: torch.Tensor, y: torch.Tensor) -> torch.Tensor: | ||
| """Computes the FRD score from two batches of radiomic feature vectors. | ||
|
|
||
| The implementation reuses the same Fréchet distance as FID; only the | ||
| semantics (radiomic features vs. deep network features) differ. | ||
|
|
||
| Args: | ||
| y_pred: Feature vectors for the first distribution, shape (N, F) with N >= 2. | ||
| y: Feature vectors for the second distribution, shape (N, F) with N >= 2. | ||
|
|
||
| Returns: | ||
| Scalar tensor containing the Fréchet Radiomics Distance. | ||
|
|
||
| Raises: | ||
| ValueError: When either tensor is not exactly 2-dimensional (i.e. not | ||
| shape (N, F)), or when either tensor has fewer than 2 samples | ||
| (required for covariance estimation). | ||
| """ | ||
| for name, t in (("y_pred", y_pred), ("y", y)): | ||
| if t.ndimension() != 2: | ||
| raise ValueError( | ||
| f"{name} must be a 2-D tensor of shape (N, F) — got shape {tuple(t.shape)}. " | ||
| "Pass pre-extracted radiomic feature vectors, not raw images." | ||
| ) | ||
| if t.size(0) < 2: | ||
| raise ValueError( | ||
| f"{name} must contain at least 2 samples for covariance estimation — got {t.size(0)}." | ||
| ) | ||
| return get_fid_score(y_pred, y) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # Copyright (c) MONAI Consortium | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import unittest | ||
|
|
||
| import numpy as np | ||
| import torch | ||
|
|
||
| from monai.metrics import FIDMetric, FrechetRadiomicsDistance | ||
| from monai.utils import optional_import | ||
|
|
||
| _, has_scipy = optional_import("scipy") | ||
|
|
||
|
|
||
| @unittest.skipUnless(has_scipy, "Requires scipy") | ||
| class TestFrechetRadiomicsDistance(unittest.TestCase): | ||
| def test_results(self): | ||
| x = torch.Tensor([[1, 2], [1, 2], [1, 2]]) | ||
| y = torch.Tensor([[2, 2], [1, 2], [1, 2]]) | ||
| results = FrechetRadiomicsDistance()(x, y) | ||
| np.testing.assert_allclose(results.cpu().numpy(), 0.4444, atol=1e-4) | ||
|
|
||
| def test_frd_matches_fid_for_same_features(self): | ||
| """FRD uses the same Fréchet formula as FID; same inputs give same value.""" | ||
| y_pred = torch.Tensor([[1.0, 2.0], [1.0, 2.0], [1.0, 2.0]]) | ||
| y = torch.Tensor([[2.0, 2.0], [1.0, 2.0], [1.0, 2.0]]) | ||
| frd_score = FrechetRadiomicsDistance()(y_pred, y) | ||
| fid_score = FIDMetric()(y_pred, y) | ||
| np.testing.assert_allclose(frd_score.cpu().numpy(), fid_score.cpu().numpy(), atol=1e-6) | ||
|
|
||
| def test_rejects_high_dimensional_input(self): | ||
| """Raises ValueError when inputs have more than 2 dimensions. """ | ||
| high_dim = torch.ones([3, 3, 144, 144]) | ||
| with self.assertRaises(ValueError): | ||
| FrechetRadiomicsDistance()(high_dim, high_dim) | ||
|
|
||
| def test_rejects_1d_input(self): | ||
| """Raises ValueError when inputs are 1-D (single feature vector, not a batch).""" | ||
| with self.assertRaises(ValueError): | ||
| FrechetRadiomicsDistance()(torch.ones([10]), torch.ones([10])) | ||
|
|
||
| def test_rejects_too_few_samples(self): | ||
| """Raises ValueError when either input has fewer than 2 samples.""" | ||
| valid = torch.Tensor([[1.0, 2.0], [3.0, 4.0]]) | ||
| single = torch.Tensor([[1.0, 2.0]]) | ||
| with self.assertRaises(ValueError): | ||
| FrechetRadiomicsDistance()(single, valid) | ||
| with self.assertRaises(ValueError): | ||
| FrechetRadiomicsDistance()(valid, single) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| unittest.main() |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.