Skip to main content

No project description provided

Project description

FAIM Wako SearchFirst

DOI codecov test PyPI - Version PyPI - Python Version


Table of Contents

Installation

pip install faim-wako-searchfirst

Usage

Configuration is managed in a config.yml file:

# Required

# criteria for file selection in case of multiple channels/slices per position
file_selection:
    channel: C01

# choose method how to segment, filter, and sample the objects
process:
    # segment methods: threshold, cellpose
    segment: threshold
    # filter methods: bounding_box, area, solidity, feature, border, intensity, dilate
    filter: [bounding_box, area, solidity, feature, border, intensity, dilate]
    # sample methods: centers, grid_overlap, dense_grid,
    #                 object_centered_grid, region_centered_grid
    sample: centers

# Each section below provides arguments to one of the methods set in 'process'.
# Config sections for methods not selected above will be ignored.

# segment
threshold:
    threshold: 128
    include_holes: true
    gaussian_sigma: 0.0  # default: 0.0

# filter
bounding_box:
    min_x: 64
    min_y: 0
    max_x: 256
    max_y: 190
area:
    min_area: 100
    max_area: 10000
solidity:
    min_solidity: 0.9
    max_solidity: 1.0
feature:
    feature: eccentricity
    min_value: 0.0
    max_value: 0.99
border:
    margin: 5  # default: 0
intensity:
    target_channel: C03
    min_intensity: 128
dilate:
    pixel_distance: 1.0

# sample
dense_grid:
    binning_factor: 50  # default: 50
grid_overlap:
    mag_first_pass: 4
    mag_second_pass: 60
    overlap_ratio: 0.05  # default: 0
object_centered_grid:
    mag_first_pass: 4
    mag_second_pass: 60
    overlap_ratio: 0.05  # default: 0
region_centered_grid:
    mag_first_pass: 4
    mag_second_pass: 60
    overlap_ratio: 0.05  # default: 0

The Python script called by Wako Automation Software needs to accept the acquisition folder folder_path as only parameter:

import typer
from faim_wako_searchfirst.main import run

def main(folder_path: str):
    run(folder=folder_path, configfile="config.yml")

if __name__ == "__main__":
    typer.run(main)

License

faim-wako-searchfirst is distributed under the terms of the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

faim_wako_searchfirst-0.8.0.tar.gz (158.5 kB view details)

Uploaded Source

Built Distribution

faim_wako_searchfirst-0.8.0-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file faim_wako_searchfirst-0.8.0.tar.gz.

File metadata

  • Download URL: faim_wako_searchfirst-0.8.0.tar.gz
  • Upload date:
  • Size: 158.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for faim_wako_searchfirst-0.8.0.tar.gz
Algorithm Hash digest
SHA256 d0d6300d8974c244ca6dd14de3bc9d47bbcf5a4099b3ee3585e877e647b2230d
MD5 7cc876a6bd70f298be5d7d86c0ee7599
BLAKE2b-256 d3475aa6961b51e2279068fc5947dcce3d05dc36b33c390a652a8078ea4c3703

See more details on using hashes here.

File details

Details for the file faim_wako_searchfirst-0.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for faim_wako_searchfirst-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 18697fc3912441e6b3fad4acb1fd12850369386ae980366d445310820c7188cd
MD5 47021273db4d59449639c816c1a29678
BLAKE2b-256 996c74ed4b176c7dea3d02e28233db8b9e2abcec000482ec26ac6dfdbf6a53ee

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page