Acquisition stage from format#

This page is generated from the code and must not be edited by hand.

A file in an image or electrophysiology format that an instrument writes is placed at the recording step, unless its contents contradict its extension or its own name says it was processed.

acquisition_stage_from_format version 3+d1

  • Kind of rule: What files are (classifies). Says what a file or a folder is, by placing it in a class.

  • What it concludes: a class

  • Reasoning: defeasible. A conclusion is usually right, and is retracted when a rule it names concludes against it.

  • What it reads: one file at a time

Is it available in this version?#

Yes. The engine runs it.

What would defeat it#

What this rule concludes about something is withdrawn when any of these rules concludes about the same thing:

  • content_contradicts_extension: A file is flagged when its contents begin the way one format does and its extension names another, leaving out containers such as PDF, HDF5 or ZIP that other formats are built on.

  • later_stage_from_name: A file’s name says it is past the point of recording when it has a word such as processed, filtered, stitched or merged in it; instrument software saves such files in its own format too.

  • installed_software_in_folder: A folder is recognized as an installed program, such as a copy of Fiji or a Python environment, from the parts it holds, a name ending .app, its program-style subfolders or a majority of program files; its files are still indexed and read, and rules about experiments leave them alone.

It stands aside beneath every folder one of these rules raises:

Parameters#

Parameter

Shipped value

May be

What it does

senses

["image_format", "ephys_format"]

list of text

The format senses that mean data as an instrument produced it. Spectra, reads and their conversions are left out, because their formats also hold identification results, references and assemblies.

written_by

["instrument"]

list of text

Who must write a spelling for it to begin a workflow, where its sense declares origins.

concludes

"acquisition"

text

The stage concluded, so the proposing rule reads it.

minimum_match_quality

"exact"

one of exact, case_folded, loose

How firmly the extension must have matched: it is a symbol.

slot

"extension"

one of extension, name

Where the match is read: the extension, never a word.