ibex.endpoints.data.plot_data

async ibex.endpoints.data.plot_data(plot_data_query: Annotated[PlotDataRequestModel, Query(PydanticUndefined)]) CustomORJSONResponse

IBEX endpoint. Prepares and returns full information about data node and it’s coordinates.

Response JSON is constructed as follows:
{
“data”: {
“name”: <node_name (str)>,
“unit”: <data_unit (str)>,
“shape”: <original_data_shape (list(int))>,
“downsampled_shape”: <data_shape list(int)>,
“ndim”: <number_of_data_dimensions (int)>,
“path”: <path_to_selected_node (str)>,
“description”: <node_description (str)>,
“coordinates”: [
{
“name”: <node_name (str)>,
“target”: <path_to_origin_node_of_coordinate (str)>,
“unit”: <data_unit (str)>,
“shape”: <original_data_shape list(int)>,
“downsampled_shape”: <data_shape list(int)>,
“ndim”: <number_of_data_dimensions (int)>,
“path”: <path_to_coordonate (str)>,
“description”: <coordinate_description (str)>,
“coordinates”: <names_of_coordinates_of_this_coordinate (list(str))>,
“shapes_dimension”: <if_coordinate_has_influence_on_data_shape (bool)>,
“value”: <value(s)_of_coordinate>
},
{<another_coordinate},
…],
“value”: <value(s)_of_selected_data_node>
}
}
Parameters:
plot_data_query: Annotated[PlotDataRequestModel, Query(PydanticUndefined)]

See ibex.endpoints.schemas.request_data_schemas.PlotDataRequestModel

Return type:

dict (automatically converted to JSON by FastAPI)

Returns:

JSON response