tests/testthat/test_searchlight.R

In bbuchsbaum/neurosurf: Data structures and visualization for surface-based neuroimaging data

library(testthat)
library(neurosurf)

test_that("SurfaceSearchlight iterator works correctly", {
  # Load test surface
  surf_file <- system.file("extdata", "std.8_lh.inflated.asc", package="neurosurf")
  surf <- read_surf(surf_file)
  
  # Create iterator
  sl <- SurfaceSearchlight(surf, radius=12)
  
  # Test basic properties
  expect_true(inherits(sl, "Searchlight"))
  expect_true(inherits(sl, "iter"))
  
  # Get first region
  nodes <- sl$nextElem()

  # Test returned nodes
  expect_true(is.numeric(nodes))
  expect_true(length(nodes) > 1)
  expect_false(is.null(attr(nodes, "center")))
  expect_false(is.null(attr(nodes, "length")))

  # Progress should reflect number of centers visited
  num_nodes <- length(nodes(surf))
  expect_equal(sl$progress(), 1 / num_nodes)
})

test_that("SurfaceSearchlight deflist works correctly", {
  # Load test surface
  surf_file <- system.file("extdata", "std.8_lh.inflated.asc", package="neurosurf")
  surf <- read_surf(surf_file)
  
  # Create deflist
  sl <- SurfaceSearchlight(surf, radius=12, as_deflist=TRUE)
  
  # Test basic properties
  expect_true(inherits(sl, "deflist"))
  
  # Get first region
  nodes <- sl[[1]]
  
  # Test returned nodes
  expect_true(is.numeric(nodes))
  expect_true(length(nodes) > 1)
  expect_false(is.null(attr(nodes, "center")))
  expect_false(is.null(attr(nodes, "length")))
})

test_that("RandomSurfaceSearchlight iterator works correctly", {
  # Load test surface
  surf_file <- system.file("extdata", "std.8_lh.inflated.asc", package="neurosurf")
  surf <- read_surf(surf_file)
  
  # Create iterator
  sl <- RandomSurfaceSearchlight(surf, radius=12)
  
  # Test basic properties
  expect_true(inherits(sl, "RandomSurfaceSearchlight"))
  expect_true(inherits(sl, "iter"))
  
  # Get first region
  nodes <- sl$nextElem()

  # Test returned nodes
  expect_true(is.numeric(nodes))
  expect_true(length(nodes) > 1)
  expect_false(is.null(attr(nodes, "center")))
  expect_false(is.null(attr(nodes, "length")))

  # Progress should reflect proportion of nodes covered
  num_nodes <- length(nodes(surf))
  expect_equal(sl$progress(), attr(nodes, "length") / num_nodes)
})

test_that("RandomSurfaceSearchlight deflist works correctly", {
  # Load test surface
  surf_file <- system.file("extdata", "std.8_lh.inflated.asc", package="neurosurf")
  surf <- read_surf(surf_file)
  
  # Create deflist
  sl <- RandomSurfaceSearchlight(surf, radius=12, as_deflist=TRUE)
  
  # Test basic properties
  expect_true(inherits(sl, "deflist"))
  
  # Get first region
  nodes <- sl[[1]]
  
  # Test returned nodes
  expect_true(is.numeric(nodes))
  expect_true(length(nodes) > 1)
  expect_false(is.null(attr(nodes, "center")))
  expect_false(is.null(attr(nodes, "length")))
})


test_that("RandomSurfaceSearchlight deflist order changes with seed", {
  surf_file <- system.file("extdata", "std.8_lh.inflated.asc", package="neurosurf")
  surf <- read_surf(surf_file)

  set.seed(123)
  sl1 <- RandomSurfaceSearchlight(surf, radius=12, as_deflist=TRUE)
  centers1 <- vapply(seq_len(length(sl1)), function(i) attr(sl1[[i]], "center.index"), numeric(1))

  set.seed(124)
  sl2 <- RandomSurfaceSearchlight(surf, radius=12, as_deflist=TRUE)
  centers2 <- vapply(seq_len(length(sl2)), function(i) attr(sl2[[i]], "center.index"), numeric(1))

  expect_false(identical(centers1, centers2))
})

test_that("SurfaceSearchlight deflist rejects invalid indices", {
  surf_file <- system.file("extdata", "std.8_lh.inflated.asc", package="neurosurf")
  surf <- read_surf(surf_file)
  sl <- SurfaceSearchlight(surf, radius=12, as_deflist=TRUE)
  expect_error(sl[[0]])
  expect_error(sl[[-1]])
})

test_that("RandomSurfaceSearchlight deflist rejects invalid indices", {
  surf_file <- system.file("extdata", "std.8_lh.inflated.asc", package="neurosurf")
  surf <- read_surf(surf_file)
  sl <- RandomSurfaceSearchlight(surf, radius=12, as_deflist=TRUE)
  expect_error(sl[[0]])
  expect_error(sl[[-1]])
})

test_that("RandomSurfaceSearchlight validates inputs", {
  surf_file <- system.file("extdata", "std.8_lh.inflated.asc", package="neurosurf")
  surf <- read_surf(surf_file)

  expect_error(RandomSurfaceSearchlight(surf, radius=c(1,2)))
  expect_error(RandomSurfaceSearchlight(surf, radius=-1))
  expect_error(RandomSurfaceSearchlight(surf, radius=8, nodeset=integer()))
})

test_that("RandomSurfaceSearchlight deflist uses random ordering", {
  surf_file <- system.file("extdata", "std.8_lh.inflated.asc", package="neurosurf")
  surf <- read_surf(surf_file)

  set.seed(1)
  sl1 <- RandomSurfaceSearchlight(surf, radius=12, as_deflist=TRUE)
  first1 <- attr(sl1[[1]], "center")

  set.seed(2)
  sl2 <- RandomSurfaceSearchlight(surf, radius=12, as_deflist=TRUE)
  first2 <- attr(sl2[[1]], "center")

  expect_false(identical(first1, first2))

})