Scenario
Entire scenario.
Scenario
Bases: BaseModel
Entire synthetic data scenario.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params
|
ScenarioParams
|
scenario parameters |
required |
grids
|
list[Grid]
|
sample site grids |
<dynamic>
|
specimens
|
AllSpecimens
|
all specimens |
required |
machines
|
list[Machine]
|
laboratory machines |
required |
persons
|
list[Person]
|
lab staff |
required |
assays
|
list[Assay]
|
assays |
required |
images
|
dict[str, Image]
|
assay images |
required |
Source code in src/snailz/scenario.py
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 122 |
|
generate(params)
staticmethod
Generate entire scenario.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params
|
ScenarioParams
|
controlling parameters |
required |
Returns:
Type | Description |
---|---|
Scenario
|
all generated data. |
Source code in src/snailz/scenario.py
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 |
|
to_csv(root)
Write as CSV (and PNG).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
root
|
str
|
root directory for output |
required |
Source code in src/snailz/scenario.py
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 |
|