Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@matthiasprobst
matthiasprobst committed Mar 10, 2024
1 parent 36b7c73 commit b5a1299
Show file tree
Hide file tree
Showing 6 changed files with 71 additions and 101 deletions.
22 changes: 11 additions & 11 deletions docs/getting_started/IO.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
"id": "79d4a524-9c0c-4ec1-92a8-6556bb1bb7bc",
"metadata": {},
"source": [
"# IO\n",
"# IO (Read/Write)\n",
"\n",
"`synpivimage` lets you store your metadata in JSON-LD files, which is just like a JSON file but with a context. This makes metadata human- and machine-readable and actionable."
]
},
{
"cell_type": "code",
"execution_count": 7,
"execution_count": 1,
"id": "97a5e1b2-8d66-46d2-8f14-7e2aba27abb7",
"metadata": {},
"outputs": [],
Expand All @@ -30,7 +30,7 @@
},
{
"cell_type": "code",
"execution_count": 8,
"execution_count": 2,
"id": "0b1a2624-9632-4016-9c7c-e32891b3b191",
"metadata": {},
"outputs": [],
Expand Down Expand Up @@ -65,7 +65,7 @@
},
{
"cell_type": "code",
"execution_count": 9,
"execution_count": 3,
"id": "35a0121a-ec83-4194-a35a-827af901402c",
"metadata": {},
"outputs": [],
Expand All @@ -86,7 +86,7 @@
},
{
"cell_type": "code",
"execution_count": 10,
"execution_count": 4,
"id": "c36d7868-6250-43ce-82e6-a5992961f641",
"metadata": {},
"outputs": [],
Expand All @@ -96,7 +96,7 @@
},
{
"cell_type": "code",
"execution_count": 11,
"execution_count": 5,
"id": "fec1ea3c-b0f6-4e84-9aa5-0f7998520415",
"metadata": {},
"outputs": [],
Expand All @@ -106,7 +106,7 @@
},
{
"cell_type": "code",
"execution_count": 12,
"execution_count": 6,
"id": "c4ba56ca-cf4b-48a4-9544-00b9992e1768",
"metadata": {},
"outputs": [],
Expand All @@ -116,7 +116,7 @@
},
{
"cell_type": "code",
"execution_count": 14,
"execution_count": 7,
"id": "6122cdd9-1b66-40c6-b719-0b735c4877bf",
"metadata": {},
"outputs": [
Expand All @@ -126,7 +126,7 @@
"(2, 2)"
]
},
"execution_count": 14,
"execution_count": 7,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -150,7 +150,7 @@
},
{
"cell_type": "code",
"execution_count": 15,
"execution_count": 8,
"id": "07b22f88-939f-419f-bd47-ec01d58152a3",
"metadata": {},
"outputs": [
Expand All @@ -160,7 +160,7 @@
"Laser(shape_factor=2, width=2.0)"
]
},
"execution_count": 15,
"execution_count": 8,
"metadata": {},
"output_type": "execute_result"
}
Expand Down
103 changes: 36 additions & 67 deletions docs/getting_started/SingleImage.ipynb
View file

Large diffs are not rendered by default.

30 changes: 15 additions & 15 deletions docs/getting_started/cam.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"m4i:hasUnit": "http://qudt.org/vocab/unit/UNITLESS",
"m4i:hasKindOfQuantity": "http://qudt.org/vocab/quantitykind/Dimensionless",
"pivmeta:hasStandardName": "https://matthiasprobst.github.io/pivmeta#sensor_pixel_width",
"@id": "local:b8b3747d-c616-425f-9982-9b9a500f140b"
"@id": "local:da1e91ff-1133-4ac3-a2d2-5a2ae5930f9a"
},
{
"@type": "m4i:NumericalVariable",
Expand All @@ -26,69 +26,69 @@
"m4i:hasUnit": "http://qudt.org/vocab/unit/UNITLESS",
"m4i:hasKindOfQuantity": "http://qudt.org/vocab/quantitykind/Dimensionless",
"pivmeta:hasStandardName": "https://matthiasprobst.github.io/pivmeta#sensor_pixel_height",
"@id": "local:f72a97ce-d03f-4e4a-bb2b-054b08da54ef"
"@id": "local:51c581b1-f37d-48cc-a62a-ff77878bb3bc"
},
{
"@type": "m4i:NumericalVariable",
"rdfs:label": "bit_depth",
"m4i:hasNumericalValue": "16",
"m4i:hasUnit": "http://qudt.org/vocab/unit/BIT",
"m4i:hasKindOfQuantity": "http://qudt.org/vocab/quantitykind/InformationEntropy",
"@id": "local:887aee9d-44ed-4e13-a1a6-6d3d8447160a"
"@id": "local:42575537-edef-41a6-8f3a-c7f3c8a2cb3e"
},
{
"@type": "m4i:NumericalVariable",
"rdfs:label": "qe",
"m4i:hasVariableDescription": "quantum efficiency",
"m4i:hasNumericalValue": "1.0",
"@id": "local:d3291c14-4c83-4127-8bec-e892763e4c27"
"@id": "local:a9352d4b-3a24-4ed2-9fd9-ebc6c81296f6"
},
{
"@type": "m4i:NumericalVariable",
"rdfs:label": "sensitivity",
"m4i:hasNumericalValue": "1.0",
"@id": "local:e3f2744c-3d16-49ec-ba96-57afced39607"
"@id": "local:7f6ca733-ce47-4fd8-a8ec-2b555389ace1"
},
{
"@type": "m4i:NumericalVariable",
"rdfs:label": "baseline_noise",
"m4i:hasVariableDescription": "Dark noise is the mean value of a gaussian noise model",
"m4i:hasNumericalValue": "0.0",
"@id": "local:b5bb37c5-8c65-475a-88ba-078da55b04c4"
"@id": "local:6ec0d5fa-ea8a-4fd3-a744-e1029ae1f308"
},
{
"@type": "m4i:NumericalVariable",
"rdfs:label": "dark_noise",
"m4i:hasVariableDescription": "Dark noise is the standard deviation of a gaussian noise model",
"m4i:hasNumericalValue": "0.0",
"@id": "local:628003bb-4d9c-4939-8d47-999104504368"
"@id": "local:59d4d3e7-778f-468d-ad94-e921cb7386ce"
},
{
"@type": "m4i:NumericalVariable",
"rdfs:label": "fill_ratio_x",
"m4i:hasNumericalValue": "1.0",
"pivmeta:hasStandardName": "https://matthiasprobst.github.io/pivmeta#sensor_pixel_width_fill_factor",
"@id": "local:7c631372-9a7e-4246-9c1c-468c0af1d1fa"
"@id": "local:0154bc43-e5e9-4b7c-a5cc-060f5a01b3c3"
},
{
"@type": "m4i:NumericalVariable",
"rdfs:label": "fill_ratio_y",
"m4i:hasNumericalValue": "1.0",
"pivmeta:hasStandardName": "https://matthiasprobst.github.io/pivmeta#sensor_pixel_height_fill_factor",
"@id": "local:7888ce26-c739-4cf4-9950-0c546a65ff2c"
"@id": "local:2940ccba-6995-47da-9959-01bc81c49354"
},
{
"@type": "m4i:NumericalVariable",
"rdfs:label": "particle_image_diameter",
"m4i:hasNumericalValue": "1.0",
"pivmeta:hasStandardName": "https://matthiasprobst.github.io/pivmeta#image_particle_diameter",
"@id": "local:a10ca42d-912a-4013-93f4-09a1ef735e00"
"@id": "local:14bfc730-336e-4c91-b0a7-a706ccb325f5"
},
{
"@type": "m4i:TextVariable",
"rdfs:label": "shot_noise",
"m4i:hasStringValue": "false",
"@id": "local:9c53ad1d-1ee6-49a2-bb47-2ffafdfe7137"
"@id": "local:741ab982-2e24-4e7d-bbe7-e87aed64e4d0"
}
],
"codemeta:hasSourceCode": {
Expand All @@ -99,9 +99,9 @@
"schema:affiliation": {
"@type": "Organization",
"foaf:name": "Karlsruhe Institute of Technology, Institute of Thermal Turbomachinery",
"@id": "local:3bbfad53-c4cb-45ba-a329-d43378552eed"
"@id": "local:35b29afe-e6dd-4aad-a279-2ea02ca8660e"
},
"@id": "local:f0aeaf21-92ef-483a-8a93-16a46fa3a99a",
"@id": "local:d2bf0faa-1ba9-4594-998a-814d157be2df",
"givenName": "Matthias",
"familyName": "Probst",
"email": "matthias.probst@kit.edu"
Expand All @@ -127,7 +127,7 @@
"Windows",
"macOS"
],
"@id": "local:e989404b-770f-4977-8585-bcf2feab1182"
"@id": "local:5809227c-b206-4fa2-a412-d56668bebc31"
},
"@id": "local:00521c62-a16b-45c8-a336-d3ba6dbcd18f"
"@id": "local:9bb6dda8-00b9-4761-89fa-262d5d93ed7a"
}
12 changes: 6 additions & 6 deletions docs/getting_started/laser.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"m4i:hasUnit": "mm",
"m4i:hasKindOfQuantity": "http://qudt.org/vocab/unit/MilliM",
"pivmeta:hasStandardName": "https://matthiasprobst.github.io/pivmeta#model_laser_sheet_thickness",
"@id": "local:1c03c67d-2508-499f-bf2a-19e8de385c31"
"@id": "local:b0edee9b-d8a6-4542-ab16-93bb99c1ca8b"
},
{
"@type": "m4i:NumericalVariable",
Expand All @@ -27,7 +27,7 @@
"m4i:hasUnit": "",
"m4i:hasKindOfQuantity": "https://qudt.org/schema/qudt/DimensionlessUnit",
"pivmeta:hasStandardName": "https://matthiasprobst.github.io/pivmeta#model_laser_sheet_shape_factor",
"@id": "local:b46c0b4f-c140-4864-8aec-7c9761c57e1b"
"@id": "local:26414db3-e79f-4fa7-aca7-3f159a48f3f2"
}
],
"codemeta:hasSourceCode": {
Expand All @@ -38,9 +38,9 @@
"schema:affiliation": {
"@type": "Organization",
"foaf:name": "Karlsruhe Institute of Technology, Institute of Thermal Turbomachinery",
"@id": "local:86b6f83a-f1f7-4840-b19c-ed50c4943a96"
"@id": "local:b93f863a-c503-4c7d-a7f3-7ae0a3329289"
},
"@id": "local:c7092e36-23cc-4837-a0fb-31d28d50c9cd",
"@id": "local:4105bc9a-beed-42f3-8922-0925a03f19f3",
"givenName": "Matthias",
"familyName": "Probst",
"email": "matthias.probst@kit.edu"
Expand All @@ -66,7 +66,7 @@
"Windows",
"macOS"
],
"@id": "local:f16f4f68-c09c-4c7a-a21c-3c6b2ef3cd79"
"@id": "local:93c51e36-c5d1-4a45-938d-ee7dff3b2499"
},
"@id": "local:e035ba3a-3641-4832-acf1-5bdcf671a50f"
"@id": "local:ef47b12c-b7a8-4720-8f77-20e99edb752f"
}
3 changes: 2 additions & 1 deletion requirements-doc.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ scikit-learn
sphinx-design
myst-nb
nbsphinx
sphinxcontrib-bibtex
sphinxcontrib-bibtex
h5rdmtoolbox @ git+https://github.com/matthiasprobst/h5RDMtoolbox@dev-jsonld
2 changes: 1 addition & 1 deletion synpivimage/io.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ def __init__(self,
The filename of the HDF5 file
"""
self.filename = filename
self.filename = pathlib.Path(filename)
self.image_dataset_name = image_dataset_name
self.particle_dataset_name = particle_dataset_name
self.overwrite = overwrite
Expand Down

0 comments on commit b5a1299

Please sign in to comment.