Skip to content

Commit

Permalink
docs: update citation information
Browse files Browse the repository at this point in the history
Update the citation information in the README.md and CITATION.cff file.
  • Loading branch information
tunakasif committed Mar 13, 2024
1 parent de90e6e commit 5e52b1e
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 9 deletions.
39 changes: 31 additions & 8 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,10 +1,33 @@
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Alikaşifoğlu"
given-names: "Tuna"
orcid: "https://orcid.org/0000-0001-8030-8088"
title: "PyTorch Differentiable Fractional Fourier Transform"
version: 0.6.1
date-released: 2023-08-08
url: "https://github.com/tunakasif/torch-frft"
preferred-citation:
authors:
- family-names: Koç
given-names: Emirhan
- family-names: Alikaşifoğlu
given-names: Tuna
orcid: "https://orcid.org/0000-0001-8030-8088"
- family-names: Aras
given-names: Arda Can
- family-names: Koç
given-names: Aykut
doi: 10.1109/lsp.2024.3372779
identifiers:
- type: doi
value: 10.1109/lsp.2024.3372779
- type: url
value: http://dx.doi.org/10.1109/LSP.2024.3372779
- type: other
value: urn:issn:1070-9908
title: Trainable Fractional Fourier Transform
url: http://dx.doi.org/10.1109/LSP.2024.3372779
database: Crossref
date-published: 2024-03-04
year: 2024
issn: 1070-9908
journal: IEEE Signal Processing Letters
publisher:
name: Institute of Electrical and Electronics Engineers (IEEE)
start: '1'
end: '5'
type: article
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,22 @@ This package implements these approaches in PyTorch with specific optimizations

We provide primer layers that extend `torch.nn.Module` for continuous and discrete transforms, an example of the custom layer implementation, is also provided in the `README.md` file.

We developed this project for the [_Trainable Fractional Fourier Transform_](https://ieeexplore.ieee.org/document/10458263) paper, published in _IEEE Signal Processing Letters_. You can also access the [paper's GitHub page](https://github.com/koc-lab/TrainableFrFT) for experiments and example usage. If you find this package useful, please consider citing as follows:

```bibtex
@article{trainable-frft-2024,
author = {Koc, Emirhan and Alikasifoglu, Tuna and Aras, Arda Can and Koc, Aykut},
journal = {IEEE Signal Processing Letters},
title = {Trainable Fractional Fourier Transform},
year = {2024},
volume = {},
number = {},
pages = {1-5},
keywords = {Vectors;Convolution;Training;Task analysis;Computational modeling;Time series analysis;Feature extraction;Machine learning;neural networks;FT;fractional FT;deep learning},
doi = {10.1109/LSP.2024.3372779}
}
```

## Table of Contents

- [Trainable Fractional Fourier Transform](#trainable-fractional-fourier-transform)
Expand Down Expand Up @@ -70,7 +86,8 @@ pip install -r requirements.txt

### Transforms

:warning: Transforms applied in the same device as the input tensor. If the input tensor is on GPU, the transform will also be applied on GPU.
> [!WARNING]
> Transforms applied in the same device as the input tensor. If the input tensor is on GPU, the transform will also be applied on GPU.
The package provides transform functions that operate on the $n^{th}$ dimension of an input tensor, `frft()` and `dfrft()`, which correspond to the fast computation of continuous fractional Fourier transform (FRFT) and discrete fractional Fourier transform (DFRFT), respectively. It also provides a function `dfrftmtx()`, which computes the DFRFT matrix for a given length and order, similar to MATLAB's `dftmtx()` function for the ordinary DFT matrix. Note that the `frft()` only operates on even-sized lengths as in the original MATLAB implementation [fracF.m](http://www.ee.bilkent.edu.tr/~haldun/fracF.m).

Expand Down

0 comments on commit 5e52b1e

Please sign in to comment.