-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathtest-write_fs_annot.R
121 lines (82 loc) · 5.11 KB
/
test-write_fs_annot.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
test_that("A colortable from an annotation can be written to a text file in FreeSurfer LUT format.", {
annotfile = system.file("extdata", "lh.aparc.annot.gz", package = "freesurferformats", mustWork = TRUE);
annot = read.fs.annot(annotfile);
output_file = tempfile(fileext = ".txt");
write.fs.colortable(output_file, colortable.from.annot(annot));
written_colortable = read.fs.colortable(output_file);
expect_equal(nrow(written_colortable), 36);
expect_equal(ncol(written_colortable), 6);
region_unknown = subset(written_colortable, written_colortable$struct_name == "unknown");
expect_equal(region_unknown$struct_index, 0);
expect_equal(region_unknown$r, 25);
expect_equal(region_unknown$g, 5);
expect_equal(region_unknown$b, 25);
expect_equal(region_unknown$a, 0);
})
test_that("A colortable can be written to a text file in FreeSurfer LUT format.", {
colortable_df = data.frame("struct_index"=c(0, 1), "struct_name"=c("struct1", "struct2"), "r"=c(80, 100), "g"=c(50, 40), "b"=c(250, 200), "a"=c(0, 0), stringsAsFactors = FALSE);
output_file = tempfile(fileext = ".txt");
write.fs.colortable(output_file, colortable_df);
written_colortable = read.fs.colortable(output_file);
expect_equal(ncol(colortable_df), ncol(written_colortable));
expect_equal(nrow(colortable_df), nrow(written_colortable));
expect_equal(colortable_df, written_colortable);
# write colortable and have the function auto-fill struct_index
colortable_df2 = colortable_df;
colortable_df2$struct_index = NULL;
write.fs.colortable(tempfile(fileext = ".txt"), colortable_df2);
# errors should be thrown on invalid params
expect_error(write.fs.colortable(output_file, "what")); # colortable must be a data.frame, not a string
# delete vital columns and expect error
colortable_df2$struct_name = NULL;
colortable_df2$r = NULL;
expect_error(write.fs.colortable(output_file, colortable_df2)); # colortable missing columns 'struct_name' and 'r'
})
test_that("An annotation can be written in binary v2 format and read again.", {
annotfile = system.file("extdata", "lh.aparc.annot.gz", package = "freesurferformats", mustWork = TRUE);
annot = read.fs.annot(annotfile);
output_file = tempfile(fileext = ".annot");
write.fs.annot(output_file, length(annot$vertices), annot$colortable_df, labels_as_colorcodes=annot$label_codes);
annot2 = read.fs.annot(output_file);
expect_equal(annot$vertices, annot2$vertices);
expect_equal(annot, annot2);
# Cannot specify both labels_as_colorcodes and labels_as_indices_into_colortable
expect_error(write.fs.annot(output_file, length(annot$vertices), annot$colortable_df, labels_as_colorcodes=annot$label_codes, labels_as_indices_into_colortable=rep(1L, length(annot$vertices))));
# Give wrong number of labels and expect error
wrong_length = length(annot$vertices) + 5L;
expect_error(write.fs.annot(output_file, length(annot$vertices), annot$colortable_df, labels_as_indices_into_colortable=rep(1L, wrong_length)));
})
test_that("An annotation can be written in binary v2 format and read again based on the class method.", {
annotfile = system.file("extdata", "lh.aparc.annot.gz", package = "freesurferformats", mustWork = TRUE);
annot = read.fs.annot(annotfile);
output_file = tempfile(fileext = ".annot");
write.fs.annot(output_file, fs.annot=annot);
annot2 = read.fs.annot(output_file);
expect_equal(annot$vertices, annot2$vertices);
expect_equal(annot, annot2);
})
test_that("An annotation can be written in GIFTI format and read again based on the class method.", {
annotfile = system.file("extdata", "lh.aparc.annot.gz", package = "freesurferformats", mustWork = TRUE);
annot = read.fs.annot(annotfile);
output_file = tempfile(fileext = ".annot.gii");
write.fs.annot.gii(output_file, annot);
annot2 = read.fs.annot.gii(output_file);
expect_equal(annot$vertices, annot2$vertices, tolerance = 1e-2);
expect_equal(annot$label_codes, annot2$label_codes);
expect_equal(annot$label_names, annot2$label_names);
expect_equal(annot$hex_colors_rgb, annot2$hex_colors_rgb);
})
test_that("Invalid arguments to write.fs.annot lead to errors.", {
annotfile = system.file("extdata", "lh.aparc.annot.gz", package = "freesurferformats", mustWork = TRUE);
annot = read.fs.annot(annotfile);
expect_error(write.fs.annot.gii(tempfile(), list("a"=12))); # not an annot
expect_error(write.fs.annot.gii(123, annot)); # invalid filepath
})
test_that("An annotation can be written in binary v2 format in different ways.", {
output_file = tempfile(fileext = ".annot");
write.fs.annot(output_file, num_vertices = 10L, colortable = NULL, labels_as_colorcodes=rep(1L, 10L));
expect_error(write.fs.annot(output_file, num_vertices = 10L, colortable = NULL, labels_as_colorcodes=rep(1L, 9L))); # vertex count != label count
expect_error(write.fs.annot(output_file, num_vertices = "no idea", colortable = NULL, labels_as_colorcodes=rep(1L, 10L))); # invalid vertex count
expect_error(write.fs.annot(output_file, num_vertices = 10L, colortable = NULL, labels_as_indices_into_colortable = rep(1L, 10L))); # colortable must not be NULL when using indices into it
expect_equal(1L, 1L);
})