cylindra.core
collect_projects(files, *, skip_exc=False)
Collect project files into a ProjectSequence object.
Examples:
collect_projects("path/to/dir/*.json")
collect_projects(["path/to/dir-0/*.zip", "path/to/dir-1/*.zip"])
Parameters:
Name | Type | Description | Default |
---|---|---|---|
files
|
path-like or iterable of path-like
|
Project file paths or glob pattern(s). |
required |
Source code in cylindra/core.py
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
|
instance(create=False)
instance(create: Literal[False] = False) -> CylindraMainWidget | None
instance(create: Literal[True]) -> CylindraMainWidget
Get the current CylindraMainWidget instance.
Source code in cylindra/core.py
176 177 178 179 180 181 |
|
read_molecules(file, pos_cols=('z', 'y', 'x'), rot_cols=('zvec', 'yvec', 'xvec'))
Read a molecules CSV or parquet file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file
|
PathLike
|
File path. |
required |
pos_cols
|
sequence of str
|
Column names for the molecule positions. |
("z", "y", "x")
|
rot_cols
|
sequence of str
|
Column names for the molecule rotation vectors. |
("zvec", "yvec", "xvec")
|
Returns:
Type | Description |
---|---|
Molecules
|
Molecules object. |
Source code in cylindra/core.py
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
|
read_project(file)
Read the Cylindra project file.
Source code in cylindra/core.py
195 196 197 198 199 |
|
read_spline(file)
Read a spline file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file
|
PathLike
|
File path. |
required |
Returns:
Type | Description |
---|---|
CylSpline
|
CylSpline object. |
Source code in cylindra/core.py
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
|
start(project_file=None, viewer=None, *, log_level='INFO', headless=False, add_main_widget=True, run=True)
Start napari viewer and dock cylindra widget as a dock widget.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_file
|
path - like
|
If given, load the project file. |
None
|
viewer
|
Viewer
|
Give a viewer object and this viewer will be used as the parent. |
None
|
log_level
|
int or str
|
Log level. See |
"INFO"
|
headless
|
bool
|
If True, do not show the viewer. |
False
|
Source code in cylindra/core.py
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 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
|
start_as_plugin(run=True)
Start Cylindra as a napari plugin
Source code in cylindra/core.py
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
|
view_project(project_file, show=True)
View the Cylindra project file.
Source code in cylindra/core.py
184 185 186 187 188 189 190 191 192 |
|