Buffer

Models for a data stream from a miniscope device: header formats, containers, etc.

pydantic model miniscope_io.models.buffer.BufferHeader

Container for the data stream’s header, structured by MetadataHeaderFormat

Show JSON schema

{
   "title": "BufferHeader",
   "description": "Container for the data stream's header, structured by :class:`.MetadataHeaderFormat`",
   "type": "object",
   "properties": {
      "linked_list": {
         "title": "Linked List",
         "type": "integer"
      },
      "frame_num": {
         "title": "Frame Num",
         "type": "integer"
      },
      "buffer_count": {
         "title": "Buffer Count",
         "type": "integer"
      },
      "frame_buffer_count": {
         "title": "Frame Buffer Count",
         "type": "integer"
      },
      "timestamp": {
         "title": "Timestamp",
         "type": "integer"
      },
      "pixel_count": {
         "title": "Pixel Count",
         "type": "integer"
      }
   },
   "required": [
      "linked_list",
      "frame_num",
      "buffer_count",
      "frame_buffer_count",
      "timestamp",
      "pixel_count"
   ]
}

Fields:

• buffer_count (int)

• frame_buffer_count (int)

• frame_num (int)

• linked_list (int)

• pixel_count (int)

• timestamp (int)

field buffer_count: int [Required]

field frame_buffer_count: int [Required]

field frame_num: int [Required]

field linked_list: int [Required]

field pixel_count: int [Required]

field timestamp: int [Required]

pydantic model miniscope_io.models.buffer.BufferHeaderFormat

Format model used to parse header at the beginning of every buffer.

Show JSON schema

{
   "title": "BufferHeaderFormat",
   "description": "Format model used to parse header at the beginning of every buffer.",
   "type": "object",
   "properties": {
      "linked_list": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "maxItems": 2,
               "minItems": 2,
               "prefixItems": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "integer"
                  }
               ],
               "type": "array"
            },
            {
               "maxItems": 2,
               "minItems": 2,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "number"
                  }
               ],
               "type": "array"
            }
         ],
         "title": "Linked List"
      },
      "frame_num": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "maxItems": 2,
               "minItems": 2,
               "prefixItems": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "integer"
                  }
               ],
               "type": "array"
            },
            {
               "maxItems": 2,
               "minItems": 2,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "number"
                  }
               ],
               "type": "array"
            }
         ],
         "title": "Frame Num"
      },
      "buffer_count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "maxItems": 2,
               "minItems": 2,
               "prefixItems": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "integer"
                  }
               ],
               "type": "array"
            },
            {
               "maxItems": 2,
               "minItems": 2,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "number"
                  }
               ],
               "type": "array"
            }
         ],
         "title": "Buffer Count"
      },
      "frame_buffer_count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "maxItems": 2,
               "minItems": 2,
               "prefixItems": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "integer"
                  }
               ],
               "type": "array"
            },
            {
               "maxItems": 2,
               "minItems": 2,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "number"
                  }
               ],
               "type": "array"
            }
         ],
         "title": "Frame Buffer Count"
      },
      "timestamp": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "maxItems": 2,
               "minItems": 2,
               "prefixItems": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "integer"
                  }
               ],
               "type": "array"
            },
            {
               "maxItems": 2,
               "minItems": 2,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "number"
                  }
               ],
               "type": "array"
            }
         ],
         "title": "Timestamp"
      },
      "pixel_count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "maxItems": 2,
               "minItems": 2,
               "prefixItems": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "integer"
                  }
               ],
               "type": "array"
            },
            {
               "maxItems": 2,
               "minItems": 2,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "number"
                  }
               ],
               "type": "array"
            }
         ],
         "title": "Pixel Count"
      }
   },
   "required": [
      "linked_list",
      "frame_num",
      "buffer_count",
      "frame_buffer_count",
      "timestamp",
      "pixel_count"
   ]
}

Fields:

• buffer_count (int | Tuple[int, int] | Tuple[float, float])

• frame_buffer_count (int | Tuple[int, int] | Tuple[float, float])

• frame_num (int | Tuple[int, int] | Tuple[float, float])

• linked_list (int | Tuple[int, int] | Tuple[float, float])

• pixel_count (int | Tuple[int, int] | Tuple[float, float])

• timestamp (int | Tuple[int, int] | Tuple[float, float])

field buffer_count: int | Tuple[int, int] | Tuple[float, float] [Required]

field frame_buffer_count: int | Tuple[int, int] | Tuple[float, float] [Required]

field frame_num: int | Tuple[int, int] | Tuple[float, float] [Required]

field linked_list: int | Tuple[int, int] | Tuple[float, float] [Required]

field pixel_count: int | Tuple[int, int] | Tuple[float, float] [Required]

field timestamp: int | Tuple[int, int] | Tuple[float, float] [Required]