From e29e4974c324531ceef39d8a3edcc93f072d2870 Mon Sep 17 00:00:00 2001 From: Tomas Bylund Date: Mon, 6 Nov 2023 11:13:33 +0100 Subject: [PATCH 1/3] Removed stray : from ctapipe.io page --- docs/api-reference/io/index.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api-reference/io/index.rst b/docs/api-reference/io/index.rst index 82f18d7c908..a0f03f6f8da 100644 --- a/docs/api-reference/io/index.rst +++ b/docs/api-reference/io/index.rst @@ -114,7 +114,7 @@ for new data: column of an output table. -Serialization of Containers: +Serialization of Containers ============================ The `~ctapipe.io.TableWriter` and `~ctapipe.io.TableReader` base classes provide @@ -127,7 +127,7 @@ using the `~ctapipe.io.HDF5TableReader`, or more generically using the array values in a column cannot be read into a ``pandas.DataFrame``, since it only supports scalar values). -Writing Output Files: +Writing Output Files ===================== The `DataWriter` Component allows one to write a series of events (stored in @@ -144,12 +144,12 @@ information. It can be used in an event loop like: calibrate(event) write_data(event) -Reading Output Tables: +Reading Output Tables ====================== In addition to using an `EventSource` to read R0-DL1 data files, one can also access full *tables* for files that are in HDF5 format (e.g. DL1 and higher files). -`~ctapipe.io.TableLoader`: is a a convenient way to load and join together the +`~ctapipe.io.TableLoader` is a a convenient way to load and join together the tables in a ctapipe output file into one or more high-level tables useful for analysis. Which information is read and joined is controlled by the TableLoader's configuration options. From 9de22c297bef75c0a57a735e95f19fdd1ae3a38a Mon Sep 17 00:00:00 2001 From: Tomas Bylund Date: Mon, 6 Nov 2023 11:17:04 +0100 Subject: [PATCH 2/3] Added newline to get python block rendering properly --- docs/api-reference/io/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api-reference/io/index.rst b/docs/api-reference/io/index.rst index a0f03f6f8da..bbcb6dddadb 100644 --- a/docs/api-reference/io/index.rst +++ b/docs/api-reference/io/index.rst @@ -169,6 +169,7 @@ into one big table, joining the simulation information if available: You can also load telescope events for specific selections of telescopes: + .. code-block:: python # by str representation of the type From f44b1772cfaf8dbf0f4982cf168c5d747a9004ed Mon Sep 17 00:00:00 2001 From: Tomas Bylund Date: Mon, 6 Nov 2023 13:02:30 +0100 Subject: [PATCH 3/3] Fixed underlining to match length of title --- docs/api-reference/io/index.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api-reference/io/index.rst b/docs/api-reference/io/index.rst index bbcb6dddadb..adbc43492b4 100644 --- a/docs/api-reference/io/index.rst +++ b/docs/api-reference/io/index.rst @@ -14,7 +14,7 @@ in-memory storage of event data Reading Event Data -=================== +================== This module provides a set of *event sources* that are python generators that loop through an input file or stream and fill in @@ -115,7 +115,7 @@ for new data: Serialization of Containers -============================ +=========================== The `~ctapipe.io.TableWriter` and `~ctapipe.io.TableReader` base classes provide an interface to implement subclasses that write/read Containers to/from @@ -128,7 +128,7 @@ array values in a column cannot be read into a ``pandas.DataFrame``, since it only supports scalar values). Writing Output Files -===================== +==================== The `DataWriter` Component allows one to write a series of events (stored in `ctapipe.containers.ArrayEventContainer`) to a standardized HDF5 format file @@ -145,7 +145,7 @@ information. It can be used in an event loop like: write_data(event) Reading Output Tables -====================== +===================== In addition to using an `EventSource` to read R0-DL1 data files, one can also access full *tables* for files that are in HDF5 format (e.g. DL1 and higher files).