You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/man/analyzing_output.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,17 +3,17 @@
3
3
## Loading output
4
4
5
5
### `PhysiCellSnapshot`
6
-
The base unit of PhysiCell output is the [`PhysiCellSnapshot`](@ref).
6
+
The base unit of PhysiCell output is the `PhysiCellSnapshot`.
7
7
These are currently considered pcvct internals and so the API may change.
8
8
Each snapshot records the path to the PhysiCell output folder, its index in the sequence of outputs, the time of the snapshot in the simulation, and optionally the cell, substrate, and mesh data at that snapshot.
9
9
10
10
### `PhysiCellSequence`
11
-
A [`PhysiCellSequence`](@ref) is the full sequence of snapshots corresponding to a single PhysiCell simulation.
11
+
A `PhysiCellSequence` is the full sequence of snapshots corresponding to a single PhysiCell simulation.
12
12
As with `PhysiCellSnapshot`'s, these are currently considered internals and their API may change.
13
13
In addition to the path to the PhysiCell output folder and the vector of `PhysiCellSnapshot`'s, it holds metadata for the simulation.
14
14
15
15
### `getCellDataSequence`
16
-
The main function to get sequences of cell data is [`getCellDataSequence`](@ref).
16
+
The main function to get sequences of cell data is `getCellDataSequence`.
17
17
It accepts any of a simulation ID (`<:Integer`), a simulation (`::Simulation`), or a sequence (`::PhysiCellSequence`) and either a single label (`::String`) or a vector of labels (`::Vector{String}`).
18
18
For each cell in the simulation (as determined by the cell ID), the output creates a dictionary entry (the key is the integer cell ID) whose value is a named tuple with the input labels as keys as well as `:time`.
19
19
This means that if one sets
@@ -77,8 +77,8 @@ plotbycelltype(Sampling(1); include_cell_types=["epi", "mes", ["epi", "mes"]], c
77
77
## Substrate analysis
78
78
pcvct supports two ways to summarize substrate information over time.
79
79
80
-
### AverageSubstrateTimeSeries
81
-
An [`AverageSubstrateTimeSeries`](@ref) gives the time series for the average substrate across the entire domain.
80
+
### `AverageSubstrateTimeSeries`
81
+
An `AverageSubstrateTimeSeries` gives the time series for the average substrate across the entire domain.
82
82
83
83
```julia
84
84
simulation_id =1
@@ -88,7 +88,7 @@ plot(asts.time, asts["oxygen"])
88
88
```
89
89
90
90
### `ExtracellularSubstrateTimeSeries`
91
-
An [`ExtracellularSubstrateTimeSeries`](@ref) gives the time series for the average substrate concentration in the extracellular space neighboring all cells of a given cell type.
91
+
An `ExtracellularSubstrateTimeSeries` gives the time series for the average substrate concentration in the extracellular space neighboring all cells of a given cell type.
92
92
In a simulation with `cd8` cells and `IFNg` diffusible substrate, plot the average concentration of IFNg experienced by CD8+ T cells using the following:
0 commit comments