Legend Data Types JL

https://legend-exp.github.io/LegendDataTypes.jl/stable/
Admin
LegendDataTypes.jl provides essential data types, functions, and macros for handling and processing...
Tokens:6,608
Snippets:65
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get All Channels

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Retrieves all channel numbers from a datastore. Channels are identified by keys starting with 'ch...'.

```julia
get_all_channels(ds::AbstractDict{<:AbstractString,<:Any})::AbstractVector{<:Integer}
```

--------------------------------

### Get Index from Input

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Retrieves an object from input using a key. Supports an optional index vector.

```julia
getindex(input::AbstractLegendInput, key::AbstractString)
getindex(input::AbstractLegendInput, key::AbstractString, idxs::AbstractVector)
```

--------------------------------

### Get Raw Channel Data

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Retrieves the raw data table for a specific channel from a datastore.

```julia
get_raw_ch_data(ds::AbstractDict{<:AbstractString,<:Any}, ch::Integer)::TableLike
```

--------------------------------

### Get Units

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Gets the units of an object. Falls back to Unitful.unit(x) if no specialized method is defined.

```julia
getunits(x)
```

--------------------------------

### LegendDataTypes.getunits(x)

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Gets the units of an object `x`. Falls back to `Unitful.unit(x)` if no specialized method is defined. Packages handling I/O should add methods for their object types.

```APIDOC
## LegendDataTypes.getunits(x)

### Description
Gets the units of an object `x`. Falls back to `Unitful.unit(x)` if no specialized method is defined. Packages handling I/O should add methods for their object types.

### Method
GET (implied)

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **x** (Any) - The object for which to retrieve units.

### Request Example
```
getunits(some_quantity)
```

### Response
#### Success Response (200)
- **units** (Unitful.Units) - The units of the object `x`.

#### Response Example
```
Unitful.m
```
```

--------------------------------

### LegendDataTypes.get_all_channels(ds::AbstractDict{<:AbstractString,<:Any})

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Retrieves the channel numbers for all channels present in a datastore. Channels are identified by keys starting with 'ch...'.

```APIDOC
## LegendDataTypes.get_all_channels(ds::AbstractDict{<:AbstractString,<:Any})

### Description
Retrieves the channel numbers for all channels present in a datastore. Channels are identified by keys starting with 'ch...'.

### Method
GET (implied)

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **ds** (AbstractDict{<:AbstractString,<:Any}) - The datastore containing channel information.

### Request Example
```
get_all_channels(datastore)
```

### Response
#### Success Response (200)
- **channel_numbers** (AbstractVector{<:Integer}) - A vector of integer channel numbers.

#### Response Example
```
[0, 1, 2]
```
```

--------------------------------

### Get DAQ Energy

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Retrieves the DAQ energy reconstruction for a specific channel from the raw data in a datastore.

```julia
get_daqenergy(datastore::AbstractDict{<:AbstractString,<:Any}, ch::Integer)::AbstractVector{<:Integer}
```

--------------------------------

### Create Similar Table from Columns

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Returns a table that is similar to the original table 'orig_tbl', constructed from the provided columns 'cols'.

```julia
LegendDataTypes.similar_table(orig_tbl::AbstractVector{<:NamedTuple{names}}, cols::NamedTuple{names})
```

--------------------------------

### Write Codec Information to Destination

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Writes all information necessary to recreate the 'codec' to 'dest' using a destination-specific write function. Typically returns nothing.

```julia
write_to_properties!(write_property!::Function, dest::Any, codec::AbstractArrayCodec)
```

--------------------------------

### similar_table

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Creates a new table that is similar to the original table, using the provided columns. This is useful for creating tables with the same structure but different data.

```APIDOC
## similar_table

### Description
Return a table similar to `orig_tbl` from columns `cols`.

### Method
`LegendDataTypes.similar_table(orig_tbl::AbstractVector{<:NamedTuple{names}}, cols::NamedTuple{names})`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Set Index for Output

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Sets an object in output using a key. Note: This snippet appears to be a mix of setindex! and getindex functionality based on the provided text.

```julia
setindex!(output::AbstractLegendOutput, key::AbstractString)
getindex(output::AbstractLegendOutput, key::AbstractString, idxs::AbstractVector)
```

--------------------------------

### Base.getindex(input::AbstractLegendInput, key::AbstractString)

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Retrieves an object from the input using a specified key. This is a fundamental operation for accessing data within the input structure.

```APIDOC
## Base.getindex(input::AbstractLegendInput, key::AbstractString)

### Description
Retrieves an object from the input using a specified key. This is a fundamental operation for accessing data within the input structure.

### Method
GET (implied)

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
getindex(input_object, "some_key")
```

### Response
#### Success Response (200)
- **object** (Any) - The retrieved object associated with the key.

#### Response Example
```
# Example response depends on the type of object retrieved
```
```

--------------------------------

### to_properties

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Writes information required to recreate a codec to a destination. It uses a provided write function to handle property-specific writing.

```APIDOC
## to_properties

### Description
Write all information required to re-create `codec` to `dest` using the `dest`-specific function `write_property!(dest, name::Symbol, x)`. Typically returns `nothing`.

### Method
`write_to_properties!(write_property!::Function, dest::Any, codec::AbstractArrayCodec)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Base.setindex!(output::AbstractLegendOutput, key::AbstractString)

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Sets an object within the output structure using a specified key. This method is used for modifying or adding data to the output.

```APIDOC
## Base.setindex!(output::AbstractLegendOutput, key::AbstractString)

### Description
Sets an object within the output structure using a specified key. This method is used for modifying or adding data to the output.

### Method
SET (implied)

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **value** (Any) - The object to be set at the specified key.

### Request Example
```
setindex!(output_object, "some_key") = some_value
```

### Response
#### Success Response (200)
None (operation modifies output in place)

#### Response Example
None
```

--------------------------------

### Map Table in Chunks

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Maps a function over a table in chunks of a specified size. Efficient for disk-based arrays.

```julia
map_chunked(f, table, chunk_size::Integer)
```

--------------------------------

### Base.getindex(input::AbstractLegendInput, key::AbstractString, idxs::AbstractVector)

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Retrieves a subset of an object from the input using a specified key and a vector of indices. Allows for precise data extraction.

```APIDOC
## Base.getindex(input::AbstractLegendInput, key::AbstractString, idxs::AbstractVector)

### Description
Retrieves a subset of an object from the input using a specified key and a vector of indices. Allows for precise data extraction.

### Method
GET (implied)

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
getindex(input_object, "some_key", [1, 3, 5])
```

### Response
#### Success Response (200)
- **subset_object** (Any) - The subset of the object corresponding to the specified indices.

#### Response Example
```
# Example response depends on the type of object retrieved
```
```

--------------------------------

### Read from Properties

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Reads data from properties using a provided read function, source, and type.

```julia
read_from_properties(read_property::Function, src::Any, ::Type{T}) where {T<:AbstractArrayCodec}
```

--------------------------------

### Filter Raw Data by Energy

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Filters raw data based on provided energy windows and a calibration function. Returns a dictionary of filtered raw data tables.

```julia
filter_raw_data_by_energy(
    raw_data::TableLike,
    calib_func::Function,
    energy_windows::AbstractDict{Symbol,<:AbstractInterval{<:Number}}
)::IDDict{Symbol,<:Any}
```

--------------------------------

### Convert Integer to Channel Name

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Converts an integer channel number to its corresponding channel name string.

```julia
int2chname(channel_number::Integer)::AbstractString
```

--------------------------------

### Create Array Codec from Properties

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Creates an array codec of type T from source properties using a specific read function. Returns a value of type T.

```julia
LegendDataTypes.readdata(input, SomeDataType::Type)
```

--------------------------------

### Write Value to Output

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Writes a given value 'x' to the specified output. This is a core function for data serialization.

```julia
readdata(input, x::SomeDataType)
```

--------------------------------

### LegendDataTypes.filter_raw_data_by_energy(raw_data::TableLike, calib_func::Function, energy_windows::AbstractDict{Symbol,<:AbstractInterval{<:Number}})

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Filters raw data based on energy reconstruction and a provided calibration function, selecting events within specified energy windows. Returns a dictionary of filtered raw data tables.

```APIDOC
## LegendDataTypes.filter_raw_data_by_energy(raw_data::TableLike, calib_func::Function, energy_windows::AbstractDict{Symbol,<:AbstractInterval{<:Number}})

### Description
Filters raw data based on energy reconstruction and a provided calibration function, selecting events within specified energy windows. Returns a dictionary of filtered raw data tables.

### Method
POST (implied, as it filters data)

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **raw_data** (TableLike) - The raw data to be filtered.
- **calib_func** (Function) - The energy calibration function.
- **energy_windows** (AbstractDict{Symbol,<:AbstractInterval{<:Number}}) - A dictionary defining the energy windows for filtering.

### Request Example
```
filter_raw_data_by_energy(raw_data_table, calibration_function, Dict(:window1 => 10..20, :window2 => 30..40))
```

### Response
#### Success Response (200)
- **filtered_data** (IDDict{Symbol,<:Any}) - A dictionary containing filtered raw data tables, keyed by the symbols from `energy_windows`.

#### Response Example
```
# Example response is a dictionary of tables, structure depends on input raw_data
```
```

--------------------------------

### Convert Channel Name to Integer

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Converts a channel name string to its corresponding integer channel number.

```julia
chname2int(channel_string::AbstractString)::Integer
```

--------------------------------

### LegendDataTypes.writedata(data, filename)

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Writes data to a specified file. This is a core function for persisting data.

```APIDOC
## LegendDataTypes.writedata(data, filename)

### Description
Writes data to a specified file. This is a core function for persisting data.

### Method
POST (implied, as it writes data)

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **data** (Any) - The data to be written.
- **filename** (AbstractString) - The name of the file to write to.

### Request Example
```
writedata(my_data, "output.dat")
```

### Response
#### Success Response (200)
None (operation writes to file)

#### Response Example
None
```

--------------------------------

### Set Units of an Object

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Sets the units of the provided object 'x'. LEGEND I/O packages may need to add methods for specific I/O-object types.

```julia
setunits!(x)
```

--------------------------------

### setunits!

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Sets the units for a given object. This function is intended for LEGEND I/O packages to add methods for handling specific I/O object types.

```APIDOC
## setunits!

### Description
Set the units of x. LEGEND I/O packages will need to add methods for the I/O-object types they handle.

### Method
`setunits!(x)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### LegendDataTypes.get_daqenergy(datastore::AbstractDict{<:AbstractString,<:Any}, ch::Integer)

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Retrieves the DAQ energy reconstruction data for a specific channel from the datastore. Channel numbers are mapped to names internally.

```APIDOC
## LegendDataTypes.get_daqenergy(datastore::AbstractDict{<:AbstractString,<:Any}, ch::Integer)

### Description
Retrieves the DAQ energy reconstruction data for a specific channel from the datastore. Channel numbers are mapped to names internally.

### Method
GET (implied)

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **datastore** (AbstractDict{<:AbstractString,<:Any}) - The datastore containing the raw data.
- **ch** (Integer) - The channel number for which to retrieve DAQ energy.

### Request Example
```
get_daqenergy(datastore, 0)
```

### Response
#### Success Response (200)
- **daq_energy** (AbstractVector{<:Integer}) - A vector of DAQ energy values for the specified channel.

#### Response Example
```
[100, 105, 110]
```
```

--------------------------------

### LegendDataTypes.get_raw_ch_data(ds::AbstractDict{<:AbstractString,<:Any}, ch::Integer)

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Retrieves the raw data table for a specific channel from the datastore. Channel numbers are mapped to names internally.

```APIDOC
## LegendDataTypes.get_raw_ch_data(ds::AbstractDict{<:AbstractString,<:Any}, ch::Integer)

### Description
Retrieves the raw data table for a specific channel from the datastore. Channel numbers are mapped to names internally.

### Method
GET (implied)

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **ds** (AbstractDict{<:AbstractString,<:Any}) - The datastore containing the raw data.
- **ch** (Integer) - The channel number for which to retrieve raw data.

### Request Example
```
get_raw_ch_data(datastore, 0)
```

### Response
#### Success Response (200)
- **raw_data_table** (TableLike) - The raw data table for the specified channel.

#### Response Example
```
# Example response is a table-like structure, e.g., a NamedTuple or StructArray
```
```

--------------------------------

### writedata

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Writes a value to the output. This function is the counterpart to `readdata` and is used for serializing data.

```APIDOC
## writedata

### Description
Write a value `x` to `output`.

### Method
`writedata(output, x::SomeDataType)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Flatten Data by Key

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Flattens a vector of IdDicts into a single IdDict by concatenating entries for each key separately.

```julia
flatten_by_key(data::AbstractVector{<:IdDict{<:Any, <:AbstractVector}})::IdDict
```

--------------------------------

### LegendDataTypes.read_from_properties(read_property::Function, src::Any, ::Type{T}) where {T<:AbstractArrayCodec}

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Reads data from properties using a provided read function, source, and a target type `T` which must be a subtype of `AbstractArrayCodec`. This is a generic function for reading encoded data.

```APIDOC
## LegendDataTypes.read_from_properties(read_property::Function, src::Any, ::Type{T}) where {T<:AbstractArrayCodec}

### Description
Reads data from properties using a provided read function, source, and a target type `T` which must be a subtype of `AbstractArrayCodec`. This is a generic function for reading encoded data.

### Method
GET (implied, as it reads data)

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **read_property** (Function) - The function used to read properties.
- **src** (Any) - The source of the data.
- **T** (Type{<:AbstractArrayCodec}) - The target type for the decoded data, must be a subtype of `AbstractArrayCodec`.

### Request Example
```
read_from_properties(read_prop_func, data_source, LegendDataTypes.RadwareSigcompress)
```

### Response
#### Success Response (200)
- **decoded_object** (T) - An object of type `T` containing the decoded data.

#### Response Example
```
# Example response is an instance of AbstractArrayCodec, e.g., RadwareSigcompress
```
```

--------------------------------

### LegendDataTypes.to_properties(data)

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Converts data into a properties format. This function is likely used for serialization or preparing data for storage or transmission.

```APIDOC
## LegendDataTypes.to_properties(data)

### Description
Converts data into a properties format. This function is likely used for serialization or preparing data for storage or transmission.

### Method
POST (implied, as it transforms data)

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **data** (Any) - The data to convert into properties.

### Request Example
```
to_properties(some_data)
```

### Response
#### Success Response (200)
- **properties** (Any) - The data represented in a properties format.

#### Response Example
```
# Example response is a dictionary or similar structure representing properties
```
```

--------------------------------

### LegendDataTypes.int2chname(channel_number::Integer)

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Converts an integer channel number to a channel name string, as used in LEGEND data files. This is the inverse of `chname2int`.

```APIDOC
## LegendDataTypes.int2chname(channel_number::Integer)

### Description
Converts an integer channel number to a channel name string, as used in LEGEND data files. This is the inverse of `chname2int`.

### Method
GET (implied)

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
int2chname(0)
```

### Response
#### Success Response (200)
- **channel_string** (AbstractString) - The channel name string corresponding to the integer channel number.

#### Response Example
```
"ch0"
```
```

--------------------------------

### RadwareSigcompress Type Definition

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Defines the RadwareSigcompress type, which is a subtype of AbstractArrayCodec.

```julia
RadwareSigcompress <: AbstractArrayCodec
```

--------------------------------

### LegendDataTypes.chname2int(channel_string::AbstractString)

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Converts a channel name string, as used in LEGEND data files, to an integer channel number. This is essential for numerical processing of channel data.

```APIDOC
## LegendDataTypes.chname2int(channel_string::AbstractString)

### Description
Converts a channel name string, as used in LEGEND data files, to an integer channel number. This is essential for numerical processing of channel data.

### Method
GET (implied)

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
chname2int("ch0")
```

### Response
#### Success Response (200)
- **channel_number** (Integer) - The integer representation of the channel name.

#### Response Example
```
0
```
```

--------------------------------

### LegendDataTypes.setunits!(x, units)

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Sets the units of an object `x` to the specified `units`. This function is intended for use by packages handling I/O to associate units with their data types.

```APIDOC
## LegendDataTypes.setunits!(x, units)

### Description
Sets the units of an object `x` to the specified `units`. This function is intended for use by packages handling I/O to associate units with their data types.

### Method
SET (implied)

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **x** (Any) - The object whose units are to be set.
- **units** (Unitful.Units) - The units to assign to the object.

### Request Example
```
setunits!(some_quantity, Unitful.kg)
```

### Response
#### Success Response (200)
None (operation modifies object in place)

#### Response Example
None
```

--------------------------------

### readdata

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Reads a value of a specified data type from the input. This function is used to deserialize data according to a given type.

```APIDOC
## readdata

### Description
Read a value of type `SomeDataType` from `input`.

### Method
`readdata(input, SomeDataType::Type)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### LegendDataTypes.map_chunked(f, table, chunk_size::Integer)

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Maps a function `f` over a table in chunks of a specified size. This method is efficient for arrays with slow serial indexing but fast block-wise indexing, such as disk-based arrays.

```APIDOC
## LegendDataTypes.map_chunked(f, table, chunk_size::Integer)

### Description
Maps a function `f` over a table in chunks of a specified size. This method is efficient for arrays with slow serial indexing but fast block-wise indexing, such as disk-based arrays.

### Method
POST (implied, as it applies a function)

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **f** (Function) - The function to apply to each chunk.
- **table** (Any) - The table to process.
- **chunk_size** (Integer) - The size of each chunk.

### Request Example
```
map_chunked(my_function, my_table, 1000)
```

### Response
#### Success Response (200)
- **result** (Any) - The result of applying the function `f` to the table in chunks.

#### Response Example
```
# Example response depends on the function `f` and the `table` structure
```
```

--------------------------------

### Fast Flatten Array

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Flattens a vector of arrays into a single array by concatenating along the last dimension.

```julia
fast_flatten(vector_of_arrays)
```

--------------------------------

### LegendDataTypes.flatten_by_key(data::AbstractVector{<:IdDict{<:Any, <:AbstractVector}})

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Flattens a vector of IdDicts into a single IdDict by concatenating entries for each key separately. Useful for merging data from multiple sources.

```APIDOC
## LegendDataTypes.flatten_by_key(data::AbstractVector{<:IdDict{<:Any, <:AbstractVector}})

### Description
Flattens a vector of IdDicts into a single IdDict by concatenating entries for each key separately. Useful for merging data from multiple sources.

### Method
POST (implied, as it transforms data)

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **data** (AbstractVector{<:IdDict{<:Any, <:AbstractVector}}) - A vector of IdDicts to be flattened.

### Request Example
```
flatten_by_key([dict1, dict2, dict3])
```

### Response
#### Success Response (200)
- **flattened_dict** (IdDict) - A single IdDict containing the merged data.

#### Response Example
```
# Example response is an IdDict, structure depends on input dictionaries
```
```

--------------------------------

### Decode Data

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Decodes any encoded arrays within nested data structures.

```julia
decode_data(data)
```

--------------------------------

### Read Value of Specific Type

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Reads a value of a specified type from the input. This function is part of the LegendDataTypes API.

```julia
readdata(input, SomeDataType::Type)
```

--------------------------------

### LegendDataTypes.fast_flatten(vector_of_arrays)

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Flattens a vector of arrays into a single array by concatenating the inner arrays along the last dimension. This is an efficient method for combining array data.

```APIDOC
## LegendDataTypes.fast_flatten(vector_of_arrays)

### Description
Flattens a vector of arrays into a single array by concatenating the inner arrays along the last dimension. This is an efficient method for combining array data.

### Method
POST (implied, as it transforms data)

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **vector_of_arrays** (AbstractVector{<:AbstractArray}) - A vector containing arrays to be flattened.

### Request Example
```
fast_flatten([array1, array2, array3])
```

### Response
#### Success Response (200)
- **flattened_array** (AbstractArray) - A single array containing the concatenated elements of the input arrays.

#### Response Example
```
# Example response depends on the dimensions and content of the input arrays
```
```

--------------------------------

### LegendDataTypes.decode_data(data)

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Decodes any encoded arrays present in possibly nested data structures. This function is crucial for accessing the raw information within complex data formats.

```APIDOC
## LegendDataTypes.decode_data(data)

### Description
Decodes any encoded arrays present in possibly nested data structures. This function is crucial for accessing the raw information within complex data formats.

### Method
POST (implied, as it transforms data)

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **data** (Any) - The data structure possibly containing encoded arrays.

### Request Example
```
decode_data(nested_data)
```

### Response
#### Success Response (200)
- **decoded_data** (Any) - The data structure with all encoded arrays decoded.

#### Response Example
```
# Example response depends on the structure and content of the input data
```
```

--------------------------------

### TableLike Type Definition

Source: https://legend-exp.github.io/LegendDataTypes.jl/stable/api

Defines TableLike as an AbstractVector of NamedTuples. It requires support for the Tables.jl interface.

```julia
TableLike = AbstractVector{<:NamedTuple}
```
Tokens:
Raw