Skip to content

3. Main Settings

Jump to bottom
Matthew Mueller edited this page Sep 19, 2024 · 30 revisions

1. Main Settings Tab

Main Settings

  1. Click the Add/View Paths button to pull up the data path window

    Data Paths Button

    Data Paths

    1. The Data Path is the full path to the folder containing the data files that will be processed
    2. + Add Path for additional paths, - Remove Path to delete paths
    3. Browse for or type path(s) into box(es)
    4. Find/View SubDirs to automatically find all the subfolders of the master folder you have imputed
      1. Check the subfolders you wish to use
      2. You can input a pattern in the top right corner and click the button to automatically check any subpath that contains that pattern
      3. Click submit to save your subpaths.
    5. Use the Pattern box to only display subfolders with a specific pattern
    6. Set Max Depth to how many folders past the master folder you wish to search past the master folder. I.E. folders in your master folder would be depth 1.
    7. Include Master will allow you to use the master folder as a data path. If you only want to use subfolders then make sure this is unchecked.
    8. Click Submit to save paths

  2. Check Real-time Processing if needed. Real-time processing can be used to monitor folders for incoming data and have it processed in real-time. If data is already existing then leave this unchecked.

  3. Channel Patterns will appear automatically once data paths are set in Step 2A

    1. Check patterns that need to be processed
    2. Custom Patterns can be checked and used in place of the automatically generated patterns. These custom patterns should be separated by commas, EX. CamA,CamB,CamC would mean CamA CamB CamC are the 3 patterns to be found for processing.
    3. Note that checking Custom Patterns will mean the auto-generated Channel Patterns will not be used

  4. Set XY Pixel Size, Step Size (stage scan interval), and check Objective Scan (if your data is already deskewed) if needed

  5. The bottom boxes (pictured below) will decide what image processing will be done to the data.

    Main Settings Boxes

    1. The leftmost box for each option that you want to be performed on the data. NOTE: selecting Decon Only will mean the data will only be Deconvoluted and nothing else (Deskew, Rotate, etc.) will run.
    2. Save 16-bit Column
      1. This column will cause the results to be saved as 16-bit

2. Main Advanced Settings

Main Advanced Settings

  1. Skew Angle is the skew angle of the stage
  2. Get Step Size from Encoder will estimate the step size from encoder positions
  3. Reverse will invert the direction of the z-axis
  4. You can set a Resampling by picking a type and setting a type and scale values in each axis
  5. Input is Zarr is used when your input is Zarr files
  6. Save as Zarr will save your output as Zarr files (if supported)
  7. Save as 3D Stack will save each output as one 3D stack
  8. The Read Settings File checkbox will use the setting file to decide whether or not to flip the Z stack when true

3. Config File Settings (Located in Main Advanced Settings)

Config File Settings

Config files are mostly only used in cluster environments. There are a few functions that use config files in single-machine environments but the default config files should work for you if you are only using a single machine. If you are in a cluster environment then you can create a custom config file using the config file creator. Example config files are created for you in your home directory: ~/.PetaKit5D-GUI/configFiles on Linux and Mac and C:\Users\InsertYourUsernameHere\.Petakit5D-GUI\configFiles on Windows.

  1. Config File is the location of the main config file that will be used for CPU jobs

  2. GPU Config File is the location of the config file that will be used for GPU jobs

  3. JVM Config File is the location of the config file that will be used for jobs that require a JVM

4. Config File Creator

Config File Creator

Refer to the default config files in the configFiles folder of your installation for the default values that may also work for your cluster environment.

  1. JSON Config File Name is the full path to the JSON file you wish to create

    1. The file should end with .json

  2. Bash Launch String is the command that will be run at the start of your job

  3. Use GNU Parallel will attempt to additionally split tasks to multiple cores within the job when true

    1. This is useful if your scheduler requires you to request an entire node

  4. MCC Master String is the path to the compiled mcc script or executable

  5. MCR Parameter is the path to your matlab runtime folder

  6. Memory Per CPU Core (GBs) is the amount of memory needed per core in Gigabytes

  7. Slurm Parameter is string that will be passed to slurm for job submission

  8. Job Time Limit (hours) is the maximum amount of time that your jobs will last

  9. Include Master Node will allow the node you are currently using to also participate in completing your jobs when true

  10. Min CPU Cores is the minimum number of cores that your jobs will request

  11. Max CPU Cores is the maximum number of cores that your jobs will request

  12. Max Num Jobs is the maximum number of jobs that will be submitted at the same time

  13. Use Entire Node will request a full node when true

5. Large Scale Processing Settings

  1. General

    General

    1. IOScan is an inverted objective scan
    2. Use Master Compute will also use your current node to process cluster jobs if it is checked
    3. Save MIP enables or disables the saving of MIP files for DS and DSR

  2. Input

    Input

    1. Multiloc means your data is in multiple locations (I.E. different folders)
    2. Processed Dir String is the name of the results directory that will be looked into
    3. Input Bound Box allows you to first crop your tiles when it is provided
    4. Tile Out Bound Box allows you to crop tiles after processing when it is provided
    5. Edge Artifacts means the tiles will be eroded before stitching (mostly obsolete)
    6. Use Primary Coords will use the primary coordinates for the secondary channels/tps
    7. Mask Filenames are the full paths to the mask files for each plane

  3. Output

    Output

    1. Batch Size is the size of the data that each job will process
    2. Block Size is the size of the Zarr blocks
    3. Shard Size is the size of the shards in the Zarr blocks if the data uses sharding

  4. XCorr

    XCorr

    1. Axis Weight is the axis weight used for optimization in Y, X, and Z

6. Click the Next button on the main page and you will be taken to one of the next main Tabs according to your selections

Clone this wiki locally