models

Pydantic models used throughout mio.

These models should be kept as generic as possible, and any refinements needed for a specific acquisition class should be defined within that module, inheriting from the relevant parent class. Rule of thumb: keep what is common common, and what is unique unique.

• config
  • Config
    • Config.config_dir
    • Config.folder_exists()
    • Config.log_dir
    • Config.logs
    • Config.model_config
    • Config.paths_relative_to_basedir()
    • Config.settings_customise_sources()
    • Config.user_dir
  • LogConfig
    • LogConfig.file_n
    • LogConfig.file_size
    • LogConfig.level
    • LogConfig.level_file
    • LogConfig.level_stdout
    • LogConfig.model_config
    • LogConfig.uppercase_levels()
  • get_config()
  • set_user_dir()
• data
• dataset
  • Dataset
    • Dataset.align()
    • Dataset.alignment_map
    • Dataset.from_directory()
    • Dataset.from_recordings()
    • Dataset.get_stitched()
    • Dataset.model_config
    • Dataset.path
    • Dataset.recordings
    • Dataset.stitch()
  • RawVideoRecording
    • RawVideoRecording.model_config
    • RawVideoRecording.type
  • Recording
    • Recording.binary
    • Recording.derived_from
    • Recording.from_video()
    • Recording.metadata
    • Recording.model_config
    • Recording.name
    • Recording.noise
    • Recording.paths
    • Recording.score_noise()
    • Recording.timestamps
    • Recording.type
    • Recording.video
  • RecordingDerivation
    • RecordingDerivation.model_config
    • RecordingDerivation.sources
    • RecordingDerivation.type
  • RecordingPaths
    • RecordingPaths.binary
    • RecordingPaths.metadata
    • RecordingPaths.noise
    • RecordingPaths.timestamps
    • RecordingPaths.video
  • StitchedRecording
    • StitchedRecording.debug_video
    • StitchedRecording.derived_from
    • StitchedRecording.from_video()
    • StitchedRecording.metadata
    • StitchedRecording.model_config
    • StitchedRecording.scores
    • StitchedRecording.type
  • paths_from_video()
• mixins
  • ConfigYAMLMixin
    • ConfigYAMLMixin.HEADER_FIELDS
    • ConfigYAMLMixin.config_models()
    • ConfigYAMLMixin.config_sources()
    • ConfigYAMLMixin.fill_mio_model()
    • ConfigYAMLMixin.from_any()
    • ConfigYAMLMixin.from_id()
    • ConfigYAMLMixin.from_yaml()
    • ConfigYAMLMixin.id
    • ConfigYAMLMixin.iter_configs()
    • ConfigYAMLMixin.mio_model
    • ConfigYAMLMixin.mio_version
    • ConfigYAMLMixin.model_config
  • ConfigYamlHeader
    • ConfigYamlHeader.id
    • ConfigYamlHeader.mio_model
    • ConfigYamlHeader.mio_version
    • ConfigYamlHeader.path
  • YAMLMixin
    • YAMLMixin.from_yaml()
    • YAMLMixin.to_yaml()
    • YAMLMixin.to_yamls()
  • YamlDumper
    • YamlDumper.represent_path()
    • YamlDumper.yaml_representers
  • yaml_peek()
• models
  • Container
    • Container.model_config
  • MiniscopeConfig
    • MiniscopeConfig.model_config
  • MiniscopeIOModel
    • MiniscopeIOModel.model_config
  • Table
    • Table.Config
      • Table.Config.name
    • Table.read_csv()