Skip to content
  • API documentation
  • careamics
  • lightning
  • dataset_ng
  • callbacks
  • prediction_writer
  • file_path_utils

file_path_utils

Module containing file path utilities for WriteStrategy to use.

create_write_file_path(dirpath, file_path, write_extension) #

Create the file name for the output file.

Takes the original file path, changes the directory to dirpath and changes the extension to write_extension.

Parameters:

Name Type Description Default
dirpath Path

The output directory to write file to.

 required
file_path Path

The original file path.

 required
write_extension str

The extension that output files should have.

 required

Returns:

Type Description
Path

The output file path.
Source code in src/careamics/lightning/dataset_ng/callbacks/prediction_writer/file_path_utils.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
def create_write_file_path(
    dirpath: Path, file_path: Path, write_extension: str
) -> Path:
    """
    Create the file name for the output file.

    Takes the original file path, changes the directory to `dirpath` and changes
    the extension to `write_extension`.

    Parameters
    ----------
    dirpath : pathlib.Path
        The output directory to write file to.
    file_path : pathlib.Path
        The original file path.
    write_extension : str
        The extension that output files should have.

    Returns
    -------
    Path
        The output file path.
    """
    file_path = Path(file_path)  # as a guard against str input

    file_name = Path(file_path.stem).with_suffix(write_extension)
    file_path = dirpath / file_name
    return file_path