-
Notifications
You must be signed in to change notification settings - Fork 178
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add support for Timed Clusterization (#3654)
This add possibility of doing clusterization using as well time information
1 parent
74244eb
commit 6cea6b2
Showing
6 changed files
with
401 additions
and
84 deletions.
There are no files selected for viewing
This file contains 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 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 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,38 @@ | ||
// This file is part of the ACTS project. | ||
// | ||
// Copyright (C) 2016 CERN for the benefit of the ACTS project | ||
// | ||
// This Source Code Form is subject to the terms of the Mozilla Public | ||
// License, v. 2.0. If a copy of the MPL was not distributed with this | ||
// file, You can obtain one at https://mozilla.org/MPL/2.0/. | ||
|
||
#pragma once | ||
|
||
#include "Acts/Clusterization/Clusterization.hpp" | ||
#include "Acts/Definitions/Algebra.hpp" | ||
|
||
#include <limits> | ||
|
||
namespace Acts::Ccl { | ||
|
||
template <typename Cell> | ||
concept HasRetrievableTimeInfo = requires(Cell cell) { | ||
{ getCellTime(cell) } -> std::same_as<Acts::ActsScalar>; | ||
}; | ||
|
||
template <Acts::Ccl::HasRetrievableTimeInfo Cell, std::size_t N> | ||
struct TimedConnect : public Acts::Ccl::DefaultConnect<Cell, N> { | ||
Acts::ActsScalar timeTolerance{std::numeric_limits<Acts::ActsScalar>::max()}; | ||
|
||
TimedConnect() = default; | ||
TimedConnect(Acts::ActsScalar time); | ||
TimedConnect(Acts::ActsScalar time, bool commonCorner) | ||
requires(N == 2); | ||
~TimedConnect() override = default; | ||
|
||
ConnectResult operator()(const Cell& ref, const Cell& iter) const override; | ||
}; | ||
|
||
} // namespace Acts::Ccl | ||
|
||
#include "Acts/Clusterization/TimedClusterization.ipp" |
This file contains 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,36 @@ | ||
// This file is part of the ACTS project. | ||
// | ||
// Copyright (C) 2016 CERN for the benefit of the ACTS project | ||
// | ||
// This Source Code Form is subject to the terms of the Mozilla Public | ||
// License, v. 2.0. If a copy of the MPL was not distributed with this | ||
// file, You can obtain one at https://mozilla.org/MPL/2.0/. | ||
|
||
namespace Acts::Ccl { | ||
|
||
template <Acts::Ccl::HasRetrievableTimeInfo Cell, std::size_t N> | ||
TimedConnect<Cell, N>::TimedConnect(Acts::ActsScalar time) | ||
: timeTolerance(time) {} | ||
|
||
template <Acts::Ccl::HasRetrievableTimeInfo Cell, std::size_t N> | ||
TimedConnect<Cell, N>::TimedConnect(Acts::ActsScalar time, bool commonCorner) | ||
requires(N == 2) | ||
: Acts::Ccl::DefaultConnect<Cell, N>(commonCorner), timeTolerance(time) {} | ||
|
||
template <Acts::Ccl::HasRetrievableTimeInfo Cell, std::size_t N> | ||
Acts::Ccl::ConnectResult TimedConnect<Cell, N>::operator()( | ||
const Cell& ref, const Cell& iter) const { | ||
Acts::Ccl::ConnectResult spaceCompatibility = | ||
Acts::Ccl::DefaultConnect<Cell, N>::operator()(ref, iter); | ||
if (spaceCompatibility != Acts::Ccl::ConnectResult::eConn) { | ||
return spaceCompatibility; | ||
} | ||
|
||
if (std::abs(getCellTime(ref) - getCellTime(iter)) < timeTolerance) { | ||
return Acts::Ccl::ConnectResult::eConn; | ||
} | ||
|
||
return Acts::Ccl::ConnectResult::eNoConn; | ||
} | ||
|
||
} // namespace Acts::Ccl |
This file contains 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 |
---|---|---|
@@ -1,2 +1,3 @@ | ||
add_unittest(Clusterization1D ClusterizationTests1D.cpp) | ||
add_unittest(Clusterization2D ClusterizationTests2D.cpp) | ||
add_unittest(TimedClusterization TimedClusterizationTests.cpp) |
260 changes: 260 additions & 0 deletions
260
Tests/UnitTests/Core/Clusterization/TimedClusterizationTests.cpp
This file contains 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,260 @@ | ||
// This file is part of the ACTS project. | ||
// | ||
// Copyright (C) 2016 CERN for the benefit of the ACTS project | ||
// | ||
// This Source Code Form is subject to the terms of the Mozilla Public | ||
// License, v. 2.0. If a copy of the MPL was not distributed with this | ||
// file, You can obtain one at https://mozilla.org/MPL/2.0/. | ||
|
||
#include <boost/test/unit_test.hpp> | ||
|
||
#include "Acts/Clusterization/TimedClusterization.hpp" | ||
|
||
namespace Acts::Test { | ||
|
||
// Define objects | ||
using Identifier = std::size_t; | ||
struct Cell { | ||
Cell(Identifier identifier, int c, int r, double t) | ||
: id(identifier), column(c), row(r), time(t) {} | ||
|
||
Identifier id{}; | ||
int column{0}; | ||
int row{0}; | ||
int label{-1}; | ||
double time{0.}; | ||
}; | ||
|
||
struct Cluster { | ||
std::vector<Identifier> ids{}; | ||
}; | ||
|
||
using CellCollection = std::vector<Acts::Test::Cell>; | ||
using ClusterCollection = std::vector<Acts::Test::Cluster>; | ||
|
||
// Define functions | ||
static inline int getCellRow(const Cell& cell) { | ||
return cell.row; | ||
} | ||
|
||
static inline int getCellColumn(const Cell& cell) { | ||
return cell.column; | ||
} | ||
|
||
static inline int& getCellLabel(Cell& cell) { | ||
return cell.label; | ||
} | ||
|
||
static inline double getCellTime(const Cell& cell) { | ||
return cell.time; | ||
} | ||
|
||
static void clusterAddCell(Cluster& cl, const Cell& cell) { | ||
cl.ids.push_back(cell.id); | ||
} | ||
|
||
BOOST_AUTO_TEST_CASE(TimedGrid_1D_withtime) { | ||
// 1x10 matrix | ||
/* | ||
X X X Y O X Y Y X X | ||
*/ | ||
// 6 + 3 cells -> 3 + 2 clusters in total | ||
|
||
std::vector<Cell> cells; | ||
// X | ||
cells.emplace_back(0ul, 0, -1, 0); | ||
cells.emplace_back(1ul, 1, -1, 0); | ||
cells.emplace_back(2ul, 2, -1, 0); | ||
cells.emplace_back(3ul, 5, -1, 0); | ||
cells.emplace_back(4ul, 8, -1, 0); | ||
cells.emplace_back(5ul, 9, -1, 0); | ||
// Y | ||
cells.emplace_back(6ul, 3, 0, 1); | ||
cells.emplace_back(7ul, 6, 1, 1); | ||
cells.emplace_back(8ul, 7, 1, 1); | ||
|
||
std::vector<std::vector<Identifier>> expectedResults; | ||
expectedResults.push_back({0ul, 1ul, 2ul}); | ||
expectedResults.push_back({6ul}); | ||
expectedResults.push_back({3ul}); | ||
expectedResults.push_back({7ul, 8ul}); | ||
expectedResults.push_back({4ul, 5ul}); | ||
|
||
ClusterCollection clusters = | ||
Acts::Ccl::createClusters<CellCollection, ClusterCollection, 1>( | ||
cells, Acts::Ccl::TimedConnect<Cell, 1>(0.5)); | ||
|
||
BOOST_CHECK_EQUAL(5ul, clusters.size()); | ||
|
||
for (std::size_t i(0); i < clusters.size(); ++i) { | ||
std::vector<Identifier>& timedIds = clusters[i].ids; | ||
const std::vector<Identifier>& expected = expectedResults[i]; | ||
std::sort(timedIds.begin(), timedIds.end()); | ||
BOOST_CHECK_EQUAL(timedIds.size(), expected.size()); | ||
|
||
for (std::size_t j(0); j < timedIds.size(); ++j) { | ||
BOOST_CHECK_EQUAL(timedIds[j], expected[j]); | ||
} | ||
} | ||
} | ||
|
||
BOOST_AUTO_TEST_CASE(TimedGrid_2D_notime) { | ||
// 4x4 matrix | ||
/* | ||
X O O X | ||
O O O X | ||
X X O O | ||
X O O X | ||
*/ | ||
// 7 cells -> 4 clusters in total | ||
|
||
std::vector<Cell> cells; | ||
cells.emplace_back(0ul, 0, 0, 0); | ||
cells.emplace_back(1ul, 3, 0, 0); | ||
cells.emplace_back(2ul, 3, 1, 0); | ||
cells.emplace_back(3ul, 0, 2, 0); | ||
cells.emplace_back(4ul, 1, 2, 0); | ||
cells.emplace_back(5ul, 0, 3, 0); | ||
cells.emplace_back(6ul, 3, 3, 0); | ||
|
||
std::vector<std::vector<Identifier>> expectedResults; | ||
expectedResults.push_back({0ul}); | ||
expectedResults.push_back({3ul, 4ul, 5ul}); | ||
expectedResults.push_back({1ul, 2ul}); | ||
expectedResults.push_back({6ul}); | ||
|
||
ClusterCollection clusters = | ||
Acts::Ccl::createClusters<CellCollection, ClusterCollection, 2>( | ||
cells, | ||
Acts::Ccl::TimedConnect<Cell, 2>(std::numeric_limits<double>::max())); | ||
|
||
BOOST_CHECK_EQUAL(4ul, clusters.size()); | ||
|
||
// Compare against default connect (only space) | ||
ClusterCollection defaultClusters = | ||
Acts::Ccl::createClusters<CellCollection, ClusterCollection, 2>( | ||
cells, Acts::Ccl::DefaultConnect<Cell, 2>()); | ||
|
||
BOOST_CHECK_EQUAL(4ul, defaultClusters.size()); | ||
BOOST_CHECK_EQUAL(defaultClusters.size(), expectedResults.size()); | ||
|
||
std::vector<std::size_t> sizes{1, 3, 2, 1}; | ||
for (std::size_t i(0); i < clusters.size(); ++i) { | ||
std::vector<Identifier>& timedIds = clusters[i].ids; | ||
std::vector<Identifier>& defaultIds = defaultClusters[i].ids; | ||
const std::vector<Identifier>& expected = expectedResults[i]; | ||
BOOST_CHECK_EQUAL(timedIds.size(), defaultIds.size()); | ||
BOOST_CHECK_EQUAL(timedIds.size(), sizes[i]); | ||
BOOST_CHECK_EQUAL(timedIds.size(), expected.size()); | ||
|
||
std::sort(timedIds.begin(), timedIds.end()); | ||
std::sort(defaultIds.begin(), defaultIds.end()); | ||
for (std::size_t j(0); j < timedIds.size(); ++j) { | ||
BOOST_CHECK_EQUAL(timedIds[j], defaultIds[j]); | ||
BOOST_CHECK_EQUAL(timedIds[j], expected[j]); | ||
} | ||
} | ||
} | ||
|
||
BOOST_AUTO_TEST_CASE(TimedGrid_2D_withtime) { | ||
// 4x4 matrix | ||
/* | ||
X Y O X | ||
O Y Y X | ||
X X Z Z | ||
X O O X | ||
*/ | ||
// 7 + 3 + 2 cells -> 4 + 1 + 1 clusters in total | ||
|
||
std::vector<Cell> cells; | ||
// X | ||
cells.emplace_back(0ul, 0, 0, 0); | ||
cells.emplace_back(1ul, 3, 0, 0); | ||
cells.emplace_back(2ul, 3, 1, 0); | ||
cells.emplace_back(3ul, 0, 2, 0); | ||
cells.emplace_back(4ul, 1, 2, 0); | ||
cells.emplace_back(5ul, 0, 3, 0); | ||
cells.emplace_back(6ul, 3, 3, 0); | ||
// Y | ||
cells.emplace_back(7ul, 1, 0, 1); | ||
cells.emplace_back(8ul, 1, 1, 1); | ||
cells.emplace_back(9ul, 2, 1, 1); | ||
// Z | ||
cells.emplace_back(10ul, 2, 2, 2); | ||
cells.emplace_back(11ul, 3, 2, 2); | ||
|
||
std::vector<std::vector<Identifier>> expectedResults; | ||
expectedResults.push_back({0ul}); | ||
expectedResults.push_back({3ul, 4ul, 5ul}); | ||
expectedResults.push_back({7ul, 8ul, 9ul}); | ||
expectedResults.push_back({10ul, 11ul}); | ||
expectedResults.push_back({1ul, 2ul}); | ||
expectedResults.push_back({6ul}); | ||
|
||
ClusterCollection clusters = | ||
Acts::Ccl::createClusters<CellCollection, ClusterCollection, 2>( | ||
cells, Acts::Ccl::TimedConnect<Cell, 2>(0.5)); | ||
|
||
BOOST_CHECK_EQUAL(6ul, clusters.size()); | ||
|
||
std::vector<std::size_t> sizes{1, 3, 3, 2, 2, 1}; | ||
for (std::size_t i(0); i < clusters.size(); ++i) { | ||
std::vector<Identifier>& timedIds = clusters[i].ids; | ||
BOOST_CHECK_EQUAL(timedIds.size(), sizes[i]); | ||
std::sort(timedIds.begin(), timedIds.end()); | ||
|
||
const std::vector<Identifier>& expected = expectedResults[i]; | ||
BOOST_CHECK_EQUAL(timedIds.size(), expected.size()); | ||
|
||
for (std::size_t j(0); j < timedIds.size(); ++j) { | ||
BOOST_CHECK_EQUAL(timedIds[j], expected[j]); | ||
} | ||
} | ||
} | ||
|
||
BOOST_AUTO_TEST_CASE(TimedGrid_2D_noTollerance) { | ||
// 4x4 matrix | ||
/* | ||
X O O X | ||
O O O X | ||
X X O O | ||
X O O X | ||
*/ | ||
// 7 cells -> 7 clusters in total | ||
// since time requirement will never be satisfied | ||
|
||
std::vector<Cell> cells; | ||
cells.emplace_back(0ul, 0, 0, 0); | ||
cells.emplace_back(1ul, 3, 0, 0); | ||
cells.emplace_back(2ul, 3, 1, 0); | ||
cells.emplace_back(3ul, 0, 2, 0); | ||
cells.emplace_back(4ul, 1, 2, 0); | ||
cells.emplace_back(5ul, 0, 3, 0); | ||
cells.emplace_back(6ul, 3, 3, 0); | ||
|
||
std::vector<std::vector<Identifier>> expectedResults; | ||
expectedResults.push_back({0ul}); | ||
expectedResults.push_back({3ul}); | ||
expectedResults.push_back({5ul}); | ||
expectedResults.push_back({4ul}); | ||
expectedResults.push_back({1ul}); | ||
expectedResults.push_back({2ul}); | ||
expectedResults.push_back({6ul}); | ||
|
||
ClusterCollection clusters = | ||
Acts::Ccl::createClusters<CellCollection, ClusterCollection, 2>( | ||
cells, Acts::Ccl::TimedConnect<Cell, 2>(0.)); | ||
|
||
BOOST_CHECK_EQUAL(7ul, clusters.size()); | ||
|
||
for (std::size_t i(0); i < clusters.size(); ++i) { | ||
std::vector<Identifier>& timedIds = clusters[i].ids; | ||
const std::vector<Identifier>& expected = expectedResults[i]; | ||
|
||
BOOST_CHECK_EQUAL(timedIds.size(), 1); | ||
BOOST_CHECK_EQUAL(timedIds.size(), expected.size()); | ||
BOOST_CHECK_EQUAL(timedIds[0], expected[0]); | ||
} | ||
} | ||
|
||
} // namespace Acts::Test |