Class: Acquisition

Video acquisition and recording parameters, including timing encoding and illumination details.

 classDiagram
    class Acquisition
    click Acquisition href "../Acquisition/"
      Acquisition : acquisition_notes

      Acquisition : bit_depth

      Acquisition : color_mode





        Acquisition --> "0..1" ColorModeEnum : color_mode
        click ColorModeEnum href "../ColorModeEnum/"



      Acquisition : exposure_time

      Acquisition : frame_rate

      Acquisition : gain

      Acquisition : illumination_illuminance

      Acquisition : illumination_type





        Acquisition --> "0..1 _recommended_" IlluminationTypeEnum : illumination_type
        click IlluminationTypeEnum href "../IlluminationTypeEnum/"



      Acquisition : illumination_wavelength

      Acquisition : noise_reduction_method

      Acquisition : recording_duration

      Acquisition : recording_end_datetime

      Acquisition : recording_software_name

      Acquisition : recording_software_version

      Acquisition : recording_start_datetime

      Acquisition : spatial_resolution

      Acquisition : total_frame_count

      Acquisition : video_codec





        Acquisition --> "0..1 _recommended_" VideoCodecEnum : video_codec
        click VideoCodecEnum href "../VideoCodecEnum/"



      Acquisition : video_container_format





        Acquisition --> "1" VideoContainerEnum : video_container_format
        click VideoContainerEnum href "../VideoContainerEnum/"



      Acquisition : video_resolution_height

      Acquisition : video_resolution_width

Slots

Name	Cardinality and Range	Description	Inheritance
recording_duration	1 Duration	Total duration of the video recording in ISO 8601 duration format.	direct
recording_software_name	1 String	Name of the software used to record the video.	direct
recording_software_version	1 String	Version string of the recording software.	direct
frame_rate	1 Float	Number of frames captured per second (fps) during video recording.	direct
video_resolution_width	1 Integer	Horizontal pixel count of the recorded video.	direct
video_resolution_height	1 Integer	Vertical pixel count of the recorded video.	direct
video_container_format	1 VideoContainerEnum	File container format of the recorded video.	direct
recording_start_datetime	0..1 recommended Datetime	Date and time at which acquisition of the video recording began.	direct
recording_end_datetime	0..1 recommended Datetime	Date and time at which acquisition of the video recording ended.	direct
illumination_type	0..1 recommended IlluminationTypeEnum	Type of illumination used during recording.	direct
spatial_resolution	0..1 recommended Float	Physical size represented by one pixel at the observation plane.	direct
video_codec	0..1 recommended VideoCodecEnum	Video compression codec used for recording.	direct
exposure_time	0..1 recommended Float	Camera sensor exposure time per frame.	direct
noise_reduction_method	0..1 recommended String	Method or algorithm used to reduce image noise during acquisition or immediately after recording.	direct
bit_depth	0..1 Integer	Bit depth per pixel channel of the recorded video.	direct
illumination_wavelength	0..1 Float	Peak wavelength of the illumination source in nanometres. Use for non-white-light sources such as infrared or UV.	direct
illumination_illuminance	0..1 Float	Illuminance at the recording arena or observation surface.	direct
total_frame_count	0..1 Integer	Total number of frames in the video. Can be derived from frame_rate × recording_duration if not explicitly stated.	direct
color_mode	0..1 ColorModeEnum	Color mode of the recorded video. Affects tracking algorithm behavior and file size.	direct
gain	0..1 String	Camera gain setting at the time of recording.	direct
acquisition_notes	0..1 String	Free-text notes on acquisition settings	direct

Usages

used by	used in	type	used
HardwareandAcquisition	acquisition	range	Acquisition

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	`{'video_codec': {'any_of': [{'equals_string': 'ffv1'}, {'equals_string': 'raw'}]}}`	`{'bit_depth': {'recommended': True}}`

Identifier and Mapping Information

Schema Source

from schema: https://w3id.org/bestmeta/schema

Mappings

Mapping Type	Mapped Value
self	BeStMeta:Acquisition
native	BeStMeta:Acquisition

LinkML Source

Direct

name: Acquisition
description: Video acquisition and recording parameters, including timing encoding
  and illumination details.
from_schema: https://w3id.org/bestmeta/schema
slots:
- recording_duration
- recording_software_name
- recording_software_version
- frame_rate
- video_resolution_width
- video_resolution_height
- video_container_format
- recording_start_datetime
- recording_end_datetime
- illumination_type
- spatial_resolution
- video_codec
- exposure_time
- noise_reduction_method
- bit_depth
- illumination_wavelength
- illumination_illuminance
- total_frame_count
- color_mode
- gain
- acquisition_notes
rules:
- preconditions:
    slot_conditions:
      video_codec:
        name: video_codec
        any_of:
        - equals_string: ffv1
        - equals_string: raw
  postconditions:
    slot_conditions:
      bit_depth:
        name: bit_depth
        recommended: true
  description: Bit depth should be reported when it is available for lossless or uncompressed
    video.

Induced

name: Acquisition
description: Video acquisition and recording parameters, including timing encoding
  and illumination details.
from_schema: https://w3id.org/bestmeta/schema
attributes:
  recording_duration:
    name: recording_duration
    description: Total duration of the video recording in ISO 8601 duration format.
    notes:
    - Use ISO 8601 duration format.
    examples:
    - value: PT30M
      description: 30 minutes
    - value: PT1H15M30S
      description: 1 hour, 15 minutes, 30 seconds
    - value: PT45S
      description: 45 seconds
    from_schema: https://w3id.org/bestmeta/schema
    exact_mappings:
    - AFR:0000951
    close_mappings:
    - schema:duration
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: duration
    required: true
  recording_software_name:
    name: recording_software_name
    description: Name of the software used to record the video.
    from_schema: https://w3id.org/bestmeta/schema
    exact_mappings:
    - AFR:0002802
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: string
    required: true
  recording_software_version:
    name: recording_software_version
    description: Version string of the recording software.
    from_schema: https://w3id.org/bestmeta/schema
    exact_mappings:
    - AFR:0001700
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: string
    required: true
  frame_rate:
    name: frame_rate
    description: Number of frames captured per second (fps) during video recording.
    from_schema: https://w3id.org/bestmeta/schema
    exact_mappings:
    - ebucore:frameRate
    close_mappings:
    - ma:frameRate
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: float
    required: true
    unit:
      ucum_code: Hz
  video_resolution_width:
    name: video_resolution_width
    description: Horizontal pixel count of the recorded video.
    from_schema: https://w3id.org/bestmeta/schema
    close_mappings:
    - ebucore:width
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: integer
    required: true
    unit:
      ucum_code: px
  video_resolution_height:
    name: video_resolution_height
    description: Vertical pixel count of the recorded video.
    from_schema: https://w3id.org/bestmeta/schema
    close_mappings:
    - ebucore:height
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: integer
    required: true
    unit:
      ucum_code: px
  video_container_format:
    name: video_container_format
    description: File container format of the recorded video.
    notes:
    - Report the container format, not the codec.
    - Codec is captured separately in video_codec.
    from_schema: https://w3id.org/bestmeta/schema
    exact_mappings:
    - ebucore:hasContainerFormat
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: VideoContainerEnum
    required: true
  recording_start_datetime:
    name: recording_start_datetime
    description: Date and time at which acquisition of the video recording began.
    from_schema: https://w3id.org/bestmeta/schema
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: datetime
    required: false
    recommended: true
  recording_end_datetime:
    name: recording_end_datetime
    description: Date and time at which acquisition of the video recording ended.
    from_schema: https://w3id.org/bestmeta/schema
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: datetime
    required: false
    recommended: true
  illumination_type:
    name: illumination_type
    description: Type of illumination used during recording.
    from_schema: https://w3id.org/bestmeta/schema
    exact_mappings:
    - MIxS:0000769
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: IlluminationTypeEnum
    required: false
    recommended: true
  spatial_resolution:
    name: spatial_resolution
    description: Physical size represented by one pixel at the observation plane.
    from_schema: https://w3id.org/bestmeta/schema
    close_mappings:
    - dicom:SpatialResolution
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: float
    required: false
    recommended: true
    unit:
      ucum_code: mm/px
  video_codec:
    name: video_codec
    description: Video compression codec used for recording.
    notes:
    - Report the codec, not the container format.
    - Container format is captured separately in video_container_format.
    - mp4 is a container, not a codec — most mp4 files use H264 or H265 as codec.
    from_schema: https://w3id.org/bestmeta/schema
    exact_mappings:
    - ebucore:codecName
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: VideoCodecEnum
    required: false
    recommended: true
  exposure_time:
    name: exposure_time
    description: Camera sensor exposure time per frame.
    from_schema: https://w3id.org/bestmeta/schema
    exact_mappings:
    - REPRODUCEME:ExposureTime
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: float
    required: false
    recommended: true
    unit:
      ucum_code: ms
  noise_reduction_method:
    name: noise_reduction_method
    description: Method or algorithm used to reduce image noise during acquisition
      or immediately after recording.
    from_schema: https://w3id.org/bestmeta/schema
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: string
    required: false
    recommended: true
  bit_depth:
    name: bit_depth
    description: Bit depth per pixel channel of the recorded video.
    notes:
    - Common values are 8-bit and 16-bit.
    examples:
    - value: '8'
    - value: '16'
    from_schema: https://w3id.org/bestmeta/schema
    exact_mappings:
    - ebucore:bitDepth
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: integer
    required: false
  illumination_wavelength:
    name: illumination_wavelength
    description: Peak wavelength of the illumination source in nanometres. Use for
      non-white-light sources such as infrared or UV.
    from_schema: https://w3id.org/bestmeta/schema
    exact_mappings:
    - AFR:0001159
    close_mappings:
    - PATO:0001242
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: float
    required: false
    unit:
      ucum_code: nm
  illumination_illuminance:
    name: illumination_illuminance
    description: Illuminance at the recording arena or observation surface.
    examples:
    - value: '0'
      description: Dark condition
    - value: '100'
      description: Dim illumination
    - value: '1000'
      description: Bright laboratory illumination
    from_schema: https://w3id.org/bestmeta/schema
    exact_mappings:
    - OM:Illuminance
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: float
    required: false
    unit:
      ucum_code: lx
  total_frame_count:
    name: total_frame_count
    description: Total number of frames in the video. Can be derived from frame_rate
      × recording_duration if not explicitly stated.
    notes:
    - Prefer direct reporting when available.
    - If absent, it may be computed from frame rate and actual trial duration.
    from_schema: https://w3id.org/bestmeta/schema
    exact_mappings:
    - dicom:NumberOfFrames
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: integer
    required: false
  color_mode:
    name: color_mode
    description: Color mode of the recorded video. Affects tracking algorithm behavior
      and file size.
    from_schema: https://w3id.org/bestmeta/schema
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: ColorModeEnum
    required: false
  gain:
    name: gain
    description: Camera gain setting at the time of recording.
    from_schema: https://w3id.org/bestmeta/schema
    exact_mappings:
    - AFQ:0000201
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: string
    required: false
  acquisition_notes:
    name: acquisition_notes
    description: Free-text notes on acquisition settings
    from_schema: https://w3id.org/bestmeta/schema
    rank: 1000
    owner: Acquisition
    domain_of:
    - Acquisition
    range: string
    required: false
rules:
- preconditions:
    slot_conditions:
      video_codec:
        name: video_codec
        any_of:
        - equals_string: ffv1
        - equals_string: raw
  postconditions:
    slot_conditions:
      bit_depth:
        name: bit_depth
        recommended: true
  description: Bit depth should be reported when it is available for lossless or uncompressed
    video.