rename_olympus: Olympus renamer

In hmbotelho/htmrenamer: File Renaming Tools for High Throughput Microscopy

Olympus renamer

Description

Renaming of Olympus OIB files according to a microscope infile. See newinfile.df or newinfile.char for a description of the infile structure.

Usage

rename_olympus(
  sourcefolder,
  targetfolder,
  infilepath,
  numrow,
  numcol,
  REGEXvalidimages = "^.*(\\d{4})_(\\d{2}).oib$",
  printMessages = TRUE,
  printFiles = TRUE,
  printToGUI = FALSE,
  move = FALSE
)

Arguments

sourcefolder	character, the folder with raw images
targetfolder	character, folder where to place renamed files. A subfolder with the same name as the infile will be created by the function and must not exist previously.
infilepath	character, location of the microscope infile
numrow	integer, number of rows in the multi well plate
numcol	integer, number of columns in the multi well plate
REGEXvalidimages	character, regular expression matching all files which should be renamed. Captures ((\1)) the scene number (i.e. well number) and ((\2)) the time number in a time lapse.
printMessages	logical, print messages in the console?
printFiles	logical, print file-by-file progress in the console?
printToGUI	logical, print messages to the renamer GUI?
move	logical, move (rather than copy) raw images?

Value

Renamed files, metadata and log file

Null

See Also

rename_olympus_gui for interacting with this function using a GUI.

hmbotelho/htmrenamer documentation built on April 11, 2025, 11:04 p.m.