Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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.

Sign up for GitHub

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

Jump to bottom

Improvement: Proposed name change of FTF -> GBTS seeding #2831

Closed
Rosie-Hasan opened this issue Dec 14, 2023 · 3 comments
Closed

Improvement: Proposed name change of FTF -> GBTS seeding #2831

Rosie-Hasan opened this issue Dec 14, 2023 · 3 comments

Comments

@Rosie-Hasan
Copy link
Contributor

Rosie-Hasan commented Dec 14, 2023 •
edited
Loading

Change naming of new seeding algorithm from FTF (FastTrackFinder) to GBTS (Graph Based Track Seeding) as this is a clearer desription of the algorithm.
Code implemented in PRs #2227 #2726 and more details given presented at ACTS-ITK presention .

The proposed name changes for file names and classes are listed below. I would apprecaite any opinions or feedback on these before the 20th of December, when I will submit a PR of these changes.

  • SeedFinderFTF -> GBTSSeedFinder (or SeedFinderGBTS?)
  • GNN_DataStorage -> GBTSDataStorage
  • GNN_Geometry -> GBTSGeometry
  • SeedingFTFAlgorithm -> GBTSSeedingAlgorithm (or SeedingGBTSAlgorithm?)
  • FasTrackConnector-> GBTSConnector
  • TrigBase -> GBTSBase
  • full_chain_itk_FTF.py -> full_chain_itk_GBTS.py
@Rosie-Hasan Rosie-Hasan changed the title Improvement: Proposed name change of FTF seeding -> GBTS Improvement: Proposed name change of FTF -> GBTS seeding Dec 14, 2023
@paulgessinger
Copy link
Member

paulgessinger commented Dec 19, 2023 •
edited
Loading

My only request is to write Gbts instead of GBTS in class names, i.e. GbtsConnector.

@CarloVarni
Copy link
Collaborator

Comments from my side:

  • I Agree with @paulgessinger GBTS -> Gbts
  • I'd follow the pattern (for this and any seeding algorithm) for the seeding alg name: <TYPE>SeedingAlgorithm. So I have a preference indeed for GbtsSeedingAlgorithm
  • For the seed finder I see other implementations adopt the convention (opposite to the algorithm convention ... maybe in the future we may impose a common pattern for all the Acts Code but not immediately): SeedFinder<TYPE>
  • Avoid _ in classes names

@Rosie-Hasan
Copy link
Contributor Author

Thank you both, I have made the name changes based on these suggestions and will submit a PR soon

@Rosie-Hasan Rosie-Hasan mentioned this issue Dec 21, 2023
Merged
kodiakhq bot pushed a commit that referenced this issue Jan 9, 2024
@Rosie-Hasan
refactor: name change of FTF -> GBTS seeding (#2853)
53bcd74 
Change naming of new seeding algorithm from FTF (FastTrackFinder) to GBTS (Graph Based Track Seeding) as this is a clearer desription of the algorithm. Name changes disccuessed in issue #2831 .  
Code implemented in PRs #2227  #2726  and more details given presented at [ACTS-ITK presention ](https://indico.cern.ch/event/1321208/#20-update-on-ftf-implementatio).

**Name changes**: 
SeedFinderFTF -> SeedFinderGBTS
GNN_DataStorage -> GBTSDataStorage
GNN_Geometry -> GBTSGeometry
SeedingFTFAlgorithm -> GBTSSeedingAlgorithm 
FasTrackConnector-> GBTSConnector
TrigBase -> GBTSBase
full_chain_itk_FTF.py -> full_chain_itk_GBTS.py
LaraCalic pushed a commit to LaraCalic/acts that referenced this issue Feb 10, 2024
@Rosie-Hasan @LaraCalic
refactor: name change of FTF -> GBTS seeding (acts-project#2853)
c360a47 
Change naming of new seeding algorithm from FTF (FastTrackFinder) to GBTS (Graph Based Track Seeding) as this is a clearer desription of the algorithm. Name changes disccuessed in issue acts-project#2831 .  
Code implemented in PRs acts-project#2227  acts-project#2726  and more details given presented at [ACTS-ITK presention ](https://indico.cern.ch/event/1321208/#20-update-on-ftf-implementatio).

**Name changes**: 
SeedFinderFTF -> SeedFinderGBTS
GNN_DataStorage -> GBTSDataStorage
GNN_Geometry -> GBTSGeometry
SeedingFTFAlgorithm -> GBTSSeedingAlgorithm 
FasTrackConnector-> GBTSConnector
TrigBase -> GBTSBase
full_chain_itk_FTF.py -> full_chain_itk_GBTS.py
@acts-project acts-project locked and limited conversation to collaborators Feb 13, 2024
@AJPfleger AJPfleger converted this issue into discussion #2943 Feb 13, 2024

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@paulgessinger @CarloVarni @Rosie-Hasan