changed arg format to img_format as format is a python method

Author: MihinP

partinet/__init__.py

@@ -82,11 +82,11 @@ def star(labels, images, output,conf):
 @click.option("--source", type=str, required=True, help="Path to Raw micrographs")
 @click.option('--project', type=str, required=True, help='save denoised micrographs to project/denoised', show_default=True)
 @click.option('--num_workers', type=int, default=None, help='Number of workers for denoising micrographs')
-@click.option('--format', type=click.Choice(["png", "jpg", "mrc"], case_sensitive=True), default="png",show_default=True, help='Output format of denoised micrographs')
-def denoise(source, project, num_workers,format):
+@click.option('--img_format', type=click.Choice(["png", "jpg", "mrc"], case_sensitive=True), default="png",show_default=True, help='Output format of denoised micrographs')
+def denoise(source, project, num_workers,img_format):
     click.echo("Denoising micrographs...")
     import partinet.process_utils.pooled_denoise_proc
-    partinet.process_utils.pooled_denoise_proc.main(source,project,num_workers,format)
+    partinet.process_utils.pooled_denoise_proc.main(source,project,num_workers,img_format)
 
 
 @main.group()

partinet/process_utils/pooled_denoise_proc.py

@@ -20,16 +20,16 @@ def clahe_denoise(args: Tuple[str, str, str]) -> None:
         args (Tuple[str, str]):
             - src_path: Path to the source micrograph file.
             - dest_path: Path to save the denoised image.
-            - format: output format of denoised images
+            - img_format: output format of denoised images
 
     Raises:
         Exception: Logs any exceptions that occur during processing.
     """
     try:
-        src_path, dest_path, format = args
+        src_path, dest_path, img_format = args
         # Perform denoising
         denoised = denoise(src_path)
-        if format == "mrc":
+        if img_format == "mrc":
             mrcfile.write(dest_path,data=denoised)
         else:
             cv2.imwrite(dest_path, denoised)
@@ -41,15 +41,15 @@ def clahe_denoise(args: Tuple[str, str, str]) -> None:
 
 # Function to process all files in a directory
 
-def process_directory(micrographs_dir: str, clahe_denoised_dir: str, max_workers: int, format: str) -> None:
+def process_directory(micrographs_dir: str, clahe_denoised_dir: str, max_workers: int, img_format: str) -> None:
     """
     Processes all `.mrc` files in the given directory using parallel workers for denoising.
 
     Args:
         micrographs_dir (str): Path to the directory containing raw micrograph files.
         clahe_denoised_dir (str): Path to the directory where denoised images will be saved.
         max_workers (int): Number of worker processes to use for parallel processing.
-        format (str): Output format of denoised images
+        img_format (str): Output format of denoised images
 
     Notes:
         - Only `.mrc` files are processed.
@@ -63,11 +63,11 @@ def process_directory(micrographs_dir: str, clahe_denoised_dir: str, max_workers
     for file_name in os.listdir(micrographs_dir):
         if file_name.endswith(".mrc"):
             src_path = os.path.join(micrographs_dir, file_name)
-            dest_path = os.path.join(clahe_denoised_dir, file_name.replace(".mrc", "."+format))
+            dest_path = os.path.join(clahe_denoised_dir, file_name.replace(".mrc", "."+img_format))
             if os.path.exists(dest_path):
                 logging.info(f"{dest_path} already exists!")
             else:
-                tasks.append((src_path, dest_path, format))
+                tasks.append((src_path, dest_path, img_format))
 
     # Parallel processing of tasks
     with ProcessPoolExecutor(max_workers=max_workers) as executor:
@@ -78,15 +78,15 @@ def process_directory(micrographs_dir: str, clahe_denoised_dir: str, max_workers
 
 # Main function
 
-def main(source_dir: str, project_dir: str, ncpu: int, format: str) -> None:
+def main(source_dir: str, project_dir: str, ncpu: int, img_format: str) -> None:
     """
     Main function to set up logging, determine available CPUs, and start the denoising process.
 
     Args:
         source_dir (str): Path to the directory containing raw micrographs.
         project_dir (str): Path to the project directory where denoised images will be saved.
         ncpu (int): Number of CPUs to use for parallel processing. Defaults to half the available CPUs.
-        format (str): Output format of denoised images
+        img_format (str): Output format of denoised images
 
     Notes:
         - Logging is configured to write messages to a log file and the console.
@@ -116,7 +116,7 @@ def main(source_dir: str, project_dir: str, ncpu: int, format: str) -> None:
     logging.info(f"Saving denoised micrographs in {denoise_dir}")
 
     # Process the directory
-    process_directory(source_dir, denoise_dir, ncpu, format)
+    process_directory(source_dir, denoise_dir, ncpu, img_format)
 
 # Command-line argument parsing
 
@@ -129,17 +129,17 @@ def parse_args() -> argparse.Namespace:
             - raw: Path to raw micrographs.
             - project: Path to the project directory.
             - ncpu: Number of CPUs to use.
-            - format: output format of denoised images
+            - img_format: output format of denoised images
     """
     parser = argparse.ArgumentParser(description="Denoise micrographs with guided CryoSegNet-style filter")
     parser.add_argument("--raw", required=True, help="Path to raw micrographs")
     parser.add_argument("--project", required=True, help="Denoised micrographs saved in project/denoised")
     parser.add_argument('--ncpu', type=int, default=None, help='Number of CPUs to use')
-    parser.add_argument('--format', type=str, choices=["png","jpg","mrc"], default="png", help='Output format of denoised images')
+    parser.add_argument('--img_format', type=str, choices=["png","jpg","mrc"], default="png", help='Output format of denoised images')
     return parser.parse_args()
 
 # Entry point for the script
 
 if __name__ == "__main__":
     args = parse_args()
-    main(args.raw, args.project, args.ncpu, args.format)
+    main(args.raw, args.project, args.ncpu, args.img_format)